v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Departments

Get a Department

Returns details about the specified department.

get/v1/department/{departmentId}

departmentIdstring required

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.

The requested department record.

companyExternalIdstring nullable

The unique system-defined identifier for the Company.

companyGuidstring uuid nullable

The Back Office unique identifier for the Company, formatted as a UUID.

departmentExternalIdstring nullable

The unique system-defined identifier for the Company Department.

departmentGuidstring uuid nullable

The Back Office unique identifier for the Department, formatted as a UUID.

departmentNamestring

The name of the company department.