v2

latestOpenAPI 3.1.02026-08-075421692.0 MB

Profiles

List profiles

Returns profiles sorted default-first, then by creation date. Filter with name (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

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).

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.