GET
List company profiles (company)
Company space User accounts only For: Administrator · Permission: profiles.list Conditions
  • Filter is_builtin accepts true or false; name is a substring match on the stored lowercase name; sort_by accepts id, name, created_at, updated_at; per_page is at most 1000.
Part of Define access profiles and roles.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

per_page
integer | null

Number of items per page.

Required range: 1 <= x <= 1000
cursor
string | null

Position in the list. Pass the meta.next_cursor or meta.prev_cursor value of the previous page; leave it out to get the first page.

sort_by
enum<string> | null

Field the list is sorted by.

Available options:
id,
name,
created_at,
updated_at
sort_order
enum<string> | null

asc for ascending order, desc for descending order.

Available options:
asc,
desc
name
string | null

Filter by name: keeps entries whose lowercase name contains this text. Names are stored in lowercase.

Maximum string length: 255
is_builtin
boolean | null

Filter on built-in entries: true keeps only built-in ones (created by the system, not editable), false keeps only custom ones. Omit for both.

response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, name, description, company_id, client_id, is_builtin, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: groupedRoles, groupedRoles.permissions.

Response

Resource.

data
ProfileResource · object[]
required

Items of this page.

meta
object
required

Pagination details.