GET
/
contacts
curl --request GET \
  --url https://api.indiepitcher.com/v1/contacts
{
  "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
  }
}

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[]
​
metadata
object
Send an email to registered contacts in a mailing list.Add a new contact