v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Departments

Get IDs by department address

Retrieves a list of address IDs for a department address.

get/v1/departments/department-address-search

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.

companyIDinteger required

The identifier for the department's company.

street1string required

The street 1 details of the department's address.

street2string

The street 2 details of the department's address.

citystring required

The name of the city of the department's address.

statestring required

The state/province of the department's address.

zipcodestring required

The zip code of the department's address

A list of department address IDs.

IntegerSchema[] required