Teams

The endpoint for the Teams dataset, for defining Teams and Team Membership.

Retrieve multiple Teams based on search critera passed as GET Arguments

get/api/team/

The endpoint for the Teams dataset, for defining Teams and Team Membership.

Securityapi_key and user_name

Request

query Parameters

archived	boolean Whether the record has been soft-deleted or not.
default	boolean Whether or not this is a default team
id	integer <int64> The Quorum primary key for this record; guaranteed to be persistent and unique across all objects at this endpoint.
members	Array of integers <int64> The quorumusers that are associated with this team. NOTE: Parameter accepts additional qualifiers appended to the end: `members__overlaps` - The value for the record has one or more values in common with the provided array parameter (comma-separated values).
organization_id	integer <int64> The Quorum client associated with this record. NOTE: Parameter accepts additional qualifiers appended to the end: `organization__in` - The value for the record is in the provided array parameter (comma-separated values).
dehydrate_extra	Array of strings Option to provide additional detail for certain fields, either by expanding those fields with additional details from the related model or by substituting more informative values for the actual database values.`organization` - expand organization with additional details. NOTE: This parameter can accept one or more comma-separated values; it is not limited to a single value. Items Value: "organization"
limit	integer <int64> Default: 20 The number of records to return (for pagination).
offset	integer <int64> Default: 0 The number of records to offset the start of the data being returned (for pagination).

Responses

200

Team retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Response samples

application/json

{"_extra": { },
"archived": true,
"default": true,
"id": 0,
"members": ["/api/user/1/"
],
"name": "string",
"organization": "/api/organization/1/",
"resource_uri": "string"
}

Retrieve information on a single Team

get/api/team/{id}/

The endpoint for the Teams dataset, for defining Teams and Team Membership.

Securityapi_key and user_name

Request

path Parameters

required

integer <int64>

The Quorum primary key for this record; guaranteed to be persistent and unique across all objects at this endpoint.

query Parameters

dehydrate_extra

Array of strings

Option to provide additional detail for certain fields, either by expanding those fields with additional details from the related model or by substituting more informative values for the actual database values.organization - expand organization with additional details.
NOTE: This parameter can accept one or more comma-separated values; it is not limited to a single value.

Items Value: "organization"

Responses

200

Team retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Response samples

application/json

{"_extra": { },
"archived": true,
"default": true,
"id": 0,
"members": ["/api/user/1/"
],
"name": "string",
"organization": "/api/organization/1/",
"resource_uri": "string"
}

Update a single Teams by ID

patch/api/team/{id}/

The endpoint for the Teams dataset, for defining Teams and Team Membership.

Securityapi_key and user_name

Request

path Parameters

required

integer <int64>

The Quorum primary key for this record; guaranteed to be persistent and unique across all objects at this endpoint.

Request Body schema: application/json

archived	boolean Whether the record has been soft-deleted or not.
members	Array of strings <{"id": QUORUM_ID}> The quorumusers that are associated with this team.
name	string
organization_id	string <{"id": QUORUM_ID}> The Quorum client associated with this record. The argument provided must be a string-encoded JSON object with a single key, `id`, and the value being the Quorum ID of the object referenced. Example: {"id": 410003}

Responses

200

Team retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Request samples

Payload

application/json

{"archived": true,
"members": ["string"
],
"name": "string",
"organization_id": "string"
}

Response samples

application/json

{"_extra": { },
"archived": true,
"default": true,
"id": 0,
"members": ["/api/user/1/"
],
"name": "string",
"organization": "/api/organization/1/",
"resource_uri": "string"
}

Create a single Teams

post/api/team/{id}/

The endpoint for the Teams dataset, for defining Teams and Team Membership.

Securityapi_key and user_name

Request

path Parameters

required

integer <int64>

The Quorum primary key for this record; guaranteed to be persistent and unique across all objects at this endpoint.

Request Body schema: application/json

archived	boolean Whether the record has been soft-deleted or not.
members	Array of strings <{"id": QUORUM_ID}> The quorumusers that are associated with this team.
name	string
organization_id	string <{"id": QUORUM_ID}> The Quorum client associated with this record. The argument provided must be a string-encoded JSON object with a single key, `id`, and the value being the Quorum ID of the object referenced. Example: {"id": 410003}

Responses

200

Team retrieved successfully

400

improperly configured request

401

authorization failure

500

internal server error

Request samples

Payload

application/json

{"archived": true,
"members": ["string"
],
"name": "string",
"organization_id": "string"
}

Response samples

application/json

{"_extra": { },
"archived": true,
"default": true,
"id": 0,
"members": ["/api/user/1/"
],
"name": "string",
"organization": "/api/organization/1/",
"resource_uri": "string"
}