List customers

This query gets a list of all of the customers in your account with their customer IDs so that you can later lookup individual customers. It doesn't return subscription information as this sits in the subscription elements, but it does retrieve the customer IDs, which you can then use to get subscription information in separate calls.

You can filter the results from this API by name (full or partial) but this is not a required field.

Customers are returned in pages. The first part of the results describes which page you're on, the total number of pages, the size of the page and how many rows are in the page. Then, each result is provided within the array.

Returned variables

Variable name

Description

customerId

The unique identifier of the customer in the Billsby platform

firstName

The customer's first name

lastName

The customer's last name

email

The customer's registered email address

createdOn

The date on which the customer account was created

status

The status of the customer; active or inactive

phoneNumber

The customers phone number

phoneNumberDialCode

The dial code of the customers phone number

phoneNumberCodeCountry

The country of the dial code of the customers phone number

billingAddress

The customers billing address

addressLine1

The first line of the customers address

addressLine2

The second line of the customers address

city

The city of the customers address

country

The country of the customers address

state

The state of the customers address

postCode

The post code of the customers address

Language
Authentication
Header
Click Try It! to start a request and see the response here!