List Contacts

GET

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

List all contacts for this account.

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

AuthorizationBearer

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

searchstring or nullOptional

limitintegerOptional<=200Defaults to 50

offsetintegerOptional>=0Defaults to 0

Successful Response

datalist of objects

hasMoreboolean

totalinteger

422

Unprocessable Entity Error

1	import { AgentPhoneClient } from "agentphone";
2
3	async function main() {
4	const client = new AgentPhoneClient({
5	token: "YOUR_TOKEN_HERE",
6	});
7	await client.contacts.listContacts({});
8	}
9	main();

1	{
2	"data": [
3	{
4	"id": "a3f1c9d2-7b4e-4f8a-9d3e-2b5f6c7d8e9f",
5	"phoneNumber": "+14155552671",
6	"name": "Jessica Thompson",
7	"createdAt": "2024-01-15T09:30:00Z",
8	"updatedAt": "2024-01-15T09:30:00Z",
9	"email": "[email protected]",
10	"notes": "Met at the conference in March 2024."
11	}
12	],
13	"hasMore": true,
14	"total": 1
15	}