Get Contacts

GET 
/v1/contacts

Get Contacts

Request

Query Parameters

maxResults number

Possible values: >= 1 and <= 100

Default value: 50

page number

Default value: 1

type string

Possible values: [unsubscribed, active, bounced]

filters type of contact

search string

search string which will search all the properties of a contact for a matching value

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

contacts

object[]

Array [

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

phone string

Phone number of the contact

mobile string

Mobile number of the contact

jobTitle string

Job Title of the contact

]

hasNextPage booleanrequired

Example (from schema)

{
  "contacts": [
    {
      "id": 0,
      "name": "Jane Doe",
      "email": "[email protected]",
      "active": true,
      "unsubscribed": false,
      "phone": "91234567833",
      "mobile": "1653452783",
      "jobTitle": "Manager"
    }
  ],
  "hasNextPage": "false"
}

Loading...