Search Subscribers

post

https://{domain}/api/v4/subscribers/search

Body Params

The input.

summary

boolean | null

Simplified output view

subscriptionId

int32 | null

Search for subscriptions by id

groupId

int32 | null

Search for subscriptions by group

sortBy

string

enum

SortSubscriptions

Members:

EmailAddress - Sort by email address
PhoneNumber - Sort by phone number
WhenCreated - Sort by subscription created date
LastLogin - Sort by subscription last login

Allowed:

filterBy

string

enum

Members:

Allowed:

searchValue

string | null

Search for subscriptions by text

string | null

Search for subscriptions by email address

phoneNumber

string | null

Search for subscriptions by phone number

webhookUrl

string | null

Search for subscriptions by webhook

tags

string | null

Search for subscriptions by tags

emailNotices

boolean | null

Search for subscriptions that receive email notifications

smsNotices

boolean | null

Search for subscriptions that receive sms notifications

webhookNotices

boolean | null

Search for subscriptions that receive webhook notifications

receivingMonthlySummary

boolean | null

Search for subscriptions that receive a montly summary

key

string | null

Search for subscriptions by key

incidentTypeViaEmail

string

enum

Incident Type

Members:

ScheduledMaintenance - Scheduled Maintenance
ServiceUnavailable - Incident
Informational - Informational

Allowed:

incidentTypeViaSms

string

enum

Incident Type

Members:

ScheduledMaintenance - Scheduled Maintenance
ServiceUnavailable - Incident
Informational - Informational

Allowed:

components

array of int32s | null

Search for subscriptions by components

components

createdBefore

date-time | null

Search for subscriptions that were created before a date

createdAfter

date-time | null

Search for subscriptions that were created after a date

activatedOnly

boolean | null

Search for subscriptions that are activated only

usersWithLoginsOnly

boolean | null

Search for subscriptions with login in accounts

incidentId

int32 | null

Search for subscriptions by incident id

sorting

string

enum

Sorting

Members:

Ascending - Ascending from A-Z
Descending - Descending from Z-A

Allowed:

pageNumber

int32 | null

1 to 10000

Page number

pageSize

int32 | null

1 to 1000

Page size

Responses

401

Unauthorized

403

Forbidden

405

NotAllowed

200Success