SubscribersControllerSearchSubscribersRequest

January 14, 2026 ยท View on GitHub

Fields

FieldTypeRequiredDescriptionExample
afterOptional<String>:heavy_minus_sign:Cursor for pagination indicating the starting point after which to fetch results.
beforeOptional<String>:heavy_minus_sign:Cursor for pagination indicating the ending point before which to fetch results.
limitOptional<Double>:heavy_minus_sign:Limit the number of items to return10
orderDirectionOptional<SubscribersControllerSearchSubscribersOrderDirection>:heavy_minus_sign:Direction of sorting
orderByOptional<String>:heavy_minus_sign:Field to order by
includeCursorOptional<Boolean>:heavy_minus_sign:Include cursor item in response
emailOptional<String>:heavy_minus_sign:Email address of the subscriber to filter results.
nameOptional<String>:heavy_minus_sign:Name of the subscriber to filter results.
phoneOptional<String>:heavy_minus_sign:Phone number of the subscriber to filter results.
subscriberIdOptional<String>:heavy_minus_sign:Unique identifier of the subscriber to filter results.
idempotencyKeyOptional<String>:heavy_minus_sign:A header for idempotency purposes