v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Branches

Get a Branch

Returns details about the specified branch.

get/v1/branch/{branchId}

Path parameters

branchIdstring required

Headers

RequestIdstring uuid

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

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

The requested branch details.

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"
  }
}