--- title: "Get a List of Branches" method: GET path: "/v1/branch" tags: ["Branch"] --- # Get a List of Branches `GET /v1/branch` Returns a list of all branches for the specified tenant. ## Query parameters - `IncludeInactive` boolean ## Headers - `Tenant` string - `FrontOfficeTenantId` integer - `RequestId` string, uuid, required ## Response `200` 200 response - Branch[] - `branchGuid` string, uuid — The unique identifier for the Branch, formatted as a UUID. - `name` string — Short Name of the Branch. - `description` string — Full Name of the Branch. - `active` boolean — An indication of whether the branch is active. - `supplierGuid` string, uuid — The unique indentifier for the Staffing Supplier, formatted as a UUID. - `phoneNumber` string — Phone number. - `address` Address - `addressGuid` string, uuid — Unique identifier for the address, formatted as a UUID. - `street1` string, required — Street address, line 1. - `street2` string — Street address, line 2. - `city` string, required — City. - `state` string, required — Province, state, or region. - `postalCode` string, required — ZIP/postal code. - `country` string, required — A 2-letter ISO 3166-1 alpha-2 code representing the country (e.g., "US", not "USA"). For details, see the General Guidelines. ## Other responses - `400` — Bad Request - `401` — Unauthorized - `403` — Access Denied - `404` — Not found - `406` — Unsupported format(s) indicated by Accept header - `415` — Unsupported format(s) indicated by the Content-Type header - `429` — Too many requests - `500` — An unexpected error occurred - `502` — Service Unavailable --- [API](https://skmtc.net/avionte/apis/aviont-partner-authorization-api.md) · [All operations](https://skmtc.net/avionte/apis/aviont-partner-authorization-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/avionte/aviont-partner-authorization-api/revisions/846b33e4e71b/schema)