Get a location

GET 
/api/locations/:id

Required permissions:

• settings.company: allows view of company locations.

Here the dedicated support page.

Request

Path Parameters

id stringrequired

Header Parameters

Wethod-Company stringrequired

The company you want to interact with

Wethod-Version stringrequired

The API version you want to use

Responses

200

Returns the requested location.

application/json

Schema

Schema

id integerrequired

Possible values: >= 1

created_at date-timerequired
updated_at date-timerequired
name stringrequired

Possible values: <= 255 characters

default booleanrequired

Example (from schema)

{
  "id": 1,
  "created_at": "2024-12-20T14:44:08.204Z",
  "updated_at": "2024-12-20T14:44:08.204Z",
  "name": "string",
  "default": true
}

403

Forbidden

404

Not found

Loading...