Get contact

GET 
/v1/contacts/:id

Get contact

Request

Path Parameters

id numberrequired

contact id of a particular contact

Header Parameters

authorization stringrequired

Possible values: Value must match regular expression /Bearer [^\s]+/

Default value: Bearer <Token>

Custom Token generated from the App

Responses

200

Successful

*/*

Schema

Schema

id numberrequired

ID of the contact

name string

Full Name of contact

email string

Email of contact

active booleanrequired

if true, indicates the contact will actively receive email and sms shares

unsubscribed booleanrequired

if true, indicates that the contact is unsubscribed from receiving emails

unsubscribed_at daterequired

when the contact has unsubscribed

phone string

Phone number of the contact

mobile string

Mobile number of the contact

jobTitle string

Job Title of the contact

list

object[]

List of Labels the contact has to be added into

Array [

id numberrequired

ID of the Label

name stringrequired

Name of the label

]

Example (from schema)

{
  "id": 0,
  "name": "Jane Doe",
  "email": "[email protected]",
  "active": true,
  "unsubscribed": false,
  "unsubscribed_at": "2023-08-28 12:26:56.899+05:30",
  "phone": "91234567833",
  "mobile": "1653452783",
  "jobTitle": "Manager",
  "list": [
    {
      "id": 1,
      "name": "list1"
    },
    {
      "id": 2,
      "name": "list2"
    }
  ]
}

Loading...