Skip to content

GetCollaboratorCount

Walter Lara edited this page Jul 16, 2024 · 6 revisions

Get Collaborator Count

Allows to retrieve the Collaborators count of the requester songs.

Request

URL: /v1/collaborations/collaborators/count

Method: GET

Path Parameters: None

Query Parameters:

Parameter Type Description Requirement Type
excludeMe boolean Indicates whether or not to exclude the Song owner. Default is false. Optional
phrase string Case-insensitive phrase to filter out collaborators by searching on the email, user.firstName and user.lastName fields. If missing, defaults to no filtering out. 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 emails for filtering results. Prefix each value with - to exclude and + (optional) to include. Defaults to inclusion if no prefix is specified. Optional

Headers:

Authorization: Bearer {accessToken}

Accept: application/json

✅ Success Response

Code: 200 OK

Headers:

Content-Type: application/json

Content:

Field Type Description Condition
count long Collaboration count. Always

Content example:

{
    "count": 300
}

❌ Error Responses

1. Unauthorized

Code: 401 UNAUTHORIZED

Condition: If {accessToken} is invalid or expired.

See Also

Post Collaboration (Add New Collaboration)

Patch Collaboration (Update Collaboration)

Get Collaboration

Get Collaborations

Get Collaboration Count

Delete Collaboration

Reply Collaboration

Get Collaborators

Clone this wiki locally