GetUsers

Get Users

Allows to get Users. This endpoint supports pagination and filtering.

Request

URL: /v1/users

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 createdAt field. Valid values are desc (newest first) and asc (oldest first). Default is asc.	Optional
ids	string list	Comma-separated list of user UUID's for filtering results. Prefix each value with - to exclude and + (optional) to include. Defaults to inclusion if no prefix is specified.	Optional
roles	string list	Comma-separated list of user roles for filtering results. Prefix each value with - to exclude and + (optional) to include. Defaults to inclusion if no prefix is specified.	Optional
genres	string list	Comma-separated list of user genres 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:

Accept: application/json

Authorization: Bearer {accessToken}

✅ Success Response

Code: 200 OK

Headers:

Content-Type: application/json

Content:

Field	Type	Description	Condition
id	string	UUID of the User.	Always
createdAt	string	Date and time when the User was created (ISO-8601 format).	Always
firstName	string	User first name.	Only if available
lastName	string	User last name.	Only if available
nickname	string	User nickname.	Only if available
pictureUrl	string	Valid URL of picture image file.	Only if available
bannerUrl	string	Valid URL of banner image file.	Only if available
websiteUrl	string	Valid URL of User personal website.	Only if available
twitterUrl	string	Valid URL of User Twitter account.	Only if available
instagramUrl	string	Valid URL of User Instagram account.	Only if available
spotifyProfile	string	Spotify artist profile URI. E.g. spotify:artist:xyz for artist link https://open.spotify.com/artist/xyz include.	Only if available
soundCloudProfile	string	SoundCloud artist profile permalink. E,g. xyz for artist link https://soundcloud.com/xyz.	Only if available
appleMusicProfile	string	Apple Music artist profile ID. E,g. xyz for artist link https://music.apple.com/abcd/efg/xyz.	Only if available
location	string	User location.	Only if available
role	string	User role.	Only if available
genre	string	User genre.	Only if available
biography	string	User biography.	Only if available
companyName	string	Company name.	Only if available
companyLogoUrl	string	Valid URL of company logo image.	Only if available
companyIpRights	boolean	Indicates if the IP rights belong to the company.	Only if available
dspPlanSubscribed	boolean	Indicates if subscribed to the DSP pricing plan.	Always
referralCode	string	User referral-code.	Always

Content example:

[
   {
       "id": "7bd2862f-8deb-4814-8943-156d9dab80dd",
       "firstName": "John",
       "lastName": "Doe",
       "nickname": "Johnny"
       "pictureUrl": "https://somewebsite/john-doe.png",
       "role": "Producer",
       "genre": "Pop",
       "biography": "John is a leading Pop Music Producer",
       "dspPlanSubscribed": false,
       "referralCode":"ak126jkk95"
   },
   {
       "id": "46550a07-31f3-48b1-8e12-b7c2a9fcde93",
       "firstName": "Jane",
       "lastName": "Dow",
       "nickname": "J"
       "pictureUrl": "https://somewebsite/jane-doe.png",
       "role": "Singer",
       "genre": "R&B",
       "biography": "Jane is a leading R&B Singer",
       "dspPlanSubscribed": false,
       "referralCode":"pv4f6hln53"
   }	
]

❌ Error Responses

1. Unauthorized

Code: 401 UNAUTHORIZED

Condition: If {accessToken} is invalid or expired.

2. Unprocessable Entity

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"
}

See Also

Post User (Add New User)

Patch User (Update User)

Get User (Get User)

Get User Count

Delete User

Put User Password (Reset Password)