List a customer's contacts

GET

https://my.pivotal.app/api/v1/customers/:customerId/contacts

GET

/api/v1/customers/:customerId/contacts

1 const url = 'https://my.pivotal.app/api/v1/customers/42/contacts';
2 const options = {
3   method: 'GET',
4   headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5   body: '{}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

1 {
2   "object": "list",
3   "data": [
4     {
5       "object": "contact",
6       "id": "c123e456-7890-4b12-a345-6789d0123ef4",
7       "display_id": 1,
8       "customer_id": "cust-42",
9       "name": "Jane Doe",
10       "email": "jane.doe@example.com",
11       "title": "Chief Technology Officer",
12       "is_primary": true,
13       "labels": [
14         "executive",
15         "decision-maker"
16       ],
17       "created_at": "2024-01-15T09:30:00Z",
18       "updated_at": "2024-04-10T14:45:00Z"
19     },
20     {
21       "object": "contact",
22       "id": "c987f654-3210-4b12-b678-1234a5678b90",
23       "display_id": 2,
24       "customer_id": "cust-42",
25       "name": "Mark Spencer",
26       "email": "mark.spencer@example.com",
27       "title": "Lead Developer",
28       "is_primary": false,
29       "labels": [
30         "technical",
31         "stakeholder"
32       ],
33       "created_at": "2024-03-20T11:15:00Z",
34       "updated_at": "2024-04-12T08:20:00Z"
35     }
36   ]
37 }

Primary contact first, then most recently created.

Authentication

AuthorizationBearer

Send your key in the Authorization header. Keys start with pivotal_ (production) or pivotal_test_ (test mode, no side effects on integrations). Rotate keys from /admin/api-keys — old keys 401 instantly when revoked.

Path parameters

customerIdstringRequired

Numeric display_id or cuid of the parent customer.

Response

objectenum

datalist of objects

Errors

401

Unauthorized Error

404

Not Found Error