Team

A descriptor of a group of users.

color	string or null <= 255 characters The color used to label and highlight the team.
createdAt	string or null <date-time> The date and time the team was created.
name	string or null <= 255 characters The name of the team (e.g. "SDRs").
scimExternalId	string or null <= 255 characters The ID from the SCIM provisioning service used to create the team.
scimSource	string or null <= 255 characters The name of the SCIM provisioning source used to create the team.
updatedAt	string or null <date-time> The date and time the team was last updated.

{"color": "string",
"createdAt": "2019-08-24T14:15:22Z",
"name": "string",
"scimExternalId": "string",
"scimSource": "string",
"updatedAt": "2019-08-24T14:15:22Z"
}

Team Relationships

	object
	object The content categories that are assigned to the team. Relationship contentCategories cannot be used as a filter.
	object The creator of the team. Relationship creator cannot be used as a filter.
	object The team favorited by the user.
	object
	object The membership info of users to the team
	object Data records that are associated with the team.
	object Settings to apply to the team. This field is not yet supported and should not be used.
	object The most recent updater of the team. Relationship updater cannot be used as a filter.
	object The users associated with the team. You can use only the attribute id to filter teams by users (e.g. filter[users][id]=X).

{"batches": {"links": {"related": "http://example.com"
}
},
"contentCategories": {"data": [{"id": 0,
"type": "contentCategory"
}
],
"links": {"related": "http://example.com"
}
},
"creator": {"data": {"id": 0,
"type": "user"
},
"links": {"related": "http://example.com"
}
},
"favorites": {"data": [{"id": 0,
"type": "favorite"
}
],
"links": {"related": "http://example.com"
}
},
"roleAssignedUsers": {"data": [{"id": 0,
"type": "user"
}
],
"links": {"related": "http://example.com"
}
},
"teamMemberships": {"data": [{"id": 0,
"type": "teamMembership"
}
],
"links": {"related": "http://example.com"
}
},
"teamRecords": {"data": [{"id": 0,
"type": "teamRecord"
}
],
"links": {"related": "http://example.com"
}
},
"teamSettings": {"data": {"id": 0,
"type": "teamSettings"
},
"links": {"related": "http://example.com"
}
},
"updater": {"data": {"id": 0,
"type": "user"
},
"links": {"related": "http://example.com"
}
},
"users": {"data": [{"id": 0,
"type": "user"
}
],
"links": {"related": "http://example.com"
}
}
}

Team Resource Metadata

METADATA NAME	DESCRIPTION	QUERY PARAM
canWrite	A boolean value indicating whether the current API user has write access to this resource.	provideAuthorizationMeta
canDelete	A boolean value indicating whether the current API user has delete access to this resource.	provideAuthorizationMeta

⌵ Team Actions

Get a Collection of Teams

SecuritybearerAuth

Responses

200

422

JSON error message

get/teams

Request samples

curl
JavaScript
Python
Go
Java

Response samples

application/vnd.api+json

{"data": [{"attributes": {"color": "string",
"createdAt": "2019-08-24T14:15:22Z",
"name": "string",
"scimExternalId": "string",
"scimSource": "string",
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batches": {"links": {"related": "http://example.com"
}
},
"contentCategories": {"data": [{"id": 0,
"type": "contentCategory"
}
],
"links": {"related": "http://example.com"
}
},
"creator": {"data": {"id": 0,
"type": "user"
},
"links": {"related": "http://example.com"
}
},
"favorites": {"data": [{"id": 0,
"type": "favorite"
}
],
"links": {"related": "http://example.com"
}
},
"roleAssignedUsers": {"data": [{"id": 0,
"type": "user"
}
],
"links": {"related": "http://example.com"
}
},
"teamMemberships": {"data": [{"id": 0,
"type": "teamMembership"
}
],
"links": {"related": "http://example.com"
}
},
"teamRecords": {"data": [{"id": 0,
"type": "teamRecord"
}
],
"links": {"related": "http://example.com"
}
},
"teamSettings": {"data": {"id": 0,
"type": "teamSettings"
},
"links": {"related": "http://example.com"
}
},
"updater": {"data": {"id": 0,
"type": "user"
},
"links": {"related": "http://example.com"
}
},
"users": {"data": [{"id": 0,
"type": "user"
}
],
"links": {"related": "http://example.com"
}
}
},
"type": "string"
}
]
}

Create a New Team

SecuritybearerAuth

Request

Request Body schema: application/vnd.api+json
required

object

Responses

201

Created

422

JSON error message

post/teams

Request samples

application/vnd.api+json

{"data": {"attributes": {"color": "string",
"createdAt": "2019-08-24T14:15:22Z",
"name": "string",
"scimExternalId": "string",
"scimSource": "string",
"updatedAt": "2019-08-24T14:15:22Z"
},
"relationships": {"batches": {"links": {"related": "http://example.com"
}
},
"contentCategories": {"data": [{"id": 0,
"type": "contentCategory"
}
],
"links": {"related": "http://example.com"
}
},
"creator": {"data": {"id": 0,
"type": "user"
},
"links": {"related": "http://example.com"
}
},
"favorites": {"data": [{"id": 0,
"type": "favorite"
}
],
"links": {"related": "http://example.com"
}
},
"roleAssignedUsers": {"data": [{"id": 0,
"type": "user"
}
],
"links": {"related": "http://example.com"
}
},
"teamMemberships": {"data": [{"id": 0,
"type": "teamMembership"
}
],
"links": {"related": "http://example.com"
}
},
"teamRecords": {"data": [{"id": 0,
"type": "teamRecord"
}
],
"links": {"related": "http://example.com"
}
},
"teamSettings": {"data": {"id": 0,
"type": "teamSettings"
},
"links": {"related": "http://example.com"
}
},
"updater": {"data": {"id": 0,
"type": "user"
},
"links": {"related": "http://example.com"
}
},
"users": {"data": [{"id": 0,
"type": "user"
}
],
"links": {"related": "http://example.com"
}
}
},
"type": "string"
}
}

Response samples

application/vnd.api+json

{"data": {"attributes": {"color": "string",
"createdAt": "2019-08-24T14:15:22Z",
"name": "string",
"scimExternalId": "string",
"scimSource": "string",
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batches": {"links": {"related": "http://example.com"
}
},
"contentCategories": {"data": [{"id": 0,
"type": "contentCategory"
}
],
"links": {"related": "http://example.com"
}
},
"creator": {"data": {"id": 0,
"type": "user"
},
"links": {"related": "http://example.com"
}
},
"favorites": {"data": [{"id": 0,
"type": "favorite"
}
],
"links": {"related": "http://example.com"
}
},
"roleAssignedUsers": {"data": [{"id": 0,
"type": "user"
}
],
"links": {"related": "http://example.com"
}
},
"teamMemberships": {"data": [{"id": 0,
"type": "teamMembership"
}
],
"links": {"related": "http://example.com"
}
},
"teamRecords": {"data": [{"id": 0,
"type": "teamRecord"
}
],
"links": {"related": "http://example.com"
}
},
"teamSettings": {"data": {"id": 0,
"type": "teamSettings"
},
"links": {"related": "http://example.com"
}
},
"updater": {"data": {"id": 0,
"type": "user"
},
"links": {"related": "http://example.com"
}
},
"users": {"data": [{"id": 0,
"type": "user"
}
],
"links": {"related": "http://example.com"
}
}
},
"type": "string"
}
}

Delete an Existing Team by ID

SecuritybearerAuth

Request

path Parameters

required

integer

Responses

204

Deleted

422

JSON error message

delete/teams/{id}

Request samples

curl
JavaScript
Python
Go
Java

Response samples

application/vnd.api+json

{"errors": [{"detail": "string",
"id": "string",
"title": "string"
}
]
}

Get a Team by ID

SecuritybearerAuth

Request

path Parameters

required

integer

Responses

200

404

Not Found

get/teams/{id}

Request samples

curl
JavaScript
Python
Go
Java

Response samples

application/vnd.api+json

{"data": {"attributes": {"color": "string",
"createdAt": "2019-08-24T14:15:22Z",
"name": "string",
"scimExternalId": "string",
"scimSource": "string",
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batches": {"links": {"related": "http://example.com"
}
},
"contentCategories": {"data": [{"id": 0,
"type": "contentCategory"
}
],
"links": {"related": "http://example.com"
}
},
"creator": {"data": {"id": 0,
"type": "user"
},
"links": {"related": "http://example.com"
}
},
"favorites": {"data": [{"id": 0,
"type": "favorite"
}
],
"links": {"related": "http://example.com"
}
},
"roleAssignedUsers": {"data": [{"id": 0,
"type": "user"
}
],
"links": {"related": "http://example.com"
}
},
"teamMemberships": {"data": [{"id": 0,
"type": "teamMembership"
}
],
"links": {"related": "http://example.com"
}
},
"teamRecords": {"data": [{"id": 0,
"type": "teamRecord"
}
],
"links": {"related": "http://example.com"
}
},
"teamSettings": {"data": {"id": 0,
"type": "teamSettings"
},
"links": {"related": "http://example.com"
}
},
"updater": {"data": {"id": 0,
"type": "user"
},
"links": {"related": "http://example.com"
}
},
"users": {"data": [{"id": 0,
"type": "user"
}
],
"links": {"related": "http://example.com"
}
}
},
"type": "string"
}
}

Update a Team

SecuritybearerAuth

Request

path Parameters

required

integer

Request Body schema: application/vnd.api+json
required

object

Responses

200

422

JSON error message

patch/teams/{id}

Request samples

application/vnd.api+json

{"data": {"attributes": {"color": "string",
"createdAt": "2019-08-24T14:15:22Z",
"name": "string",
"scimExternalId": "string",
"scimSource": "string",
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batches": {"links": {"related": "http://example.com"
}
},
"contentCategories": {"data": [{"id": 0,
"type": "contentCategory"
}
],
"links": {"related": "http://example.com"
}
},
"creator": {"data": {"id": 0,
"type": "user"
},
"links": {"related": "http://example.com"
}
},
"favorites": {"data": [{"id": 0,
"type": "favorite"
}
],
"links": {"related": "http://example.com"
}
},
"roleAssignedUsers": {"data": [{"id": 0,
"type": "user"
}
],
"links": {"related": "http://example.com"
}
},
"teamMemberships": {"data": [{"id": 0,
"type": "teamMembership"
}
],
"links": {"related": "http://example.com"
}
},
"teamRecords": {"data": [{"id": 0,
"type": "teamRecord"
}
],
"links": {"related": "http://example.com"
}
},
"teamSettings": {"data": {"id": 0,
"type": "teamSettings"
},
"links": {"related": "http://example.com"
}
},
"updater": {"data": {"id": 0,
"type": "user"
},
"links": {"related": "http://example.com"
}
},
"users": {"data": [{"id": 0,
"type": "user"
}
],
"links": {"related": "http://example.com"
}
}
},
"type": "string"
}
}

Response samples

application/vnd.api+json

{"data": {"attributes": {"color": "string",
"createdAt": "2019-08-24T14:15:22Z",
"name": "string",
"scimExternalId": "string",
"scimSource": "string",
"updatedAt": "2019-08-24T14:15:22Z"
},
"id": 0,
"relationships": {"batches": {"links": {"related": "http://example.com"
}
},
"contentCategories": {"data": [{"id": 0,
"type": "contentCategory"
}
],
"links": {"related": "http://example.com"
}
},
"creator": {"data": {"id": 0,
"type": "user"
},
"links": {"related": "http://example.com"
}
},
"favorites": {"data": [{"id": 0,
"type": "favorite"
}
],
"links": {"related": "http://example.com"
}
},
"roleAssignedUsers": {"data": [{"id": 0,
"type": "user"
}
],
"links": {"related": "http://example.com"
}
},
"teamMemberships": {"data": [{"id": 0,
"type": "teamMembership"
}
],
"links": {"related": "http://example.com"
}
},
"teamRecords": {"data": [{"id": 0,
"type": "teamRecord"
}
],
"links": {"related": "http://example.com"
}
},
"teamSettings": {"data": {"id": 0,
"type": "teamSettings"
},
"links": {"related": "http://example.com"
}
},
"updater": {"data": {"id": 0,
"type": "user"
},
"links": {"related": "http://example.com"
}
},
"users": {"data": [{"id": 0,
"type": "user"
}
],
"links": {"related": "http://example.com"
}
}
},
"type": "string"
}
}

Team

Team Relationships

Team Resource Metadata

⌵ Team Actions

Get a Collection of Teams

Create a New Team

Request Body schema: application/vnd.api+jsonrequired

Delete an Existing Team by ID

path Parameters

Get a Team by ID

path Parameters

Update a Team

path Parameters

Request Body schema: application/vnd.api+jsonrequired

Request Body schema: application/vnd.api+json
required

Request Body schema: application/vnd.api+json
required