v1

latestOpenAPI 3.0.02026-07-24161168406.5 KB

Operation Unit

List operation units with pagination

Retrieves a paginated list of operation units for the company, including company and parent when applicable. When externalCode is provided, results are filtered to the unit with that exact external code. If nothing matches, data is empty and total is 0 (HTTP 200, not 404).

get/os/v1/operation-units

Query parameters

externalCodestring

Example:FILIAL-SUL

Optional. Exact match on operation unit external code. Empty list when no match.

pagenumber

Example:1

Page number for pagination

maxPageSizenumber

Example:20

Maximum page size for pagination

Response

Operation units retrieved successfully

pathstring required

Request path

durationstring required

Request duration

method'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' required

HTTP method used

Example response

{
  "result": {
    "data": [
      {
        "company": {
          "id": "1",
          "name": "Gupy"
        }
      }
    ]
  }
}