Customers

List Customers

GET /api/customers

get/api/customers

Request

  • Base URL: https://uptimeify.io
  • URL: https://uptimeify.io/api/customers
  • Auth: HTTP bearer

Query parameters

Responsestring
organizationIdinteger

Global admins only.

fields'minimal'

minimal: id, publicId, name, status and customFields only, sorted by name.

pageinteger

Switches to the paged shape { items, total, page, perPage }.

perPageinteger

Default 10, capped at 100.

searchstring

Paged shape: matches name, email, package and custom fields.

status'active' | 'inactive'

Paged shape only.

packageTypesstring

Paged shape: comma-separated package types.

sortBystring

Paged shape; customFields.<key> sorts by a custom field.

sortOrder'asc' | 'desc'

Default desc.

summary'0' | '1' | 'true' | 'false'

Paged shape: adds summary per row.

Response

OK

OR
OR

Changes

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