Trello Developer

Trello Developer

Rate this page:

Enterprises

Get an Enterprise

GET /1/enterprises/{id}

Get an enterprise by its ID.

Request

Path parameters
id Required

string

ID of the enterprise to retrieve.

Pattern: ^[0-9a-fA-F]{32}$
Query parameters
key Required

string

The API key to use

Pattern: ^[0-9a-fA-F]{32}$
token Required

string

The API token to use

Pattern: ^[0-9a-fA-F]{64}$
fields

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

Default: all
members

string

One of: none, normal, admins, owners, all

Default: none
member_fields

string

One of: avatarHash, fullName, initials, username

Default: avatarHash, fullName, initials, username
member_filter

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.

Default: none
member_sort

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.

member_sortBy

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.

Default: none
member_sortOrder

string

Deprecated: Please use member_sort. One of: ascending, descending, asc, desc

Default: id
member_startIndex

integer

Any integer between 0 and 100.

Default: 1, Format: int32
member_count

integer

0 to 100

Default: 10, Format: int32
organizations

string

One of: none, members, public, all

Default: none
organization_fields

string

Any valid value that the nested organization field resource accepts.

Default: none
organization_paid_accounts

boolean

Default: false
organization_memberships

string

Comma-seperated list of: me, normal, admin, active, deactivated

Default: none

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/enterprises/{id}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

Responses

Success

A schema has not been defined for this response code.

Get auditlog data for an Enterprise

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.

Request

Query parameters
key Required

string

The API key to use

Pattern: ^[0-9a-fA-F]{32}$
token Required

string

The API token to use. Note: This must be an Enterprise admin's token.

Pattern: ^[0-9a-fA-F]{64}$

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/enterprises/{id}/auditlog?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

Responses

Success

A schema has not been defined for this response code.

Get Enterprise admin Members

GET /1/enterprises/{id}/admins

Get an enterprise's admin members.

Request

Path parameters
id Required

string

ID of the enterprise to retrieve.

Pattern: ^[0-9a-fA-F]{32}$
Query parameters
key Required

string

The API key to use

Pattern: ^[0-9a-fA-F]{32}$
token Required

string

The API token to use

Pattern: ^[0-9a-fA-F]{64}$
fields

string

Any valid value that the nested member field resource accepts.

Default: fullName, userName

Example

1
2
3
curl --request GET \
  --url 'https://api.trello.com/1/enterprises/{id}/admins?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Enterprise

Get signupUrl for Enterprise

GET /1/enterprises/{id}/signupUrl

Get the signup URL for an enterprise.

Request

Path parameters
id Required

string

ID of the enterprise to retrieve.

Pattern: ^[0-9a-fA-F]{32}$
Query parameters
key Required

string

The API key to use

Pattern: ^[0-9a-fA-F]{32}$
token Required

string

The API token to use

Pattern: ^[0-9a-fA-F]{64}$
authenticate

boolean

Default: false
confirmationAccepted

boolean

Default: false
returnUrl

string

Any valid URL.

Nullable: true, Format: url
tosAccepted

boolean

Designates whether the user has seen/consented to the Trello ToS prior to being redirected to the enterprise signup page/their IdP.

Default: false

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/enterprises/{id}/signupUrl?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

Responses

Success

A schema has not been defined for this response code.

Get Members of Enterprise

GET /1/enterprises/{id}/members

Get the members of an enterprise.

Request

Path parameters
id Required

string

ID of the Enterprise to retrieve.

Pattern: ^[0-9a-fA-F]{32}$
Query parameters
key Required

string

The API key to use

Pattern: ^[0-9a-fA-F]{32}$
token Required

string

The API token to use

Pattern: ^[0-9a-fA-F]{64}$
fields

string

A comma-seperated list of valid member fields.

Default: avatarHash, fullName, initials, username
filter

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.

Nullable: true
sort

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.

sortBy

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.

sortOrder

string

Deprecated: Please use sort instead. One of: ascending, descending, asc, desc.

Nullable: true

Valid values:Β ascending, descending, asc, desc

startIndex

integer

Any integer between 0 and 9999.

Minimum: 0, Maximum: 9999, Format: int32
count

string

Default: none
organization_fields

string

Any valid value that the nested organization field resource accepts.

Default: displayName
board_fields

string

Any valid value that the nested board resource accepts.

Default: name

Example

1
2
curl --request GET \
  --url 'https://api.trello.com/1/enterprises/{id}/members?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

Responses

Success

A schema has not been defined for this response code.

Get a Member of Enterprise

GET /1/enterprises/{id}/members/{idMember}

Get a specific member of an enterprise by ID.

Request

Path parameters
id Required

string

ID of the enterprise to retrieve.

Pattern: ^[0-9a-fA-F]{32}$
idMember Required

string

An ID of a member resource.

Pattern: ^[0-9a-fA-F]{32}$
Query parameters
key Required

string

The API key to use

Pattern: ^[0-9a-fA-F]{32}$
token Required

string

The API token to use

Pattern: ^[0-9a-fA-F]{64}$
fields

string

A comma separated list of any valid values that the nested member field resource accepts.

Default: avatarHash, fullName, initials, username
organization_fields

string

Any valid value that the nested organization field resource accepts.

Default: displayName
board_fields

string

Any valid value that the nested board resource accepts.

Default: name

Example

1
2
3
curl --request GET \
  --url 'https://api.trello.com/1/enterprises/{id}/members/{idMember}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Member

Get whether an organization can be transferred to an enterprise.

GET /1/enterprises/{id}/transferrable/organization/{idOrganization}

Get whether an organization can be transferred to an enterprise.

Request

Path parameters
id Required

string

ID of the Enterprise to retrieve.

Pattern: ^[0-9a-fA-F]{32}$
idOrganization Required

string

An ID of an Organization resource.

Pattern: ^[0-9a-fA-F]{32}$
Query parameters
key Required

string

The API key to use

Pattern: ^[0-9a-fA-F]{32}$
token Required

string

The API token to use

Pattern: ^[0-9a-fA-F]{64}$

Example

1
2
3
curl --request GET \
  --url 'https://api.trello.com/1/enterprises/{id}/transferrable/organization/{idOrganization}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Organization

Create an auth Token for an Enterprise.

POST /1/enterprises/{id}/tokens

Create an auth Token for an Enterprise.

Request

Path parameters
id Required

string

ID of the enterprise to retrieve.

Query parameters
key Required

string

The API key to use

Pattern: ^[0-9a-fA-F]{32}$
token Required

string

The API token to use

Pattern: ^[0-9a-fA-F]{64}$
expiration

string

One of: 1hour, 1day, 30days, never

Default: none

Example

1
2
curl --request POST \
  --url 'https://api.trello.com/1/enterprises/{id}/tokens?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

Responses

Success

A schema has not been defined for this response code.

Transfer an Organization to an Enterprise.

PUT /1/enterprises/{id}/organizations

Transfer an organization to an enterprise.

Request

Path parameters
id Required

string

ID of the Enterprise to retrieve.

Pattern: ^[0-9a-fA-F]{32}$
Query parameters
key Required

string

The API key to use

Pattern: ^[0-9a-fA-F]{32}$
token Required

string

The API token to use. Note: This must be an Enterprise admin's token.

Pattern: ^[0-9a-fA-F]{64}$
idOrganization Required

string

ID of Organization to be transferred to Enterprise.

Example

1
2
3
curl --request PUT \
  --url 'https://api.trello.com/1/enterprises/{id}/organizations?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548&idOrganization={idOrganization}' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Array<Organization>

Update a Member's licensed status

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.

Request

Path parameters
id Required

string

ID of the Enterprise.

Pattern: ^[0-9a-fA-F]{32}$
idMember Required

string

The ID of the Member

Pattern: ^[0-9a-fA-F]{32}$
Query parameters
key Required

string

The API key to use

Pattern: ^[0-9a-fA-F]{32}$
token Required

string

The API token to use. Note: This must be an Enterprise admin's token.

Pattern: ^[0-9a-fA-F]{64}$
Values Required

boolean

Boolean value to determine whether the user should be given an Enterprise license (true) or not (false).

Example

1
2
3
curl --request PUT \
  --url 'https://api.trello.com/1/enterprises/{id}/members/{idMember}/licensed?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548&Values={Values}' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Member

Deactivate a Member of an Enterprise.

PUT /1/enterprises/{id}/members/{idMember}/deactivated

Deactivate a Member of an Enterprise.

Request

Path parameters
id Required

string

ID of the enterprise to retrieve.

Pattern: ^[0-9a-fA-F]{32}$
idMember Required

string

ID of the Member to deactive.

Pattern: ^[0-9a-fA-F]{32}$
Query parameters
key Required

string

The API key to use

Pattern: ^[0-9a-fA-F]{32}$
token Required

string

The API token to use

Pattern: ^[0-9a-fA-F]{64}$
value Required

boolean

Determines whether the user is deactivated or not.

fields

string

A comma separated list of any valid values that the nested member field resource accepts.

Style: form

Valid values:Β id

organization_fields

string

Any valid value that the nested organization resource accepts.

Style: form

Valid values:Β id, name

board_fields

string

Any valid value that the nested board resource accepts.

Valid values:Β id, name, desc, descData, closed, idMemberCreator, idOrganization, pinned, url, shortUrl ...(Show more)

Example

1
2
curl --request PUT \
  --url 'https://api.trello.com/1/enterprises/{id}/members/{idMember}/deactivated?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548&value={value}'

Responses

Success

A schema has not been defined for this response code.

Update Member to be admin of Enterprise

PUT /1/enterprises/{id}/admins/{idMember}

Make Member an admin of Enterprise.

Request

Path parameters
id Required

string

ID of the enterprise to retrieve.

Pattern: ^[0-9a-fA-F]{32}$
idMember Required

string

ID of member to be made an admin of enterprise.

Pattern: ^[0-9a-fA-F]{32}$
Query parameters
key Required

string

The API key to use

Pattern: ^[0-9a-fA-F]{32}$
token Required

string

The API token to use

Pattern: ^[0-9a-fA-F]{64}$

Example

1
2
curl --request PUT \
  --url 'https://api.trello.com/1/enterprises/{id}/admins/{idMember}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

Responses

Success

A schema has not been defined for this response code.

Delete an Organization from an Enterprise.

DELETE /1/enterprises/{id}/organizations/{idOrg}

Remove an organization from an enterprise.

Request

Path parameters
id Required

string

ID of the enterprise to retrieve.

Pattern: ^[0-9a-fA-F]{32}$
idOrg Required

string

ID of the organization to be removed from the enterprise.

Pattern: ^[0-9a-fA-F]{32}$
Query parameters
key Required

string

The API key to use

Pattern: ^[0-9a-fA-F]{32}$
token Required

string

The API token to use

Pattern: ^[0-9a-fA-F]{64}$

Example

1
2
curl --request DELETE \
  --url 'https://api.trello.com/1/enterprises/{id}/organizations/{idOrg}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

Responses

Success

A schema has not been defined for this response code.

Remove a Member as admin from Enterprise.

DELETE /1/enterprises/{id}/organizations/{idMember}

Remove an member as admin from an enterprise.

Request

Path parameters
id Required

string

ID of the Enterprise to retrieve.

Pattern: ^[0-9a-fA-F]{32}$
idMember Required

string

ID of the member to be removed as an admin from enterprise.

Pattern: ^[0-9a-fA-F]{32}$
Query parameters
key Required

string

The API key to use

Pattern: ^[0-9a-fA-F]{32}$
token Required

string

The API token to use

Pattern: ^[0-9a-fA-F]{64}$

Example

1
2
curl --request DELETE \
  --url 'https://api.trello.com/1/enterprises/{id}/organizations/{idMember}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

Responses

Success

A schema has not been defined for this response code.

Rate this page: