Get Artist Segments

Retrieve all segments associated with an artist. This endpoint should be called before using the Segment Fans endpoint to obtain the necessary segment IDs. Supports pagination.

GET /api/artist/segments

cURL

cURL

curl --request GET \
  --url https://recoup-api.vercel.app/api/artist/segments \
  --header 'x-api-key: <api-key>'

200

{
  "status": "success",
  "segments": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "artist_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updated_at": "2023-11-07T05:31:56Z",
      "segment_name": "<string>",
      "artist_name": "<string>"
    }
  ],
  "pagination": {
    "total_count": 123,
    "page": 123,
    "limit": 123,
    "total_pages": 123
  }
}

Authorizations

x-api-key · string · header · required

Your Recoup API key. Learn more.

Query Parameters

artist_account_id · string<uuid> · required

The unique identifier of the artist account to fetch segments for

page · integer · default: 1

The page number to retrieve (default: 1)

limit · integer · default: 20

The number of records per page (default: 20, max: 100)

Required range: x <= 100

Response

200

application/json

Segments retrieved successfully

status · enum<string> · required

Status of the request

Available options: success

segments · object[] · required

List of segment objects associated with the artist

Show child attributes

pagination · object · required

Pagination metadata for the response

Show child attributes