List customers

GET

/v1/customers

GET

/v1/customers

1 import { AfternoonClient } from "afternoon-sdk";
2 
3 async function main() {
4     const client = new AfternoonClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.customers.list({});
8 }
9 main();

1 {
2   "success": true,
3   "customers": [
4     {
5       "id": "cm5x9z8nv0000h85r7l9p2k1m",
6       "name": "Acme Corp",
7       "first_name": "Jane",
8       "last_name": "Doe",
9       "email": "jane@acme.com",
10       "phone": "+14155551234",
11       "url": "https://acme.com",
12       "external_id": "cust_ext_123",
13       "billing_address": {
14         "country": "US",
15         "state": "CA",
16         "city": "San Francisco",
17         "street": "123 Main St",
18         "street2": "Suite 100",
19         "zip": "94105"
20       },
21       "shipping_address": {
22         "country": "US",
23         "state": "CA",
24         "city": "San Francisco",
25         "street": "123 Main St",
26         "street2": "Suite 100",
27         "zip": "94105"
28       },
29       "created_at": "2024-01-15T10:30:00.000Z",
30       "updated_at": "2024-01-15T10:30:00.000Z"
31     }
32   ],
33   "pagination": {
34     "has_more": true,
35     "next_cursor": "cm5x9z8nv0000h85r7l9p2k1m"
36   },
37   "request_id": "req_abc123"
38 }

Returns a paginated list of customers for the authenticated company.

Authentication

AuthorizationBearer

API key obtained from the Afternoon dashboard

Query parameters

limitstringOptionalDefaults to 50

cursorstringOptional

Response

Customers list

successboolean

customerslist of objects

paginationobject

request_idstring

Errors

401

Unauthorized Error

500

Internal Server Error