← Back to listing
GET/api/v1/contacts/{id}

Get Contact by ID

Get a contact by ID.

Authentication

Send your API key in the x-api-key header.

x-api-keybearer

Parameters

idrequired

path · string

Contact ID to retrieve.

Responses

200

PublicApiGetContactByIdResponseDto

statusCoderequired

number

countrequired

number

errorrequired

string

datarequired

PublicApiContactDto

Example response

json
{
  "statusCode": 200,
  "count": 0,
  "error": null,
  "data": {
    "id": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "firstName": "John",
    "lastName": "Doe",
    "salutation": "Mr.",
    "birthday": "1990-01-15T00:00:00.000Z",
    "email": "john.doe@example.com",
    "phone": "+1-555-123-4567",
    "genderIdentity": "Male",
    "pronouns": "he/him",
    "fax": "+1-555-123-4568",
    "linkedinUrl": "https://linkedin.com/in/johndoe",
    "address": "123 Main Street",
    "postalCode": "12345",
    "city": "New York",
    "state": "NY",
    "country": "United States",
    "currency": "USD",
    "titlePosition": "Software Engineer",
    "language": "English",
    "assistant": "Jane Smith",
    "assistantPhone": "+1-555-123-4569",
    "division": "Engineering",
    "department": "Software Development",
    "description": "Senior software engineer with 5 years of experience",
    "leadSource": "Website",
    "leadRecordType": "Lead",
    "reportsTo": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "createdAt": "2024-01-15T10:00:00.000Z",
    "updatedAt": "2024-01-15T10:00:00.000Z",
    "personId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d"
  }
}
401Unauthorized - missing or invalid API key or Bearer token