Skip to main content
GET
/
subscribers
List subscribers
curl --request GET \
  --url https://api.onset.io/v1/subscribers \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "email": "jsmith@example.com",
    "lists": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.onset.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
offset
integer
default:0

Number of items to skip

Required range: 0 <= x <= 1000
​
limit
integer
default:10

Maximum number of items to return

Required range: 1 <= x <= 100

Response

List of subscribers retrieved successfully

​
id
string

Unique subscriber identifier

​
email
string<email>

Subscriber email address

​
lists
object[]

Lists the subscriber belongs to

​
created_at
string<date-time>

When the subscriber was created

​
updated_at
string<date-time>

When the subscriber was last updated