v1

latestOpenAPI 3.0.02026-07-24161168406.5 KB
Area
Area

List areas with pagination

Retrieves a paginated list of areas for the company, including organization unit and cost center external codes when linked. When externalCode is provided, results are filtered to areas whose code contains that value (case-insensitive substring). If nothing matches, data is empty and total is 0.

get/os/v1/areas

Query parameters

externalCodestring
Example:AREA-001

Optional. Substring filter on area external code (case-insensitive). Empty list when no match.

pagenumber
Example:1

Page number for pagination

maxPageSizenumber
Example:20

Maximum page size for pagination

Response

Areas retrieved successfully