v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Branch

Get a List of Branches

Returns a list of all branches for the specified tenant.

get/v1/branch

Query parameters

IncludeInactiveboolean

An indication of whether inactive branches should be included in the result. Defaults to false.

Headers

Tenantstring

Tenant company code for scoped data access during the request.

FrontOfficeTenantIdinteger

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

RequestIdstring uuid required

The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.

Response

200 response

branchGuidstring uuid

The unique identifier for the Branch, formatted as a UUID.

namestring

Short Name of the Branch.

descriptionstring

Full Name of the Branch.

activeboolean

An indication of whether the branch is active.

supplierGuidstring uuid

The unique indentifier for the Staffing Supplier, formatted as a UUID.

phoneNumberstring

Phone number.

Example response

[
  {
    "phoneNumber": "(969)-506-4483",
    "address": {
      "addressGuid": "cb63d8fc-6d06-f011-87a7-a0595061251e",
      "street1": "123 Main St.",
      "street2": "Suite 250",
      "city": "Minneapolis",
      "state": "MN",
      "postalCode": "55435",
      "country": "US"
    }
  }
]