Skip to main content
GET
/
api
/
v1
/
contacts
List all Contact Lists
curl --request GET \
  --url https://api.example.com/api/v1/contacts/
{
  "data": [
    {
      "uid": "<string>",
      "workspace_id": 123,
      "name": "<string>",
      "created_on": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "source": "<string>",
      "available_columns": "<unknown>",
      "has_unsubscribe_column": true,
      "unsubscribe_column_name": "<string>"
    }
  ],
  "total": 123
}

Query Parameters

​
limit
integer
required

Number of results to fetch (min: 1, max: 100, default: 100)

​
offset
integer
required

Starting index for fetching data (min: 0, default: 0)

​
workspace_id
integer

ID of the workspace whose contact lists to fetch. All workspaces for this user account are considered if not provided.

Response

Success

​
data
object[]
required
​
total
integer
required