GET
List access grants
Organization space User accounts only For: Administrator · Permission: access_grants.list Conditions
  • Only members can use it, from the organization space; agent accounts cannot.
Part of Limit access to locations and books.

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,
created_at,
updated_at
sort_order
enum<string> | null

asc for ascending order, desc for descending order.

Available options:
asc,
desc
actor_type
enum<string> | null

Filter by kind of actor holding the grant: user_profile (a person's profile assignment in the organization) or organization_agent.

Available options:
user_profile,
organization_agent
actor_id
string | null

Filter by identifier of the actor (27-character KSUID string).

Required string length: 27
domain
enum<string> | null

Filter by domain of the grant. Only accounting exists today.

Available options:
accounting
target_type
enum<string> | null

Filter by kind of target: organization (the organization's own books) or company.

Available options:
organization,
company
target_id
string | null

Filter by identifier of the target (27-character KSUID string): the organization or a company.

Required string length: 27
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, actor_type, actor_id, domain, target_type, target_id, 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: .

Response

Resource.

data
AccessGrantResource · object[]
required

Items of this page.

meta
object
required

Pagination details.