Rate this page:
POST /1/organizations
Create a new Workspace
string
The name to display for the Organization
string
The description for the organizations
string
A string with a length of at least 3. Only lowercase letters, underscores, and numbers are allowed. Must be unique.
3
string
A URL starting with http://
or https://
url
1 2 3
curl --request POST \
--url 'https://api.trello.com/1/organizations?displayName={displayName}&key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
GET /1/organizations/{id}
string
The ID or name of the Organization
^[0-9a-fA-F]{24}$
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/organizations/{id}?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
PUT /1/organizations/{id}
Update an organization
string
The ID or name of the Organization
^[0-9a-fA-F]{24}$
string
A new name for the organization. At least 3 lowercase letters, underscores, and numbers. Must be unique
string
A new displayName for the organization. Must be at least 1 character long and not begin or end with a space.
string
A new description for the organization
string
A URL starting with http://
, https://
, or null
string
The Google Apps domain to link this org to.
boolean
Whether non-workspace members can be added to boards inside the Workspace
integer
1
or 2
int32
string
Who on the Workspace can make Workspace visible boards. One of admin
, none
, org
string
Who can make private boards. One of: admin
, none
, org
string
Who on the Workspace can make public boards. One of: admin
, none
, org
string
An email address with optional wildcard characters. (E.g. subdomain.*.trello.com
)
string
Whether the Workspace page is publicly visible. One of: private
, public
1 2 3
curl --request PUT \
--url 'https://api.trello.com/1/organizations/{id}?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
DELETE /1/organizations/{id}
Delete an Organization
string
The ID or name of the Organization
^[0-9a-fA-F]{24}$
1 2
curl --request DELETE \
--url 'https://api.trello.com/1/organizations/{id}?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
GET /1/organizations/{id}/{field}
string
The ID or name of the organization
^[0-9a-fA-F]{24}$
string
An organization field
Valid values:Β id
, name
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/organizations/{id}/{field}?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
GET /1/organizations/{id}/actions
List the actions on a Workspace
string
The ID or name of the organization
^[0-9a-fA-F]{24}$
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/organizations/{id}/actions?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json | Array<Action> |
GET /1/organizations/{id}/boards
List the boards in a Workspace
string
The ID or name of the organization
^[0-9a-fA-F]{24}$
string
all
or a comma-separated list of: open
, closed
, members
, organization
, public
all
Valid values:Β all
, open
, closed
, members
, organization
, public
string
all
or a comma-separated list of board fields
Valid values:Β id
, name
, desc
, descData
, closed
, idMemberCreator
, idOrganization
, pinned
, url
, shortUrl
...(Show more)
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/organizations/{id}/boards?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json | Array<Board> |
GET /1/organizations/{id}/exports
Retrieve the exports that exist for the given organization
string
The ID or name of the Workspace
^[0-9a-fA-F]{24}$
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/organizations/{id}/exports?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json | Array<Export> |
POST /1/organizations/{id}/exports
Kick off CSV export for an organization
string
The ID or name of the Workspace
^[0-9a-fA-F]{24}$
boolean
Whether the CSV should include attachments or not.
true
1 2 3
curl --request POST \
--url 'https://api.trello.com/1/organizations/{id}/exports?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
GET /1/organizations/{id}/members
List the members in a Workspace
string
The ID or name of the Organization
^[0-9a-fA-F]{24}$
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/organizations/{id}/members?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json | Array<Member> |
PUT /1/organizations/{id}/members
string
The ID or name of the organization
^[0-9a-fA-F]{24}$
string
An email address
email
string
Name for the member, at least 1 character not beginning or ending with a space
1
string
One of: admin
, normal
normal
Valid values:Β admin
, normal
1 2
curl --request PUT \
--url 'https://api.trello.com/1/organizations/{id}/members?email={email}&fullName={fullName}&key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
GET /1/organizations/{id}/memberships
List the memberships of a Workspace
string
The ID or name of the organization
^[0-9a-fA-F]{24}$
string
all
or a comma-separated list of: active
, admin
, deactivated
, me
, normal
form
, Default: all
Valid values:Β all
, active
, admin
, deactivated
, me
, normal
boolean
Whether to include the Member objects with the Memberships
false
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/organizations/{id}/memberships?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json | Array<Memberships> |
GET /1/organizations/{id}/memberships/{idMembership}
Get a single Membership for an Organization
string
The ID or name of the organization
^[0-9a-fA-F]{24}$
string
The ID of the membership to load
^[0-9a-fA-F]{24}$
boolean
Whether to include the Member object in the response
false
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/organizations/{id}/memberships/{idMembership}?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
GET /1/organizations/{id}/pluginData
Get organization scoped pluginData on this Workspace
string
The ID or name of the organization
^[0-9a-fA-F]{24}$
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/organizations/{id}/pluginData?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json | Array<PluginData> |
GET /1/organizations/{id}/tags
List the organization's collections
oneOf [string, string]
The ID or name of the Organization
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/organizations/{id}/tags?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json | Array<Tag> |
POST /1/organizations/{id}/tags
Create a Tag in an Organization
oneOf [string, string]
The ID or name of the Organization
1 2 3
curl --request POST \
--url 'https://api.trello.com/1/organizations/{id}/tags?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
PUT /1/organizations/{id}/members/{idMember}
Add a member to a Workspace or update their member type.
string
The ID or name of the organization
^[0-9a-fA-F]{24}$
oneOf [string, string]
The ID or username of the member to update
string
One of: admin
, normal
Valid values:Β admin
, normal
1 2 3
curl --request PUT \
--url 'https://api.trello.com/1/organizations/{id}/members/{idMember}?type={type}&key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
DELETE /1/organizations/{id}/members/{idMember}
Remove a member from a Workspace
oneOf [string, string]
The ID or name of the organization
string
The ID of the Member to remove from the Workspace
^[0-9a-fA-F]{24}$
1 2
curl --request DELETE \
--url 'https://api.trello.com/1/organizations/{id}/members/{idMember}?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
PUT /1/organizations/{id}/members/{idMember}/deactivated
Deactivate or reactivate a member of a Workspace
string
The ID or name of the organization
^[0-9a-fA-F]{24}$
oneOf [string, string]
The ID or username of the member to update
boolean
1 2
curl --request PUT \
--url 'https://api.trello.com/1/organizations/{id}/members/{idMember}/deactivated?value={value}&key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
POST /1/organizations/{id}/logo
Set the logo image for a Workspace
string
The ID or name of the Workspace
^[0-9a-fA-F]{24}$
string
Image file for the logo
binary
1 2 3
curl --request POST \
--url 'https://api.trello.com/1/organizations/{id}/logo?key=APIKey&token=APIToken' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
DELETE /1/organizations/{id}/logo
Delete a the logo from a Workspace
string
The ID or name of the organization
^[0-9a-fA-F]{24}$
1 2
curl --request DELETE \
--url 'https://api.trello.com/1/organizations/{id}/logo?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
DELETE /1/organizations/{id}/members/{idMember}/all
Remove a member from a Workspace and from all Workspace boards
string
The ID or name of the organization
^[0-9a-fA-F]{24}$
string
The ID of the member to remove from the Workspace
^[0-9a-fA-F]{24}$
1 2
curl --request DELETE \
--url 'https://api.trello.com/1/organizations/{id}/members/{idMember}/all?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
DELETE /1/organizations/{id}/prefs/associatedDomain
Remove the associated Google Apps domain from a Workspace
string
The ID or name of the organization
^[0-9a-fA-F]{24}$
1 2
curl --request DELETE \
--url 'https://api.trello.com/1/organizations/{id}/prefs/associatedDomain?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
DELETE /1/organizations/{id}/prefs/orgInviteRestrict
Remove the email domain restriction on who can be invited to the Workspace
string
The ID or name of the organization
^[0-9a-fA-F]{24}$
1 2
curl --request DELETE \
--url 'https://api.trello.com/1/organizations/{id}/prefs/orgInviteRestrict?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
DELETE /1/organizations/{id}/tags/{idTag}
Delete an organization's tag
string
The ID or name of the organization
string
The ID of the tag to delete
1 2
curl --request DELETE \
--url 'https://api.trello.com/1/organizations/{id}/tags/{idTag}?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
GET /1/organizations/{id}/newBillableGuests/{idBoard}
Used to check whether the given board has new billable guests on it.
string
The ID or name of the organization
^[0-9a-fA-F]{24}$
string
The ID of the board to check for new billable guests.
^[0-9a-fA-F]{24}$
1 2
curl --request GET \
--url 'https://api.trello.com/1/organizations/{id}/newBillableGuests/{idBoard}?key=APIKey&token=APIToken'
Success
A schema has not been defined for this response code.
Rate this page: