List contacts

If you have questions regarding this API, please visit our API FAQ page.

Listing contacts

Make a GET request to https://webapi.inboxroad.com/api/v2/contacts-lists/{blueprint_id}/contacts/ with a valid X-API-Key.

curl -X GET 'https://webapi.inboxroad.com/api/v2/contacts-lists/{blueprint_id}/contacts/' \
  -H 'X-API-Key: <your_token>' \
  -H 'Content-Type: application/json'

Path parameters

Param name	Description
blueprint_id	Unique identifier of the contacts list (UUID).

Response fields

Field name	Description
pagination	Pagination metadata for the results.
contacts	List of contact records.

Contact record

Custom fields

A contact’s keys depend on the list’s field schema. Alongside the always-present defaults below, a list may define an arbitrary number of custom fields, which appear as additional keys on every contact. Use Get contact list to discover the full set of fields for a list.

Default keys present on every contact:

Field name	Description
id	Unique identifier of the contact (integer).
email	Email address of the contact.
first_name	First name of the contact.
last_name	Last name of the contact.
status	Subscription status (subscribed or unsubscribed).
created_at	Date and time the contact was created.

Example response

{
  "pagination": {
    "page": 1,
    "page_size": 25,
    "total_count": 150,
    "total_pages": 6
  },
  "contacts": [
    {
      "id": 4821,
      "email": "john.doe@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "status": "subscribed",
      "created_at": "2026-05-21T09:45:00Z",
      "plan": "pro"
    }
  ]
}

In the example above, plan is a custom field defined on the list.

Query parameters

Param name	Possible values	Description
page	Integer	1-based page number. Default 1.
page_size	Integer	Number of contacts per page. Default 25.
search	String	Keyword search across the list’s text fields.

For example:

curl -X GET 'https://webapi.inboxroad.com/api/v2/contacts-lists/{blueprint_id}/contacts/?page=2&page_size=25&search=john' \
  -H 'X-API-Key: <your_token>' \
  -H 'Content-Type: application/json'

Pagination

Field name	Description
page	Current page number.
page_size	Number of results per page.
total_count	Total number of contacts.
total_pages	Total number of available pages.