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-4f8a-9a2e-1d2f3b4c5d6e",
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": "active",
12       "churnDate": "2024-01-15T09:30:00Z",
13       "vatNumber": "US123456789",
14       "metadata": {
15         "industry": "Manufacturing",
16         "accountManager": "Jane Doe"
17       },
18       "defaultCurrency": "USD",
19       "createdAt": "2023-11-01T08:00:00Z",
20       "updatedAt": "2024-04-10T12:15:00Z",
21       "billingAddress": {
22         "line1": "123 Elm Street",
23         "line2": "Suite 400",
24         "city": "Springfield",
25         "state": "IL",
26         "zipCode": "62704",
27         "country": "USA"
28       }
29     }
30   ],
31   "pagination": {
32     "limit": 10,
33     "offset": 0,
34     "total": 125,
35     "hasMore": true
36   }
37 }

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

Errors

400

Bad Request Error

403

Forbidden Error

500

Internal Server Error