v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Supplier

Get a Supplier by UUID

Returns details for the supplier associated with the specified tenant and supplier UUID.

get/v1/supplier/{supplierGuid}

Path parameters

supplierGuidstring uuid required

The unique identifier for the staffing company (supplier), formatted as a UUID.

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

supplierGuidstring uuid

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

shortNamestring

Short Name of the Supplier.

fullNamestring

Full Name of the Supplier.

feinstring

Federal Tax EIN of the Supplier.

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