API · Contacts

List Contacts

List contacts for your team (requires full access).

GET/contactsFull access

Request parameters

Parameter	Type	Description
`limit` query · optional	`integer` 1–100 Default: 20	Number of results to return. See Pagination.
`after` query · optional	`string`	Resource ID for the next page. Cannot be combined with before. See Pagination.
`before` query · optional	`string`	Resource ID for the previous page. Cannot be combined with after. See Pagination.
`segment_id` query · optional	`string`	Restrict to segment memberships, newest membership first.

Request example

Set OPENSEND_BASE_URL=https://api.example.com and OPENSEND_API_KEY=os_replace_me on your server.

bash

curl -X GET "$OPENSEND_BASE_URL/contacts" \
  -H "Authorization: Bearer $OPENSEND_API_KEY"

Response

200 · application/json. Example IDs stand for IDs returned by your installation.

json

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "id": "YOUR_ID",
      "email": "you@example.net",
      "first_name": "example",
      "last_name": "example",
      "created_at": "example",
      "unsubscribed": false
    }
  ]
}

Behavior and errors

Rows contain id, email, first_name, last_name, created_at, and unsubscribed; retrieve a contact to read its properties. Add segment_id to list one segment’s members, newest membership first.

Use a full-access credential. List responses are newest first; use has_more and cursor IDs to continue. Resource IDs belong to your team; an unknown or foreign resource returns 404. See authentication, errors, rate limits, and compatibility for the shared contract.