Markit Docs

The Contacts resource allows you to retrieve contacts on your account. The following actions can be performed on this resource:

Retrieve All Contacts
Retrieve a Single Contact

Retrieve All Contacts

Retrieves all contacts on your account.

    GET https://api.markitai.com/v1/contacts

You can include additional parameters in the request as described in the Query Parameters section. For instance, the request below will return contacts with a status of "Subscribed".

    GET https://api.markitai.com/v1/contacts?status=Subscribed

Available query parameters:

limit: 20 (default)
offset: 0 (default)
status: ‘Subscribed’, ‘Unsubscribed’, ‘Invalid’, ‘Removed’ (default: 'All')
createdAt: ‘desc’ | ‘asc’ (default: ‘desc’)

Example Response:

{
  "data": [
    {
      "uid": "abc123",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "followType": "Profile",
      "followSourceType": "Desktop Webapp",
      "eventId": "",
      "complianceMessageSent": true,
      "complianceOptInOnMarkit": "2024-01-01T00:00:00.000Z",
      "spreadsheetData": {
        "fileId": "",
        "fileName": "",
        "status": "",
        "uploadFullName": ""
      },
      "phoneNumber": "+12345678910",
      "status": "Subscribed",
      "invalidErrorCode": 0,
      "messageFailureCount": 0,
      "membershipPlanId": "free",
      "membershipState": "Inactive",
      "membershipPromoCodeId": "",
      "discountEndDate": "",
      "groupOwnerPromoCodeId": "",
      "fullName": "John Doe",
      "profilePicURL": "https://firebasestorage.googleapis.com..."
    },
    {
      "uid": "123abc",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "followType": "Profile",
      "followSourceType": "Desktop Webapp",
      "eventId": "",
      "complianceMessageSent": true,
      "complianceOptInOnMarkit": "2024-01-01T00:00:00.000Z",
      "spreadsheetData": {
        "fileId": "",
        "fileName": "",
        "status": "",
        "uploadFullName": ""
      },
      "phoneNumber": "+19876543210",
      "status": "Unsubscribed",
      "invalidErrorCode": 0,
      "messageFailureCount": 0,
      "membershipPlanId": "free",
      "membershipState": "Inactive",
      "membershipPromoCodeId": "",
      "discountEndDate": "",
      "groupOwnerPromoCodeId": "",
      "fullName": "Mike",
      "profilePicURL": "https://firebasestorage.googleapis.com..."
    }
  ],
  "pagingData": {
    "prevPage": null,
    "currentPage": null,
    "nextPage": null,
    "currentPageString": null,
    "hasMore": false
  }
}

Retrieve a Single Contact

Retrieves a single contact with the contact ID equal to {id}.

    GET https://api.markitai.com/v1/contacts/{id}

Example Response:

{
  "follower": {
    "uid": "abc123",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "followType": "Profile",
    "followSourceType": "Desktop Webapp",
    "eventId": "",
    "complianceMessageSent": true,
    "complianceOptInOnMarkit": "2024-01-01T00:00:00.000Z",
    "spreadsheetData": {
      "fileId": "",
      "fileName": "",
      "status": "",
      "uploadFullName": ""
    },
    "phoneNumber": "+12345678910",
    "status": "Subscribed",
    "invalidErrorCode": 0,
    "messageFailureCount": 0,
    "membershipPlanId": "free",
    "membershipState": "Inactive",
    "membershipPromoCodeId": "",
    "discountEndDate": "",
    "groupOwnerPromoCodeId": "",
    "fullName": "John Doe",
    "profilePicURL": "https://firebasestorage.googleapis.com…",
    "formResponses": [
        {
          "id": "111111",
          "questionId": "222222",
          "lastResponded": "2024-01-01T00:00:00.000Z",
          "eventId": "123123",
          "responses": ["john@gmail.com"]
        },
        ...
    ]
  }
}

Contacts

Retrieve All Contacts

Retrieve a Single Contact

On this page