Rate this page:

Organizations

Create a new Organization

POST /1/organizations

Create a new team

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

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

string

The name to display for the Organization

desc

string

The description for the organizations

name

string

A string with a length of at least 3. Only lowercase letters, underscores, and numbers are allowed. Must be unique.

Min length: 3
website

string

A URL starting with http:// or https://

Format: url

Example

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

Responses

Success

Content typeValue
application/json

Organization

Get an Organization

GET /1/organizations/{id}

Request

Path parameters
id Required

string

The ID or name of the Organization

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/organizations/{id}' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Organization

Update an Organization

PUT /1/organizations/{id}

Update an organization

Request

Path parameters
id Required

string

The ID or name of the Organization

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}$
name

string

A new name for the organization. At least 3 lowercase letters, underscores, and numbers. Must be unique

displayName

string

A new displayName for the organization. Must be at least 1 character long and not begin or end with a space.

desc

string

A new description for the organization

website

string

A URL starting with http://, https://, or null

prefs/associatedDomain

string

The Google Apps domain to link this org to.

prefs/externalMembersDisabled

boolean

Whether non-team members can be added to boards inside the team

prefs/googleAppsVersion

integer

1 or 2

Format: int32
prefs/boardVisibilityRestrict/org

string

Who on the team can make team visible boards. One of admin, none, org

prefs/boardVisibilityRestrict/private

string

Who can make private boards. One of: admin, none, org

prefs/boardVisibilityRestrict/public

string

Who on the team can make public boards. One of: admin, none, org

prefs/orgInviteRestrict

string

An email address with optional wildcard characters. (E.g. subdomain.*.trello.com)

prefs/permissionLevel

string

Whether the team page is publicly visible. One of: private, public

Example

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

Responses

Success

Content typeValue
application/json

Organization

Delete an Organization

DELETE /1/organizations/{id}

Delete an Organization

Request

Path parameters
id Required

string

The ID or name of the Organization

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/organizations/{id}'

Responses

Success

A schema has not been defined for this response code.

Get field on Organization

GET /1/organizations/{id}/{field}

Request

Path parameters
id Required

string

The ID or name of the organization

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

string

An organization field

Valid values: id, name

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/organizations/{id}/{field}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Organization

Get Actions for Organization

GET /1/organizations/{id}/actions

List the actions on a team

Request

Path parameters
id Required

string

The ID or name of the organization

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/organizations/{id}/actions?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Array<Action>

Get Boards in an Organization

GET /1/organizations/{id}/boards

List the boards in a team

Request

Path parameters
id Required

string

The ID or name of the organization

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}$
filter

string

all or a comma-separated list of: open, closed, members, organization, public

Default: all

Valid values: all, open, closed, members, organization, public

fields

string

all or a comma-separated list of board fields

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

Example

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

Responses

Success

Content typeValue
application/json

Array<Board>

Retrieve Organization's Exports

GET /1/organizations/{id}/exports

Retrieve the exports that exist for the given organization

Request

Path parameters
id Required

string

The ID or name of the team

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/organizations/{id}/exports' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Array<Export>

Create Export for Organizations

POST /1/organizations/{id}/exports

Kick off CSV export for an organization

Request

Path parameters
id Required

string

The ID or name of the team

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}$
attachments

boolean

Whether the CSV should include attachments or not.

Default: true

Example

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

Responses

Success

Content typeValue
application/json

Export

Get the Members of an Organization

GET /1/organizations/{id}/members

List the members in a team

Request

Path parameters
id Required

string

The ID or name of the Organization

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/organizations/{id}/members?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Array<Member>

Update an Organization's Members

PUT /1/organizations/{id}/members

Request

Path parameters
id Required

string

The ID or name of the organization

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}$
email Required

string

An email address

Format: email
fullName Required

string

Name for the member, at least 1 character not beginning or ending with a space

Min length: 1
type

string

One of: admin, normal

Default: normal

Valid values: admin, normal

Example

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

Responses

Success

A schema has not been defined for this response code.

Get Members with Pending Invites to an Organization

GET /1/organizations/{id}/membersInvited

List the members with pending invites to a team

Request

Path parameters
id Required

string

The ID or name of the organization

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

all or a comma-separated list of member fields

Default: all

Example

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

Responses

Success

Content typeValue
application/json

Array<Member>

Get Memberships of an Organization

GET /1/organizations/{id}/memberships

List the memberships of a team

Request

Path parameters
id Required

string

The ID or name of the organization

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}$
filter

string

all or a comma-separated list of: active, admin, deactivated, me, normal

Style: form, Default: all

Valid values: all, active, admin, deactivated, me, normal

member

boolean

Whether to include the Member objects with the Memberships

Default: false

Example

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

Responses

Success

Content typeValue
application/json

Array<Memberships>

Get a Membership of an Organization

GET /1/organizations/{id}/memberships/{idMembership}

Get a single Membership for an Organization

Request

Path parameters
id Required

string

The ID or name of the organization

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

string

The ID of the membership to load

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}$
member

boolean

Whether to include the Member object in the response

Default: false

Example

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

Responses

Success

Content typeValue
application/json

Memberships

Get the pluginData Scoped to Organization

GET /1/organizations/{id}/pluginData

Get organization scoped pluginData on this team

Request

Path parameters
id Required

string

The ID or name of the organization

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/organizations/{id}/pluginData?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Array<PluginData>

Get Tags of an Organization

GET /1/organizations/{id}/tags

List the organization's collections

Request

Path parameters
id Required

oneOf [string, string]

The ID or name of the Organization

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/organizations/{id}/tags' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Array<Tag>

Create a Tag in Organization

POST /1/organizations/{id}/tags

Create a Tag in an Organization

Request

Path parameters
id Required

oneOf [string, string]

The ID or name of the Organization

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 POST \
  --url 'https://api.trello.com/1/organizations/{id}/tags' \
  --header 'Accept: application/json'

Responses

Success

Content typeValue
application/json

Tag

Update a Member of an Organization

PUT /1/organizations/{id}/members/{idMember}

Add a member to a team or update their member type.

Request

Path parameters
id Required

string

The ID or name of the organization

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

oneOf [string, string]

The ID or username of the member to update

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}$
type Required

string

One of: admin, normal

Valid values: admin, normal

Example

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

Responses

Success

Content typeValue
application/json

Member

Remove a Member from an Organization

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

Remove a member from a team

Request

Path parameters
id Required

oneOf [string, string]

The ID or name of the organization

idMember Required

string

The ID of the Member to remove from the team

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/organizations/{id}/members/{idMember}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

Responses

Success

A schema has not been defined for this response code.

Deactivate or reactivate a member of an Organization

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

Deactivate or reactivate a member of a team

Request

Path parameters
id Required

string

The ID or name of the organization

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

oneOf [string, string]

The ID or username of the member to update

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

string

Example

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

Responses

Success

A schema has not been defined for this response code.

Update logo for an Organization

POST /1/organizations/{id}/logo

Set the logo image for a team

Request

Path parameters
id Required

string

The ID or name of the team

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}$
file

string

Image file for the logo

Format: binary

Example

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

Responses

Success

Content typeValue
application/json

Organization

Delete Logo for Organization

DELETE /1/organizations/{id}/logo

Delete a the logo from a team

Request

Path parameters
id Required

string

The ID or name of the organization

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/organizations/{id}/logo?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

Responses

Success

A schema has not been defined for this response code.

Remove a Member from an Organization and all Oranization Boards

DELETE /1/organizations/{id}/members/{idMember}/all

Remove a member from a team and from all team boards

Request

Path parameters
id Required

string

The ID or name of the organization

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

string

The ID of the member to remove from the team

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/organizations/{id}/members/{idMember}/all?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

Responses

Success

A schema has not been defined for this response code.

Remove the associated Google Apps domain from a team

DELETE /1/organizations/{id}/prefs/associatedDomain

Remove the associated Google Apps domain from a team

Request

Path parameters
id Required

string

The ID or name of the organization

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/organizations/{id}/prefs/associatedDomain?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

Responses

Success

A schema has not been defined for this response code.

Delete the email domain restriction on who can be invited to the team

DELETE /1/organizations/{id}/prefs/orgInviteRestrict

Remove the email domain restriction on who can be invited to the team

Request

Path parameters
id Required

string

The ID or name of the organization

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/organizations/{id}/prefs/orgInviteRestrict?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

Responses

Success

A schema has not been defined for this response code.

Delete an Organization's Tag

DELETE /1/organizations/{id}/tags/{idTag}

Delete an organization's tag

Request

Path parameters
id Required

string

The ID or name of the organization

idTag Required

string

The ID of the tag to delete

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/organizations/{id}/tags/{idTag}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

Responses

Success

A schema has not been defined for this response code.

Get Organizations new billable guests

GET /1/organizations/{id}/newBillableGuests/{idBoard}

Used to check whether the given board has new billable guests on it.

Request

Path parameters
id Required

string

The ID or name of the organization

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

string

The ID of the board to check for new billable guests.

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 GET \
  --url 'https://api.trello.com/1/organizations/{id}/newBillableGuests/{idBoard}?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548'

Responses

Success

A schema has not been defined for this response code.

Rate this page: