SUsurgeapi
Contacts

Retrieve a contact

Changed on

Retrieves a Contact object.

get/contacts/{id}

Request

  • Base URL
    https://api.surge.app
  • URL
    https://api.surge.app/contacts/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The ID of the contact to retrieve.

Example:ctc_01j9dy8mdzfn3r0e8x1tbdrdrf

Response

Contact

emailstring email

The contact's email address.

first_namestring

The contact's first name.

idstring required

Unique identifier for the object.

last_namestring

The contact's last name.

metadataMetadata

Set of key-value pairs that will be stored with the object.

outbound_disabledboolean

Whether outbound messaging has been manually disabled for the contact.

phone_numberstring phone-number required

The contact's phone number in E.164 format.

Example response

{
  "email": "dom@toretto.family",
  "first_name": "Dominic",
  "id": "ctc_01j9dy8mdzfn3r0e8x1tbdrdrf",
  "last_name": "Toretto",
  "metadata": {
    "car": "1970 Dodge Charger R/T"
  },
  "outbound_disabled": false,
  "phone_number": "+18015551234"
}

Changes