For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Home Get API key

Documentation Integrations API Reference

Documentation Integrations API Reference

API Reference

Home Get API key

API Reference contacts

List Contacts

GET

https://api.agentphone.ai/v1/contacts

GET

/v1/contacts

1 const url = 'https://api.agentphone.ai/v1/contacts';
2 const options = {
3   method: 'GET',
4   headers: {Authorization: 'Bearer <token>', '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 }

1 {
2   "data": [
3     {
4       "id": "a3f1c9d2-7b4e-4f8a-9c2d-1e5b6f7a8c9d",
5       "phoneNumber": "+14155552671",
6       "name": "Jessica Taylor",
7       "createdAt": "2024-01-15T09:30:00Z",
8       "updatedAt": "2024-01-15T09:30:00Z",
9       "email": "jessica.taylor@example.com",
10       "notes": "Met at the tech conference in 2023."
11     }
12   ],
13   "hasMore": true,
14   "total": 1
15 }

List all contacts for this account.

Optional search query filters by name or phone number (case-insensitive contains).

Was this page helpful?

Create Contact

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

searchstring or nullOptional

limitintegerOptional<=200Defaults to 50

offsetintegerOptional>=0Defaults to 0

Response

Successful Response

datalist of objects

hasMoreboolean

totalinteger

Errors

422

Unprocessable Entity Error