List customers

Lists contacts in the API key’s inbox. Custom properties are omitted from list results; read a single contact to get them. The x-helios-meta-count response header holds the total number of matches for paging.

GET/v1/customers

Query parameters

querystring

Search contacts by name or phone number.

phoneNumberstring

Exact match on an E.164 phone number. URL-encode the leading `+` as `%2B`.

emailstring

Exact match on email address.

limitinteger

Maximum number of results to return. Page through large result sets with `limit` and `offset`; 100 per page is a good default.

min 1

offsetinteger

Number of results to skip.

min 0 · default: 0

sortstring

Field to sort by. Prefix with `-` for descending order, for example `-createdAt`.

Responses

200Successful response

Array of Customer

idstring

orgstring

gymstring

The inbox the contact belongs to.

phoneNumberstring

E.164 phone number, unique within the inbox.

firstNamestring

lastNamestring

emailstring

optoutboolean

The contact opted out of texts. Helios will not text them.

emailOptoutboolean

The contact unsubscribed from email.

blockedboolean

sourcestring

How the contact was first created, for example `sms`, `form`, or `api`.

propertiesobject

Custom and integration properties. Returned when reading a single contact.

createdAtstring<date-time>

updatedAtstring<date-time>

Request

curl -X GET "https://api.sendhelios.com/v1/customers"

const response = await fetch("https://api.sendhelios.com/v1/customers", {
  method: "GET"
});

import requests

response = requests.get(
    "https://api.sendhelios.com/v1/customers",
)

Response

[
  {
    "id": "string",
    "org": "string",
    "gym": "string",
    "phoneNumber": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "optout": true,
    "emailOptout": true,
    "blocked": true,
    "source": "string",
    "properties": {},
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-01T00:00:00Z"
  }
]