List contacts

GET

https://api.agentpaid.io/api/v2/contacts/

GET

/api/v2/contacts/

1 import { PaidClient } from "@paid-ai/paid-node";
2 
3 async function main() {
4     const client = new PaidClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.contacts.listContacts({});
8 }
9 main();

1 {
2   "data": [
3     {
4       "id": "c3f1a9d2-8b4e-4f7a-9d3e-2a1b5f6c7d8e",
5       "customerId": "cust-987654321",
6       "firstName": "Emily",
7       "lastName": "Johnson",
8       "email": "emily.johnson@example.com",
9       "phone": "+1-555-123-4567",
10       "externalId": "ext-456789",
11       "createdAt": "2024-01-15T09:30:00Z",
12       "updatedAt": "2024-01-15T09:30:00Z",
13       "billingAddress": {
14         "street": "123 Maple Avenue",
15         "city": "Springfield",
16         "state": "IL",
17         "country": "USA",
18         "zipCode": "62704"
19       }
20     }
21   ],
22   "pagination": {
23     "limit": 1,
24     "offset": 1,
25     "total": 1,
26     "hasMore": true
27   }
28 }

Get a list of contacts for the organization

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Query parameters

limitintegerOptional1-100Defaults to 10

offsetintegerOptional

Response

200

datalist of objects

paginationobject

Authentication

Query parameters

Response

Errors