GetCollaborators

Get Collaborators

Allows to retrieve Collaborators to the requester songs. This endpoint supports pagination and filtering.

Request

URL: /v1/collaborations/collaborators

Method: GET

Path Parameters: None

Query Parameters:

Parameter	Type	Description	Requirement Type
offset	integer	Start offset of paginated results to retrieve. Default is 0.	Optional
limit	integer	Maximum number of paginated results to retrieve. Default is 25.	Optional
sortOrder	string	Sort order of the results based on email field. Valid values are desc and asc. Default is asc.	Optional
excludeMe	boolean	Indicates whether or not to exclude the Song owner. Default is false.	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
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

Headers:

Authorization: Bearer {accessToken}

Accept: application/json

✅ Success Response

Code: 200 OK

Headers:

Content-Type: application/json

Content:

Field	Type	Description	Condition
email	string	Email of the Collaborator.	Always
songCount	number	Number of collaborated songs.	Always
user	object	Colaborator's User oject (refer to description at Get User API).	Only if available

Content example:

[
    {
        "email": "[email protected]",
        "songCount": 3
    },
    {
        "email": "[email protected]",
        "songCount": 10,
        "user": {
            "id": "7bd2862f-8deb-4814-8943-156d9dab80dd",
            "createdAt": "2022-04-22T20:47:55.738918",
            "firstName": "John",
            "lastName": "Doe",
            "pictureUrl": "https://somewebsite/john-doe.png",
            "role": "Producer",
            "genre": "Pop",
            "biography": "John is a leading Pop Music Producer",
            "walletAddress": "addr123456789123456789",
            "email": "[email protected]"
        }
    }
]

❌ 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 Collaborator Count