Rate this page:
GET /1/enterprises/{id}
Get an enterprise by its ID.
string
ID of the enterprise to retrieve.
^[0-9a-fA-F]{24}$
string
Comma-separated list of: id
, name
, displayName
, prefs
, ssoActivationFailed
, idAdmins
, idMembers
(Note that the members array returned will be paginated if members
is 'normal' or 'admins'. Pagination can be controlled with member_startIndex, etc, but the API response will not contain the total available result count or pagination status data. Read the SCIM documentation here for more information on filtering), idOrganizations
, products
, userTypes
, idMembers
, idOrganizations
all
string
One of: none
, normal
, admins
, owners
, all
none
string
One of: avatarHash
, fullName
, initials
, username
avatarHash, fullName, initials, username
string
Pass a SCIM-style query to filter members. This takes precedence over the all/normal/admins value of members. If any of the member_* args are set, the member array will be paginated.
none
string
This parameter expects a SCIM-style sorting value prefixed by a -
to sort descending. If no -
is prefixed, it will be sorted ascending. Note that the members array returned will be paginated if members
is 'normal' or 'admins'. Pagination can be controlled with member_startIndex, etc, but the API response will not contain the total available result count or pagination status data.
string
Deprecated: Please use member_sort. This parameter expects a SCIM-style sorting value. Note that the members array returned will be paginated if members
is normal
or admins
. Pagination can be controlled with member_startIndex
, etc, and the API response's header will contain the total count and pagination state.
none
string
Deprecated: Please use member_sort. One of: ascending
, descending
, asc
, desc
id
integer
Any integer between 0 and 100.
1
, Format: int32
integer
0 to 100
10
, Format: int32
string
One of: none
, members
, public
, all
none
string
Any valid value that the nested organization field resource accepts.
none
boolean
Whether or not to include paid account information in the returned workspace objects
false
string
Comma-seperated list of: me
, normal
, admin
, active
, deactivated
none
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/enterprises/{id}?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
GET /1/enterprises/{id}/auditlog
Returns an array of Actions related to the Enterprise object. Used for populating data sent to Google Sheets from an Enterprise's audit log page: https://trello.com/e/{enterprise_name}/admin/auditlog. An Enterprise admin token is required for this route.
NOTE: For enterprises that have opted in to user management via AdminHub, the auditlog will will contain actions taken in AdminHub, but may not contain the source for those actions.
string
ID of the enterprise to retrieve.
^[0-9a-fA-F]{24}$
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/enterprises/{id}/auditlog?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json | Array<EnterpriseAuditLog> |
GET /1/enterprises/{id}/admins
Get an enterprise's admin members.
string
ID of the enterprise to retrieve.
^[0-9a-fA-F]{24}$
string
Any valid value that the nested member field resource accepts.
fullName, userName
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/enterprises/{id}/admins?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
GET /1/enterprises/{id}/signupUrl
Get the signup URL for an enterprise.
string
ID of the enterprise to retrieve.
^[0-9a-fA-F]{24}$
boolean
false
boolean
false
string
Any valid URL.
true
, Format: url
boolean
Designates whether the user has seen/consented to the Trello ToS prior to being redirected to the enterprise signup page/their IdP.
false
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/enterprises/{id}/signupUrl?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
GET /1/enterprises/{id}/members
Get the members of an enterprise.
string
ID of the Enterprise to retrieve.
^[0-9a-fA-F]{24}$
string
A comma-seperated list of valid member fields.
avatarHash, fullName, initials, username
string
Pass a SCIM-style query to filter members. This takes precedence over the all/normal/admins value of members. If any of the below member_* args are set, the member array will be paginated.
true
string
This parameter expects a SCIM-style sorting value prefixed by a -
to sort descending. If no -
is prefixed, it will be sorted ascending. Note that the members array returned will be paginated if members
is 'normal' or 'admins'. Pagination can be controlled with member_startIndex, etc, but the API response will not contain the total available result count or pagination status data.
string
Deprecated: Please use sort
instead. This parameter expects a SCIM-style sorting value. Note that the members array returned will be paginated if members
is 'normal' or 'admins'. Pagination can be controlled with member_startIndex, etc, but the API response will not contain the total available result count or pagination status data.
string
Deprecated: Please use sort
instead. One of: ascending
, descending
, asc
, desc
.
true
Valid values: ascending
, descending
, asc
, desc
, null
integer
Any integer between 0 and 9999.
0
, Maximum: 9999
, Format: int32
string
none
string
Any valid value that the nested organization field resource accepts.
displayName
string
Any valid value that the nested board resource accepts.
name
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/enterprises/{id}/members?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json | Array<Member> |
GET /1/enterprises/{id}/members/{idMember}
Get a specific member of an enterprise by ID.
string
ID of the enterprise to retrieve.
^[0-9a-fA-F]{24}$
string
An ID of a member resource.
^[0-9a-fA-F]{24}$
string
A comma separated list of any valid values that the nested member field resource accepts.
avatarHash, fullName, initials, username
string
Any valid value that the nested organization field resource accepts.
displayName
string
Any valid value that the nested board resource accepts.
name
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/enterprises/{id}/members/{idMember}?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
GET /1/enterprises/{id}/transferrable/organization/{idOrganization}
Get whether an organization can be transferred to an enterprise.
string
ID of the Enterprise to retrieve.
^[0-9a-fA-F]{24}$
string
An ID of an Organization resource.
^[0-9a-fA-F]{24}$
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/enterprises/{id}/transferrable/organization/{idOrganization}?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
GET /1/enterprises/{id}/transferrable/bulk/{idOrganizations}
Get a list of organizations that can be transferred to an enterprise when given a bulk list of organizations.
string
ID of the Enterprise to retrieve.
^[0-9a-fA-F]{24}$
Array<Organization>
An array of IDs of an Organization resource.
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/enterprises/{id}/transferrable/bulk/{idOrganizations}?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json | Array<TransferrableOrganization> |
PUT /1/enterprises/${id}/enterpriseJoinRequest/bulk
Decline enterpriseJoinRequests from one organization or bulk amount of organizations
string
ID of the Enterprise to retrieve.
^[0-9a-fA-F]{24}$
Array<Organization>
An array of IDs of an Organization resource.
1 2
curl --request PUT \
--url 'https://api.trello.com/1/enterprises/${id}/enterpriseJoinRequest/bulk?idOrganizations={idOrganizations}&key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
GET /1/enterprises/{id}/claimableOrganizations
Get the Workspaces that are claimable by the enterprise by ID. Can optionally query for workspaces based on activeness/ inactiveness.
string
ID of the enterprise to retrieve
^[0-9a-fA-F]{24}$
integer
Limits the number of workspaces to be sorted
string
Specifies the sort order to return matching documents
string
Name of the enterprise to retrieve workspaces for
string
Date in YYYY-MM-DD format indicating the date to search up to for activeness of workspace
string
Date in YYYY-MM-DD format indicating the date to search up to for inactiveness of workspace
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/enterprises/{id}/claimableOrganizations?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
GET /1/enterprises/{id}/pendingOrganizations
Get the Workspaces that are pending for the enterprise by ID.
string
ID of the enterprise to retrieve
^[0-9a-fA-F]{24}$
string
Date in YYYY-MM-DD format indicating the date to search up to for activeness of workspace
string
Date in YYYY-MM-DD format indicating the date to search up to for inactiveness of workspace
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/enterprises/{id}/pendingOrganizations?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json | Array<PendingOrganizations> |
POST /1/enterprises/{id}/tokens
Create an auth Token for an Enterprise.
string
ID of the enterprise to retrieve.
string
One of: 1hour
, 1day
, 30days
, never
none
1 2
curl --request POST \
--url 'https://api.trello.com/1/enterprises/{id}/tokens?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
PUT /1/enterprises/{id}/organizations
Transfer an organization to an enterprise.
NOTE: For enterprises that have opted in to user management via AdminHub, this endpoint will result in the organization being added to the enterprise asynchronously. A 200 response only indicates receipt of the request, it does not indicate successful addition to the enterprise.
string
ID of the Enterprise to retrieve.
^[0-9a-fA-F]{24}$
string
ID of Organization to be transferred to Enterprise.
1 2 3
curl --request PUT \
--url 'https://api.trello.com/1/enterprises/{id}/organizations?idOrganization={idOrganization}&key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json | Array<Organization> |
PUT /1/enterprises/{id}/members/{idMember}/licensed
This endpoint is used to update whether the provided Member should use one of the Enterprise's available licenses or not. Revoking a license will deactivate a Member of an Enterprise.
NOTE: Revoking of licenses is not possible for enterprises that have opted in to user management via AdminHub.
string
ID of the Enterprise.
^[0-9a-fA-F]{24}$
string
The ID of the Member
^[0-9a-fA-F]{24}$
boolean
Boolean value to determine whether the user should be given an Enterprise license (true) or not (false).
1 2 3
curl --request PUT \
--url 'https://api.trello.com/1/enterprises/{id}/members/{idMember}/licensed?value={value}&key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
PUT /1/enterprises/{id}/members/{idMember}/deactivated
Deactivate a Member of an Enterprise.
NOTE: Deactivation is not possible for enterprises that have opted in to user management via AdminHub.
string
ID of the enterprise to retrieve.
^[0-9a-fA-F]{24}$
string
ID of the Member to deactive.
^[0-9a-fA-F]{24}$
boolean
Determines whether the user is deactivated or not.
string
A comma separated list of any valid values that the nested member field resource accepts.
form
Valid values: id
string
Any valid value that the nested organization resource accepts.
form
Valid values: id
, name
string
Any valid value that the nested board resource accepts.
Valid values: id
, name
, desc
, descData
, closed
, idMemberCreator
, idOrganization
, pinned
, url
, shortUrl
...(Show more)
1 2
curl --request PUT \
--url 'https://api.trello.com/1/enterprises/{id}/members/{idMember}/deactivated?value={value}&key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
PUT /1/enterprises/{id}/admins/{idMember}
Make Member an admin of Enterprise.
NOTE: This endpoint is not available to enterprises that have opted in to user management via AdminHub.
string
ID of the enterprise to retrieve.
^[0-9a-fA-F]{24}$
string
ID of member to be made an admin of enterprise.
^[0-9a-fA-F]{24}$
1 2
curl --request PUT \
--url 'https://api.trello.com/1/enterprises/{id}/admins/{idMember}?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
DELETE /1/enterprises/{id}/admins/{idMember}
Remove a member as admin from an enterprise.
NOTE: This endpoint is not available to enterprises that have opted in to user management via AdminHub.
string
ID of the Enterprise to retrieve.
^[0-9a-fA-F]{24}$
string
ID of the member to be removed as an admin from enterprise.
^[0-9a-fA-F]{24}$
1 2
curl --request DELETE \
--url 'https://api.trello.com/1/enterprises/{id}/admins/{idMember}?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
DELETE /1/enterprises/{id}/organizations/{idOrg}
Remove an organization from an enterprise.
string
ID of the enterprise to retrieve.
^[0-9a-fA-F]{24}$
string
ID of the organization to be removed from the enterprise.
^[0-9a-fA-F]{24}$
1 2
curl --request DELETE \
--url 'https://api.trello.com/1/enterprises/{id}/organizations/{idOrg}?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
GET /1/enterprises/{id}/organizations/bulk/{idOrganizations}
Accept an array of organizations to an enterprise.
NOTE: For enterprises that have opted in to user management via AdminHub, this endpoint will result in organizations being added to the enterprise asynchronously. A 200 response only indicates receipt of the request, it does not indicate successful addition to the enterprise.
string
ID of the enterprise to retrieve.
^[0-9a-fA-F]{24}$
Array<Organization>
An array of IDs of the organizations to be removed from the enterprise.
1 2
curl --request GET \
--url 'https://api.trello.com/1/enterprises/{id}/organizations/bulk/{idOrganizations}?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
Rate this page: