Skip to main content

Get Contact

Returns a single CRM contact by ID.

GET /v1/funnels/{funnelId}/contacts/{contactId}

Authentication​

Requires the x-perspective-api-key header. See Authentication for details.

Path parameters​

NameTypeRequiredDescription
funnelIdstringYesThe ID of the funnel the contact belongs to.
contactIdstringYesThe ID of the contact to retrieve: the id of a contact from List Contacts, or the contactId field of a New Lead webhook.

:::note Webhook IDs The New Lead webhook carries two IDs. contactId is the contact ID this endpoint accepts. id identifies the visitor's funnel session, not the contact, so looking it up here returns 404. contactId is null when the contact was not ready in the CRM by the time the webhook was sent. :::

Example request​

curl https://api.perspective.co/v1/funnels/fnl_abc123/contacts/cnt_abc123 \
-H "x-perspective-api-key: $PERSPECTIVE_API_KEY"

Response​

Returns { data: Contact }. See the Contact object for a full description of every field.

Example response​

{
"data": {
"id": "cnt_abc123",
"status": "lead",
"email": "jane.doe@example.com",
"phone": "+49151234567890",
"firstName": "Jane",
"lastName": "Doe",
"name": "Jane Doe",
"website": "https://janedoe.com",
"birthday": "1990-06-15",
"address": {
"postalCode": "10115",
"city": "Berlin",
"state": "Berlin",
"country": "DE",
"street": "Unter den Linden",
"houseNumber": "1"
},
"meta": {
"ps_timezone": "Europe/Berlin",
"ps_converted_at": "2025-05-01T14:32:00.000Z",
"ps_first_seen_at": "2025-05-01T14:30:00.000Z",
"ps_last_seen_at": "2025-05-02T09:15:00.000Z",
"ps_source": "funnel",
"ps_start_slug": "start",
"ps_end_slug": "result",
"ps_email_verified": true,
"ps_embed": false
},
"utmParams": {
"utm_source": "google",
"utm_medium": "cpc",
"utm_campaign": "spring-launch"
},
"properties": {
"quiz_answer": "Option A",
"score": 42
}
}
}

Errors​

See Errors for the full list of status codes and handling guidance.

StatusMeaning
400Missing or invalid funnelId or contactId.
401Missing or invalid API key.
403Your API key does not have crm:read permission.
404No contact with this contactId exists in the funnel.
500Internal server error.