Subscribers

Subscriber management operations

List subscribers

get

Retrieve a list of subscribers

Authorizations
Query parameters
offsetinteger · max: 1000Optional

Number of items to skip

Default: 0
limitinteger · min: 1 · max: 100Optional

Maximum number of items to return

Default: 10
Responses
200

List of subscribers retrieved successfully

application/json
get
GET /v1/subscribers HTTP/1.1
Host: api.onset.com
Authorization: Bearer JWT
Accept: */*

[
  {
    "id": "text",
    "email": "[email protected]",
    "lists": [
      {
        "id": "text",
        "name": "text"
      }
    ],
    "created_at": "2025-09-12T16:33:51.584Z",
    "updated_at": "2025-09-12T16:33:51.584Z"
  }
]

Create a new subscriber

post

Create a new subscriber in the workspace

Authorizations
Body
emailstring · emailRequired

Subscriber email address

list_idsstring · uuid[]Optional

Array of list IDs to subscribe to

Responses
201

Subscriber created successfully

application/json
post
POST /v1/subscribers HTTP/1.1
Host: api.onset.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "email": "[email protected]",
  "list_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}
{
  "id": "text",
  "email": "[email protected]",
  "lists": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "created_at": "2025-09-12T16:33:51.584Z",
  "updated_at": "2025-09-12T16:33:51.584Z"
}

Get subscriber by ID

get

Retrieve a specific subscriber by their ID

Authorizations
Path parameters
idstringRequired

Subscriber ID

Responses
200

Subscriber retrieved successfully

application/json
get
GET /v1/subscribers/{id} HTTP/1.1
Host: api.onset.com
Authorization: Bearer JWT
Accept: */*

{
  "id": "text",
  "email": "[email protected]",
  "lists": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "created_at": "2025-09-12T16:33:51.584Z",
  "updated_at": "2025-09-12T16:33:51.584Z"
}

Delete subscriber

delete

Delete a subscriber by their ID

Authorizations
Path parameters
idstringRequired

Subscriber ID

Responses
204

Subscriber deleted successfully

No content
delete
DELETE /v1/subscribers/{id} HTTP/1.1
Host: api.onset.com
Authorization: Bearer JWT
Accept: */*

No content

Update subscriber

patch

Update an existing subscriber

Authorizations
Path parameters
idstringRequired

Subscriber ID

Body
list_idsstring · uuid[]Optional

Array of list IDs to subscribe to

Responses
200

Subscriber updated successfully

application/json
patch
PATCH /v1/subscribers/{id} HTTP/1.1
Host: api.onset.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "list_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}
{
  "id": "text",
  "email": "[email protected]",
  "lists": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "created_at": "2025-09-12T16:33:51.584Z",
  "updated_at": "2025-09-12T16:33:51.584Z"
}
PreviousReleases