List all contacts with optional search filtering.

GET

https://host.com/v1/contacts

GET

/v1/contacts

1 const url = 'https://host.com/v1/contacts';
2 const options = {
3   method: 'GET',
4   headers: {'X-API-Key': '<apiKey>', 'Content-Type': 'application/json'},
5   body: '{}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

200Retrieved

1 {
2   "data": [
3     {
4       "id": "string",
5       "status": "string",
6       "firstName": "string",
7       "lastName": "string",
8       "emails": [
9         "string"
10       ],
11       "phoneNumbers": [
12         {
13           "number": "string",
14           "type": "home"
15         }
16       ],
17       "businessName": "string",
18       "source": "string",
19       "additionalData": {},
20       "contactListIds": [
21         "string"
22       ]
23     }
24   ],
25   "total": 1,
26   "page": 1,
27   "size": 1,
28   "pages": 1
29 }

Authentication

X-API-Keystring

API Key authentication. Generate your API key in the Gail Portal under General > Integrations > API Keys.

Query parameters

searchstringOptional

Optional search term to filter contacts by name, phone, or email.

afterstringOptionalformat: "uuid"

A GUID cursor to fetch items strictly after this ID.

beforestringOptionalformat: "uuid"

A GUID cursor to fetch items strictly before this ID.

limitintegerOptionalDefaults to 50

Maximum number of items to retrieve (default 50).

pageintegerOptionalDefaults to 1Deprecated

The page number (1-based).

sizeintegerOptionalDefaults to 50Deprecated

Number of items per page (default 50).

Request

Pagination parameters.

Response

datalist of objects or nullOptional

totalinteger or nullOptional

pageinteger or nullOptional

sizeinteger or nullOptional

pagesinteger or nullOptional