Retrieve contacts

GET

contacts

curl --request GET \
  --url https://api.indiepitcher.com/v1/contacts \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "data": [
    {
      "email": "john@acme.com",
      "userId": 123456,
      "name": "John Doe",
      "avatarUrl": "https://example.com/profile_pictures/123456",
      "languageCode": "en-US",
      "hardBouncedAt": "2024-04-23T18:25:43.511Z",
      "subscribedToLists": [
        "onboarding",
        "newsletter"
      ],
      "customProperties": {
        "company": "Acme",
        "age": 35
      }
    }
  ],
  "metadata": {
    "page": 1,
    "per": 10,
    "total": 1023
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page

integer

default:1

Page to fetch, the first page has index 1.

per

integer

default:10

How many contacts to return per page.

Response

200 - application/json

A paginated list of contacts

success

boolean

data

object[]

data.email

string

required

The email of the contact.

Example:

"john@acme.com"

data.userId

string

The user id of the contact.

Example:

123456

data.name

string

The full name of the contact

Example:

"John Doe"

data.avatarUrl

string

The avatar url of the contact

Example:

"https://example.com/profile_pictures/123456"

data.languageCode

string

The primary language language of this contact, represented by a language code.

Example:

"en-US"

data.hardBouncedAt

string

The date when an attempt to send an email to the contact failed with a hard bounce, meaning the email address is invalid and no further emails will be send to this contact. You can reset this in the dashboard to re-enable sending emails to this contact.

Example:

"2024-04-23T18:25:43.511Z"

data.subscribedToLists

string[]

The array of mailing lists the contact is subscribed to.

Example:

["onboarding", "newsletter"]

data.customProperties

object

The custom properties set for this contact.

Example:

{ "company": "Acme", "age": 35 }

metadata

object

Send an email to registered contacts in a mailing list.Find a contact

curl --request GET \
  --url https://api.indiepitcher.com/v1/contacts \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "data": [
    {
      "email": "john@acme.com",
      "userId": 123456,
      "name": "John Doe",
      "avatarUrl": "https://example.com/profile_pictures/123456",
      "languageCode": "en-US",
      "hardBouncedAt": "2024-04-23T18:25:43.511Z",
      "subscribedToLists": [
        "onboarding",
        "newsletter"
      ],
      "customProperties": {
        "company": "Acme",
        "age": 35
      }
    }
  ],
  "metadata": {
    "page": 1,
    "per": 10,
    "total": 1023
  }
}

API Documentation

Email

Contacts

Mailing Lists

Authorizations

Query Parameters

Response