Skip to main content
Resend Docs

Search documentation

Type to search this documentation.

Retrieve a list of contacts

GET/contactsRetrieve a list of contacts

Parameters

segment_idstringquery

Filter contacts by segment ID.

limitintegerquery

Number of items to return.

maximum 100 · minimum 1

afterstringquery

Return items after this cursor.

beforestringquery

Return items before this cursor.

Responses

200OKapplication/json
objectListContactsResponseSuccess
dataarray of object

Array containing contact information.

Show child attributes
Show array items
created_atstring · date-time

Timestamp indicating when the contact was created.

emailstring

Email address of the contact.

first_namestring

First name of the contact.

idstring

Unique identifier for the contact.

last_namestring

Last name of the contact.

unsubscribedboolean

Indicates if the contact is unsubscribed.

objectstring

Type of the response object.

Example response
{
  "data": [
    {
      "created_at": "2023-10-06T23:47:56.678Z",
      "email": "steve.wozniak@gmail.com",
      "first_name": "Steve",
      "id": "e169aa45-1ecf-4183-9955-b1499d5701d3",
      "last_name": "Wozniak",
      "unsubscribed": false
    }
  ],
  "object": "list"
}
Documentation menu