Identity API

The Identity API is used to get a list of Voyage subscribers as well as full profile of specific subscribers.

Identity API Overview

This API is organized around REST. The API endpoints were designed to be predictable and resource-oriented and use HTTP response codes to indicate API errors. This means a single resource or endpoint can and often does provide different functionality based on the HTTP verb used to access it. JSON is returned in all responses from the API, including errors.

You will need your Voyage API Key in order to call the Identity API.

Getting All Subscribers via API

This API Endpoint will return a list of all subscribers as an array. You can pass optional query parameters for specifying subscribers based on a subscribed date range.

HTTP Request




Replace api_key with your API Key.

Query Parameters

  • startDate - Optional start date.

  • endDate - Optional end date.

  • includeInactive - Optional user states. All possible value is listed bellow:

    true = Return all users states,

New = 1, Subscribed = 2, Unsubscribed = 3, Resubscribed = 4, InvalidCountry = 5, InvalidNumber = 6, AdminChanged = 7

Default value : false

Example Response

"phone": "string",
"dateSubscribed": "2019-10-24T12:04:58.308Z",
"dateLastPurchase": "2019-10-24T12:04:58.308Z",
"subscribeState": 0