Appearance

Get Offices ​

Endpoint ​

http
GET /unified/ats/offices/{id}
Integrations supported
  • Jobvite

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Response Body ​

id
string
REQUIRED · 

The office's unique identifier

Supported in
  • Jobvite
name
string

The office's name

Supported in
  • Jobvite
parent
object

The office's parent

id
string

Unique identifier of the office

location
string

The office's location

Supported in
  • Jobvite
is_remote
boolean

Whether the office is remote or not

created_at
string · date-time

The date and time of the office's creation

updated_at
string · date-time

The date and time of the office's last update

remote_data
object

Raw data returned from the remote API call.