Get contact by external ID

GET

https://api.agentpaid.io/api/v2/contacts/external/:externalId

Get a contact by its external ID

AuthorizationBearer

API Key authentication using Bearer token

externalIdstringRequired

200

idstring

customerIdstring

firstNamestring

lastNamestring

emailstring

phonestring or null

externalIdstring or null

createdAtdatetime

updatedAtdatetime

billingAddressobject or null

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.contacts.getContactByExternalId("externalId");
8	}
9	main();

1	{
2	"id": "c3f1a9d2-8b4e-4f7a-9d3e-2a1b5c6d7e8f",
3	"customerId": "a7b8c9d0-e1f2-3456-7890-abcd1234ef56",
4	"firstName": "Emily",
5	"lastName": "Johnson",
6	"email": "emily.johnson@example.com",
7	"phone": "+1-555-123-4567",
8	"externalId": "ext-987654321",
9	"createdAt": "2024-01-15T09:30:00Z",
10	"updatedAt": "2024-01-15T09:30:00Z",
11	"billingAddress": {
12	"street": "123 Maple Avenue",
13	"city": "Springfield",
14	"state": "IL",
15	"country": "USA",
16	"zipCode": "62704"
17	}
18	}