Skip to navigation
Gl Configuration

Get GL Groups

Retrieve a paginated list of General Ledger groups for the tenant. Each item is filtered to the same public fields as Get GL Group by UUID for OAuth clients.

Authentication

AuthorizationBearer

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

Headers

vnd.a1.tenant-idstringOptional

Tenant identifier for multi-tenant environments

Query parameters

pageintegerOptional
Page number to retrieve. Starts from 1.
limitintegerOptional
Maximum number of records to return per page.
sortColumnenumOptional
Field to sort results by.
Allowed values:
sortOrderenumOptional
Sort direction.
Allowed values:
searchColumnenumOptional
Column to search on.
Allowed values:
searchValuestringOptional

Value to search for in searchColumn.

regionCodestringOptional

Filter by region code (e.g. GB, AU, NZ).

isDefaultbooleanOptional
Filter by default status.
isEnablebooleanOptional
Filter by enabled status.
includestringOptional

Comma-separated list of field paths to include in each item (e.g. uuid,name).

Response

Successful Response
currentPageintegerOptional
limitintegerOptional
totalCountintegerOptional
Total number of matching GL groups.
totalPagesintegerOptional
itemslist of objectsOptional