Ticketing Teams

get

Retrieves multiple ticketing teams.

Query parameters
joinsany ofOptionalDefault: []
or
string · enumOptionalPossible values:
pageNumbernumber · min: 1Optional

The page number.

Default: 1
pageSizenumber · min: 1 · max: 100Optional

The page size.

Default: 10
Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses
200

Retrieves all ticketing teams for the workspace.

application/json
or
get
/api/v1/ticketing-teams
post

Creates a new ticketing team.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Body
descriptionstring · min: 3 · max: 250 · nullableRequired

The internal description of the ticketing team.

namestring · min: 3 · max: 50Required

The display name of the ticketing team.

picturestring · nullableRequired

The picture associated with the ticketing team.

Responses
200

The ticketing team was created.

application/json
createdAtstring · date-timeRequired
idstring · uuidRequired

A UUID v4 string that identifies an entity.

isRemovedbooleanRequired
updatedAtstring · date-timeRequired
descriptionstring · min: 3 · max: 250 · nullableRequired

The internal description of the ticketing team.

namestring · min: 3 · max: 50Required

The display name of the ticketing team.

picturestring · nullableRequired

The picture associated with the ticketing team.

workspaceIdstring · uuidRequired

The workspace ID that owns the ticketing team.

post
/api/v1/ticketing-teams
get

Retrieves multiple users in a ticketing team.

Path parameters
ticketingTeamIdstring · uuidRequired

A UUID v4 string that identifies an entity.

Query parameters
joinsany ofOptionalDefault: []
or
string · enumOptionalPossible values:
pageNumbernumber · min: 1Optional

The page number.

Default: 1
pageSizenumber · min: 1 · max: 100Optional

The page size.

Default: 10
Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses
200

Retrieves all ticketing team users.

application/json
createdAtstring · date-timeRequired
updatedAtstring · date-timeRequired
activeTicketsintegerRequired
roundRobinDistributioninteger · max: 100Required
statusstring · enumRequiredPossible values:
ticketingTeamIdstring · uuidRequired

A UUID v4 string that identifies an entity.

userIdstring · uuidRequired

A UUID v4 string that identifies an entity.

get
/api/v1/ticketing-teams/{ticketingTeamId}/users
post

Creates new users or attaches existing ones to a ticketing team.

Path parameters
ticketingTeamIdstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Body
userIdstring · uuidRequired

A UUID v4 string that identifies an entity.

Responses
200

The ticketing team user was created.

application/json
createdAtstring · date-timeRequired
updatedAtstring · date-timeRequired
activeTicketsintegerRequired
roundRobinDistributioninteger · max: 100Required
statusstring · enumRequiredPossible values:
ticketingTeamIdstring · uuidRequired

A UUID v4 string that identifies an entity.

userIdstring · uuidRequired

A UUID v4 string that identifies an entity.

post
/api/v1/ticketing-teams/{ticketingTeamId}/users
patch

Updates multiple users in a ticketing team.

Path parameters
ticketingTeamIdstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Body
Responses
200

The ticketing team users were updated.

application/json
createdAtstring · date-timeRequired
updatedAtstring · date-timeRequired
activeTicketsintegerRequired
roundRobinDistributioninteger · max: 100Required
statusstring · enumRequiredPossible values:
ticketingTeamIdstring · uuidRequired

A UUID v4 string that identifies an entity.

userIdstring · uuidRequired

A UUID v4 string that identifies an entity.

patch
/api/v1/ticketing-teams/{ticketingTeamId}/users
get

Retrieves a ticketing team.

Path parameters
idstring · uuidRequired

A UUID v4 string that identifies an entity.

Query parameters
joinsany ofOptionalDefault: []
or
string · enumOptionalPossible values:
Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses
200

Retrieves a ticketing team.

application/json
or
get
/api/v1/ticketing-teams/{id}
delete

Removes a ticketing team.

Path parameters
idstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses
200

The ticketing team was removed.

application/json
messagestringRequired

An informative message for a call that has no effective result to be returned.

delete
/api/v1/ticketing-teams/{id}
patch

Updates a ticketing team.

Path parameters
idstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Body
descriptionstring · min: 3 · max: 250 · nullableOptional

The internal description of the ticketing team.

namestring · min: 3 · max: 50Optional

The display name of the ticketing team.

picturestring · nullableOptional

The picture associated with the ticketing team.

Responses
200

The ticketing team was updated.

application/json
createdAtstring · date-timeRequired
idstring · uuidRequired

A UUID v4 string that identifies an entity.

isRemovedbooleanRequired
updatedAtstring · date-timeRequired
descriptionstring · min: 3 · max: 250 · nullableRequired

The internal description of the ticketing team.

namestring · min: 3 · max: 50Required

The display name of the ticketing team.

picturestring · nullableRequired

The picture associated with the ticketing team.

workspaceIdstring · uuidRequired

The workspace ID that owns the ticketing team.

patch
/api/v1/ticketing-teams/{id}
delete

Detaches a user from a ticketing team.

Path parameters
ticketingTeamIdstring · uuidRequired

A UUID v4 string that identifies an entity.

userIdstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses
200

The ticketing team user was removed.

application/json
messagestringRequired

An informative message for a call that has no effective result to be returned.

delete
/api/v1/ticketing-teams/{ticketingTeamId}/users/{userId}

Last updated