Get Segment Fans

Retrieve all social profiles from fans within a specific segment. This endpoint should be called after obtaining segment IDs from the Artist Segments endpoint. Supports pagination for large fan lists.

GET /api/segment/fans

cURL

cURL

curl --request GET \
  --url https://api.recoupable.com/api/segment/fans \
  --header 'x-api-key: <api-key>'

200

{
  "status": "success",
  "fans": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "username": "<string>",
      "avatar": "<string>",
      "profile_url": "<string>",
      "segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "segment_name": "<string>",
      "fan_social_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "region": "<string>",
      "bio": "<string>",
      "follower_count": 123,
      "following_count": 123,
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "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

segment_id · string<uuid> · required

The unique identifier of the segment to fetch fans 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

Segment fans retrieved successfully

status · enum<string> · required

Status of the request

Available options: success

fans · object[] · required

List of social profiles from fans in the segment

Show child attributes

pagination · object · required

Pagination metadata for the response

Show child attributes