Get a contact

GET/v1/contacts/{id}

Secret key — sk_… or sk_test_… · Base URL https://api.volanea.com

One contact by id: identity, subscription state, locale, and the custom data object.

This is the record, not the history. For what the contact was sent and what they did with it, use GET /v1/contacts/{id}/timeline.

Path parameters

  • idstringrequired

    Contact id.

Response

200 · Contact

  • contactIdstringrequired
  • projectIdstring
  • emailemailrequired
  • firstNamestring | null
  • lastNamestring | null
  • subscribedbooleanrequired
  • dataobject | null

    Arbitrary custom fields.

  • localestring | null
  • createdAtdate-timerequired
  • updatedAtdate-timerequired

Errors

Every failure returns the standard envelope — branch on `code`, never on the wording of `error`.

  • 401Missing or invalid API key.
  • 404Not found.
  • 422Request validation failed (code `validation_error`, 422).

Request

curl https://api.volanea.com/v1/contacts/id_123 \
  -H "Authorization: Bearer sk_..."

Response

200 · application/json

{
  "success": true,
  "data": {
    "contactId": "con_5e90",
    "projectId": "<projectId>",
    "email": "ada@example.com",
    "firstName": "Ada",
    "lastName": "Lovelace",
    "subscribed": true,
    "data": {},
    "locale": "en",
    "createdAt": "2026-01-01T09:00:00.000Z",
    "updatedAt": "2026-01-01T09:00:00.000Z"
  }
}

92 endpoints · OpenAPI document