Profiles

List profiles

Changed on

Returns profiles sorted default-first, then by creation date. Filter with name or externalId (exact match) and paginate with limit/skip; without those params the full list is returned unchanged. Use includeOverLimit=true to include profiles that exceed the plan limit.

get/v1/profiles

Request

  • Base URL: https://zernio.com/api
  • URL: https://zernio.com/api/v1/profiles
  • Auth: HTTP bearer

Query parameters

includeOverLimitboolean

When true, includes over-limit profiles (marked with isOverLimit: true).

namestring

Exact-match filter on the profile name. Useful to recover a profile id after an ambiguous create (timeout followed by a 409 on retry).

externalIdstring

Exact-match filter on the externalId you set on the profile, to find the profile of one of your tenants without storing its Zernio id. Team members can each own a profile with the same externalId, so the result is a list.

limitinteger

Page size. When limit or skip is present, the response includes total and skip (and echoes limit).

skipinteger

Number of profiles to skip, applied after sorting and filtering.

Response

Profiles

totalinteger

Total matching profiles across all pages. Present only when limit or skip was passed.

skipinteger

Offset applied. Present only when limit or skip was passed.

limitinteger

Echo of the limit query param. Present only when it was passed.

Changes

  • 27c96850cc66Revision changes
    • info

      added the new optional query request parameter externalId

    • info

      added the optional property // to the response with the status

  • f8c8f34fb41aRevision changes
    • warning

      added the new account enum value to the / response property for the response status

    • warning

      added the new account enum value to the / response property for the response status