RelayAPI

List contacts with filtering and pagination

GET
/v1/contacts
AuthorizationBearer <token>

API key (rlay_live_* or rlay_test_*)

In: header

Query Parameters

workspace_id?string

Filter by workspace ID

search?string

Search by name, phone, or email

tag?string

Filter by tag

segment_id?string

Filter by static segment membership

platform?string

Filter by platform

account_id?string

Filter by social account ID

cursor?string

Pagination cursor

limit?integer

Number of items

Range1 <= value <= 100
Default20

Response Body

application/json

curl -X GET "https://example.com/v1/contacts"
{  "data": [    {      "id": "string",      "name": "string",      "email": "string",      "phone": "string",      "tags": [        "string"      ],      "opted_in": true,      "channels": [        {          "id": "string",          "social_account_id": "string",          "platform": "string",          "identifier": "string",          "created_at": "2019-08-24T14:15:22Z"        }      ],      "segment_ids": [        "string"      ],      "metadata": {        "property1": null,        "property2": null      },      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string",  "has_more": true}

Found something wrong? Help us improve this page.

Submit an Issue
Requires a GitHub account.View repo