Get contacts

GET

https://api.agentpaid.io/api/v1/contacts

GET

/api/v1/contacts

1 const url = 'https://api.agentpaid.io/api/v1/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 }

200Retrieved

1 [
2   {
3     "id": "c3f9a1d2-4b7e-4f8a-9a2e-1d2b3c4e5f6a",
4     "externalId": "EXT-20240601-001",
5     "organizationId": "org-789456123",
6     "customerId": "cust-123456789",
7     "customerExternalId": "CUST-EXT-987654",
8     "salutation": "Ms.",
9     "firstName": "Emily",
10     "lastName": "Johnson",
11     "email": "emily.johnson@example.com",
12     "phone": "+1-415-555-0198",
13     "billingStreet": "1234 Market St",
14     "billingCity": "San Francisco",
15     "billingStateProvince": "CA",
16     "billingCountry": "USA",
17     "billingPostalCode": "94103"
18   }
19 ]

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

Success response

idstring

externalIdstring

organizationIdstring

customerIdstring

customerExternalIdstring

salutationenum

firstNamestring

lastNamestring

emailstring

phonestring

billingStreetstring

billingCitystring

billingStateProvincestring

billingCountrystring

billingPostalCodestring