List Subscribers

Request

Filters and returns Subscribers for current Hub with basic info.

Security

ApiKeyAuth

Path

subdomainstringrequired

Unique subdomain of requested Hub.

Query

deletedstring

Filters subscribers by deletion status:

true - return only subscribers that were deleted,
false - return only subscribers that were not deleted,
all - return subscribers without filtering by deleted status.

Please note that this filter work on subscriber level and does not check subscriptions deletion status during filtering.

Default:"false"

Enum:"true""false""all"

qstring

String that filters subscribers to those containing the search string in:

idp_id.

Example:q=internal-identifier-at-company.com

sort_propstring

Determines which property results should be sorted by.

Default:"created_at"

Enum:"created_at""updated_at"

sort_dirstring

Determines sorting direction.

Default:"desc"

Enum:"asc""desc"

pageinteger, >= 1

Requested page index.

Default:1

per_pageinteger, [ 1 .. 100 ]

A limit on the number of records to be returned.

Default:25

api_versionstring

Api version

Value:"V3-R1"

curl -i -X GET \
  'https://subdomain-of-your-account.app.statushub.io/api/v3/hubs/{subdomain}/subscribers?deleted=true&q=internal-identifier-at-company.com&sort_prop=created_at&sort_dir=asc&page=1&per_page=25&api_version=V3-R1' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json

current_pageinteger, >= 1

Example:1

page_countinteger, >= 1

Example:4

per_pageinteger, [ 1 .. 100 ]

Example:25

totalinteger, >= 0

Example:1024

dataArray of objects, <= 100 items

Response

{
  "current_page": 1,
  "page_count": 4,
  "per_page": 25,
  "total": 1024,
  "data": [
    { … }
  ]
}