Actions
    Applications
    Batch
    Boards
    Cards
    Checklists
    CustomFields
    Emoji
    Enterprises
    Labels
    Lists
    Members
    Notifications
    Organizations
    Plugins
    Search
    Tokens
    Webhooks

    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]{24}$
    Query parameters
    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

    Whether or not to include paid account information in the returned workspace objects

    Default: false
    organization_memberships

    string

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

    Default: none

    Example

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

    Responses

    Success

    Content typeValue
    application/json

    Enterprise

    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.

    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.

    Request

    Path parameters
    id Required

    string

    ID of the enterprise to retrieve.

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

    Example

    1
2
3
    curl --request GET \
  --url 'https://api.trello.com/1/enterprises/{id}/auditlog?key=APIKey&token=APIToken' \
  --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    Array<EnterpriseAuditLog>

    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]{24}$
    Query parameters
    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=APIKey&token=APIToken' \
  --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    EnterpriseAdmin

    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]{24}$
    Query parameters
    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
3
    curl --request GET \
  --url 'https://api.trello.com/1/enterprises/{id}/signupUrl?key=APIKey&token=APIToken' \
  --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    object

    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]{24}$
    Query parameters
    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, null

    startIndex

    integer

    Any integer between 0 and 9999.

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

    string

    SCIM-style filter.

    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
3
    curl --request GET \
  --url 'https://api.trello.com/1/enterprises/{id}/members?key=APIKey&token=APIToken' \
  --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    Array<Member>

    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]{24}$
    idMember Required

    string

    An ID of a member resource.

    Pattern: ^[0-9a-fA-F]{24}$
    Query parameters
    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=APIKey&token=APIToken' \
  --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]{24}$
    idOrganization Required

    string

    An ID of an Organization resource.

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

    Example

    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'

    Responses

    Success

    Content typeValue
    application/json

    TransferrableOrganization

    Get a bulk list of organizations that can be transferred to an enterprise.

    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.

    Request

    Path parameters
    id Required

    string

    ID of the Enterprise to retrieve.

    Pattern: ^[0-9a-fA-F]{24}$
    idOrganizations Required

    Array<Organization>

    An array of IDs of an Organization resource.

    Example

    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'

    Responses

    Success

    Content typeValue
    application/json

    Array<TransferrableOrganization>

    Decline enterpriseJoinRequests from one organization or a bulk list of organizations.

    PUT /1/enterprises/${id}/enterpriseJoinRequest/bulk

    Decline enterpriseJoinRequests from one organization or bulk amount of organizations

    Request

    Path parameters
    id Required

    string

    ID of the Enterprise to retrieve.

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

    Array<Organization>

    An array of IDs of an Organization resource.

    Example

    1
2
    curl --request PUT \
  --url 'https://api.trello.com/1/enterprises/${id}/enterpriseJoinRequest/bulk?idOrganizations={idOrganizations}&key=APIKey&token=APIToken'

    Responses

    Success

    A schema has not been defined for this response code.

    Get ClaimableOrganizations of an Enterprise

    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.

    Request

    Path parameters
    id Required

    string

    ID of the enterprise to retrieve

    Pattern: ^[0-9a-fA-F]{24}$
    Query parameters
    limit

    integer

    Limits the number of workspaces to be sorted

    cursor

    string

    Specifies the sort order to return matching documents

    name

    string

    Name of the enterprise to retrieve workspaces for

    activeSince

    string

    Date in YYYY-MM-DD format indicating the date to search up to for activeness of workspace

    inactiveSince

    string

    Date in YYYY-MM-DD format indicating the date to search up to for inactiveness of workspace

    Example

    1
2
3
    curl --request GET \
  --url 'https://api.trello.com/1/enterprises/{id}/claimableOrganizations?key=APIKey&token=APIToken' \
  --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    ClaimableOrganizations

    Get PendingOrganizations of an Enterprise

    GET /1/enterprises/{id}/pendingOrganizations

    Get the Workspaces that are pending for the enterprise by ID.

    Request

    Path parameters
    id Required

    string

    ID of the enterprise to retrieve

    Pattern: ^[0-9a-fA-F]{24}$
    Query parameters
    activeSince

    string

    Date in YYYY-MM-DD format indicating the date to search up to for activeness of workspace

    inactiveSince

    string

    Date in YYYY-MM-DD format indicating the date to search up to for inactiveness of workspace

    Example

    1
2
3
    curl --request GET \
  --url 'https://api.trello.com/1/enterprises/{id}/pendingOrganizations?key=APIKey&token=APIToken' \
  --header 'Accept: application/json'

    Responses

    Success

    Content typeValue
    application/json

    Array<PendingOrganizations>

    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
    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=APIKey&token=APIToken'

    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.

    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.

    Request

    Path parameters
    id Required

    string

    ID of the Enterprise to retrieve.

    Pattern: ^[0-9a-fA-F]{24}$
    Query parameters
    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?idOrganization={idOrganization}&key=APIKey&token=APIToken' \
  --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. 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.

    Request

    Path parameters
    id Required

    string

    ID of the Enterprise.

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

    string

    The ID of the Member

    Pattern: ^[0-9a-fA-F]{24}$
    Query parameters
    value 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?value={value}&key=APIKey&token=APIToken' \
  --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.

    NOTE: Deactivation is not possible for enterprises that have opted in to user management via AdminHub.

    Request

    Path parameters
    id Required

    string

    ID of the enterprise to retrieve.

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

    string

    ID of the Member to deactive.

    Pattern: ^[0-9a-fA-F]{24}$
    Query parameters
    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?value={value}&key=APIKey&token=APIToken'

    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.

    NOTE: This endpoint is not available to enterprises that have opted in to user management via AdminHub.

    Request

    Path parameters
    id Required

    string

    ID of the enterprise to retrieve.

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

    string

    ID of member to be made an admin of enterprise.

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

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Remove a Member as admin from Enterprise.

    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.

    Request

    Path parameters
    id Required

    string

    ID of the Enterprise to retrieve.

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

    string

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

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

    Example

    1
2
    curl --request DELETE \
  --url 'https://api.trello.com/1/enterprises/{id}/admins/{idMember}?key=APIKey&token=APIToken'

    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]{24}$
    idOrg Required

    string

    ID of the organization to be removed from the enterprise.

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

    Example

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

    Responses

    Success

    A schema has not been defined for this response code.

    Bulk accept a set of organizations to an Enterprise.

    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.

    Request

    Path parameters
    id Required

    string

    ID of the enterprise to retrieve.

    Pattern: ^[0-9a-fA-F]{24}$
    idOrganizations Required

    Array<Organization>

    An array of IDs of the organizations to be removed from the enterprise.

    Example

    1
2
    curl --request GET \
  --url 'https://api.trello.com/1/enterprises/{id}/organizations/bulk/{idOrganizations}?key=APIKey&token=APIToken'

    Responses

    Success

    A schema has not been defined for this response code.

    Rate this page: