List customers

GET

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

GET

/api/v2/customers/

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.customers.listCustomers({});
8 }
9 main();

1 {
2   "data": [
3     {
4       "id": "c3f9a1d2-4b7e-4f3a-9a2e-8b6d7f9c1234",
5       "name": "Acme Corporation",
6       "legalName": "Acme Corporation Ltd.",
7       "email": "contact@acmecorp.com",
8       "phone": "+1-555-123-4567",
9       "website": "https://www.acmecorp.com",
10       "externalId": "ACME-2024-001",
11       "creationState": "draft",
12       "churnDate": "2024-01-15T09:30:00Z",
13       "vatNumber": "US123456789",
14       "metadata": {
15         "industry": "Manufacturing",
16         "accountManager": "jane.doe"
17       },
18       "createdAt": "2024-01-15T09:30:00Z",
19       "updatedAt": "2024-01-15T09:30:00Z",
20       "billingAddress": {
21         "line1": "123 Elm Street",
22         "line2": "Suite 400",
23         "city": "Springfield",
24         "state": "IL",
25         "zipCode": "62704",
26         "country": "USA"
27       }
28     }
29   ],
30   "pagination": {
31     "limit": 1,
32     "offset": 1,
33     "total": 1,
34     "hasMore": true
35   }
36 }

Get a list of customers 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