Skip to content
View as Markdown

GET Report Options​

GET
/reports/options

Retrieve option sets by specifying a comma-separated list of field names. Each field name maps to an internal method that returns the corresponding data (e.g., countries, lists, tags, campaigns, statuses, editable_statuses, contact_types, email_sequences, automation_funnels, companies, segments, roles, user_roles_options, profile_sections, custom_fields, sms_statuses). Only recognized field names are processed; unknown names are silently skipped.

Authorizations​

ApplicationPasswords

WordPress Application Passwords — use Basic auth with your WordPress username and an application password in the format: username:application_password

Type
API Key (header: Authorization)

Parameters​

Query Parameters

fields*

Comma-separated list of option fields to retrieve (e.g., lists,tags,statuses).

Type
string
Required
Example"lists,tags,statuses"
with_count

Array of field names for which to include subscriber counts. Currently supports lists.

Type
array

Responses​

Options retrieved successfully. The response contains an options object whose keys depend on the requested fields.

application/json
JSON
{
"options": {
"lists": [
{
"id": 0,
"slug": "string",
"title": "string",
"subscribersCount": 0
}
],
"tags": [
{
"id": 0,
"slug": "string",
"title": "string",
"value": "string",
"label": "string"
}
],
"statuses": [
{
}
],
"campaigns": [
{
"id": 0,
"title": "string"
}
],
"countries": [
{
"code": "string",
"id": "string",
"slug": "string",
"title": "string"
}
],
"additionalProperties": "string"
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI