List a list's members

GET

/api/v2/flare/contact-lists/{id}/contacts

curl --request GET \
  --url 'https://api.sipstack.com/api/v2/flare/contact-lists/example/contacts?page=1&limit=50' \
  --header 'x-api-key: <x-api-key>'

import requests

url = "https://api.sipstack.com/api/v2/flare/contact-lists/example/contacts"

querystring = {"page":"1","limit":"50"}

headers = {"x-api-key": "<x-api-key>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())

const url = 'https://api.sipstack.com/api/v2/flare/contact-lists/example/contacts?page=1&limit=50';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

import axios from 'axios';

const options = {
  method: 'GET',
  url: 'https://api.sipstack.com/api/v2/flare/contact-lists/example/contacts',
  params: {page: '1', limit: '50'},
  headers: {'x-api-key': '<x-api-key>'}
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

Returns the contacts in a list, most-recently-added first. Requires contacts:read. 404 when the list isn’t your organization’s.

Authorizations

apiKeyAuth

Parameters

Path Parameters

required

string

Query Parameters

page

integer

default: 1 >= 1

limit

integer

default: 50 <= 100

Responses

200

Paginated membership list.

application/json

object

success

boolean

data

Array<object>

A contact as returned by the list-membership endpoint.

object

string format: uuid

uuid

string format: uuid

first_name

string

nullable

last_name

string

nullable

phone_number

string

email

string

nullable

consent_status

string

Allowed values: implied express none

opted_out_at

string format: date-time

nullable

added_at

When the contact was added to this list.

string format: date-time

pagination

object

page

integer

limit

integer

total

integer

totalPages

integer

Examples

members

First page of list members

{
  "success": true,
  "data": [
    {
      "id": "1f2e6b7c-8a90-4c1d-9e2f-0a1b2c3d4e5f",
      "uuid": "1f2e6b7c-8a90-4c1d-9e2f-0a1b2c3d4e5f",
      "first_name": "Jordan",
      "last_name": "Lee",
      "phone_number": "+14165550100",
      "email": "jordan.lee@example.com",
      "consent_status": "express",
      "opted_out_at": null,
      "added_at": "2026-01-12T15:45:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 128,
    "totalPages": 3
  }
}

401

Missing or invalid API key.

application/json

Inline error shape used by the messaging API and management endpoints.

object

success

boolean

error

string

Example

{
  "success": false,
  "error": "Recipient phone number (to) is required"
}

404

List not found in your organization.

application/json

Inline error shape used by the messaging API and management endpoints.

object

success

boolean

error

string

Example

{
  "success": false,
  "error": "Recipient phone number (to) is required"
}