Retrieve a customer

GET

/v1/customers/:id

GET

/v1/customers/:id

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.get("cm5x9z8nv0000h85r7l9p2k1m");
8 }
9 main();

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

Fetches a customer by their ID.

Authentication

AuthorizationBearer

API key obtained from the Afternoon dashboard

Path parameters

idstringRequiredformat: "cuid"

Response

Customer found

successboolean

customerobject

request_idstring

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error