Sign in

v1

latestOpenAPI 3.0.02026-07-2664192238.8 KB
Contacts

Get contact

Returns the contact with the specified ID.

Scopes: contacts.read

get/contacts/{id}

Path parameters

idstring required

Contact ID

Headers

Omnisend-Versionstring required

API version that specifies the response format and behaviour

Response

OK

addressstring

Contact Street, house number, apartment number

birthdatestring

Contact birthdate in YYYY-MM-DD format

citystring

Contact city

countrystring

Contact country name

countryCodestring

ISO 3166-1 alpha-2 country code

createdAtstring

Contact creation timestamp (read-only)

customPropertiesobject

Custom contact properties defined for the brand

emailstring

Primary email address derived from the email identifier (read-only)

firstNamestring

Contact first name

gender'm' | 'f'

Contact gender

idstring

Contact unique identifier (read-only)

lastNamestring

Contact last name

phonestring[]

Phone numbers derived from phone identifiers (read-only)

postalCodestring

Contact postal or ZIP code

segmentsstring[]

IDs of segments the contact belongs to (read-only)

statestring

State or province name

status'subscribed' | 'unsubscribed' | 'nonSubscribed'

Email channel subscription status derived from the primary email identifier (read-only)

tagsstring[]

Labels assigned to the contact

updatedAtstring

Contact last updated timestamp (read-only)

Example response

{
  "address": "1234 Main St",
  "birthdate": "1990-01-01",
  "city": "Los Angeles",
  "consents": [
    {
      "channel": "email",
      "createdAt": "2021-05-20T12:00:00Z",
      "ip": "161.1.1.1",
      "source": "api",
      "userAgent": "Mozilla/5.0"
    }
  ],
  "country": "United States",
  "countryCode": "US",
  "createdAt": "2021-05-20T12:00:00Z",
  "email": "example@example.com",
  "firstName": "John",
  "gender": "m",
  "id": "60a6170920d91c215e949b5c",
  "identifiers": [
    {
      "id": "example@example.com",
      "type": "email"
    }
  ],
  "lastName": "Doe",
  "optIns": [
    {
      "channel": "email",
      "optInAt": "2021-05-20T12:00:00Z"
    }
  ],
  "phone": [
    "+1234567890"
  ],
  "postalCode": "90001",
  "state": "New York",
  "status": "subscribed",
  "statuses": [
    {
      "channel": "email",
      "status": "subscribed",
      "statusChangedAt": "2021-05-20T12:00:00Z"
    }
  ],
  "tags": [
    "tag1",
    "tag2",
    "tag3"
  ],
  "updatedAt": "2021-05-20T12:30:00Z"
}