Branches

Get Branches

Returns a list of available branches and their details.

get/v1/branch

Request

Base URL
https://api.avionte.com/front-office
URL
https://api.avionte.com/front-office/v1/branch
Auth
- API key in header x-api-key
- or HTTP bearer

Headers

RequestIdstring uuid

Unique request identifier in UUID format used to correlate request data to log entries and events.

Example:63680b86-c7e0-4a36-ae4a-d0d481089aff

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Response

A list of available branches.

idinteger

The identifier for the employer branch.

namestring

The name of the employer branch.

phoneNumberstring

Branch phone number.

emailstring

Branch email address.

Example response

[
  {
    "employer": {
      "address": {
        "street1": "123 Main Street",
        "street2": "Suite 100",
        "city": "St. Paul",
        "state_Province": "MN",
        "postalCode": "55121",
        "country": "US",
        "county": "Dakota",
        "geoCode": "241231070",
        "schoolDistrictCode": "00000"
      }
    },
    "branchAddress": {
      "street1": "123 Main Street",
      "street2": "Suite 100",
      "city": "St. Paul",
      "state_Province": "MN",
      "postalCode": "55121",
      "country": "US",
      "county": "Dakota",
      "geoCode": "241231070",
      "schoolDistrictCode": "00000"
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.