Client

List all clients for an organization.

get/org/{orgId}/clients

Request

  • Base URL: https://api.pangolin.net/v1
  • URL: https://api.pangolin.net/v1/org/{orgId}/clients
  • Auth: HTTP bearer

Path parameters

orgIdstring required

Query parameters

pageSizeinteger

Number of items per page

pageinteger

Page number to retrieve

querystring
sort_by'name' | 'megabytesIn' | 'megabytesOut'

Field to sort by

order'asc' | 'desc'

Sort order

onlineboolean

Filter by online status

statusstring[]

Filter by client status. Can be a comma-separated list of values. Defaults to 'active'.

unknown

Response

Successful response

dataobject nullable required
successboolean required
errorboolean required
messagestring required
statusnumber required

Changes

No recorded changes to this operation across all 1 revision of this API.