Skip to main content
GET
List subscriptions

Authorizations

Authorization
string
header
required

Bearer access token issued by Peerlogic.

Query Parameters

practice_id
string[]

Return subscriptions for any of these practice IDs. Repeat the query parameter to supply more than one value.

is_active
boolean[]

Return subscriptions matching either active state. Repeat the query parameter to include both values.

name
string[]

Return subscriptions matching any of these names. Repeat the query parameter to supply more than one value.

Search customer-defined subscription names and descriptions.

sort
string

Order results by a supported subscription field. Prefix a field with - for descending order.

page
integer

Page number to return.

page_size
integer

Maximum number of subscriptions to return on one page.

Response

A paginated list of subscriptions.

count
integer
required

Total number of matching subscriptions.

results
object[]
required

Subscriptions in the current page.

next
string<uri> | null

URL for the next page, or null when this is the final page.

previous
string<uri> | null

URL for the previous page, or null when this is the first page.