Team

A descriptor of a group of users.

color
string <= 255 characters

The color used to label and highlight the team.

createdAt
string <date-time>

The date and time the team was created.

name
string <= 255 characters

The name of the team (e.g. "SDRs").

scimExternalId
string <= 255 characters

The ID from the SCIM provisioning service used to create the team.

scimSource
string <= 255 characters

The name of the SCIM provisioning source used to create the team.

updatedAt
string <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

Array of links (object) (batch)
Array of data (object) or links (object) (contentCategory)

The content categories that are assigned to the team. Relationship contentCategories cannot be used as a filter.

(user (data (object) or links (object)))

The creator of the team. Relationship creator cannot be used as a filter.

(user (data (object) or links (object)))

The most recent updater of the team. Relationship updater cannot be used as a filter.

Array of data (object) or links (object) (user)

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": [
    ],
  • "contentCategories": [
    ],
  • "creator": {
    },
  • "updater": {
    },
  • "users": [
    ]
}

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

OK

422

JSON error message

get/teams
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": [
    ]
}
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": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Delete an Existing Team by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
204
Deleted


422
JSON error message


delete/teams/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "errors": [
    ]
}
Get a Team by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/teams/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Update a Team
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
200
OK


422
JSON error message


patch/teams/{id}
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}