Identity API
Updated over a week ago

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


x-api-key: api_key

Replace api_key with your API Key.

Query Parameters

  • startDate - Optional start date in formats YYYY-MM-DD or MM-DD-YYYY

  • endDate - Optional end date in formats YYYY-MM-DD or MM-DD-YYYY

  • includeInactive - The default value of this is false, which results in only those users with a subscribeState of 2 being returned (subscribed users). Set this value to true if you'd like to return all user states. All subscribeStates are as follows:

    • 1 = New users

    • 2 = Subscribed Users

    • 3 = Unsubscribed Users

    • 4 = Resubscribed Users

    • 5 = Users with InvalidCountry

    • 6 = Users with InvalidNumber

    • 7 = Users with AdminChanged

Example Response

[     {        "phone": "+15555555555",        "dateSubscribed": "2020-10-21T03:52:52.897224",        "dateLastPurchase": "2020-10-25T01:25:06.860539",        "subscribeState": 2,        "optinCampaignId": "4105",        "campaignTitle": "MercerMain Demo",        "campaignDateCreated": "2020-09-28T22:47:18.467791"    }]

If you have any additional questions please contact us at [email protected].

Did this answer your question?