GetCollaborationCount

Get Collaboration Count

Allows to get a Collaboration count based on filters.

URL: /v1/collaborations/count

Method: GET

Path Parameters: None

Query Parameters:

Parameter	Type	Description	Requirement Type
inbound	boolean	Selects inbound collaborations (requestor is collaborator) or outbound (requestor is owner). Default is `false`.	Optional
ids	string list	Comma-separated list of Collaboration UUID's for filtering results. Prefix each value with `-` to exclude and `+` (optional) to include. Defaults to inclusion if no prefix is specified.	Optional
songIds	string list	Comma-separated list of Song UUID's for filtering results. Prefix each value with `-` to exclude and `+` (optional) to include. Defaults to inclusion if no prefix is specified.	Optional
emails	string list	Comma-separated list of Collaboration emails for filtering results. Prefix each value with `-` to exclude and `+` (optional) to include. Defaults to inclusion if no prefix is specified.	Optional
statuses	string list	Comma-separated list of Collaboration statuses for filtering results. Prefix each value with `-` to exclude and `+` (optional) to include. Defaults to inclusion if no prefix is specified.	Optional
olderThan	string	ISO-8601 formated oldest (maximum) timestamp to filter-out results. If missing, defaults to no filtering out.	Optional
newerThan	string	ISO-8601 formated newest (minimum) timestamp to filter-out results. If missing, defaults to no filtering out.	Optional

Headers:

Authorization: Bearer {accessToken}

Accept: application/json

Code: 200 OK

Headers:

Content-Type: application/json

Content:

Field	Type	Description	Condition
count	long	Collaboration count.	Always

Content example:

{
    "count": 300
}

Code: 401 UNAUTHORIZED

Condition: If {accessToken} is invalid or expired.

Code: 422 UNPROCESSABLE ENTITY

Condition: If any of the UUID query parameters is malformed.

Headers:

Content-Type: application/json

Content example:

{
    "code": 422,
    "description": "Unprocessable Entity",
    "cause": "Invalid UUID string: 123456789"
}