---
title: "Get location"
method: GET
path: "/locations/{id}"
tags: ["Locations"]
---

# Get location

`GET /locations/{id}`

## Path parameters

- `id` integer, required

## Response `200`

Successfully retrieved location's information

- object
  - `location` object, required
    - `id` integer, required — Global ID of the location
    - `name` string, required
    - `description` string, nullable
    - `address` string, nullable — Postal address of the location
    - `barcode` string, nullable — String encoded barcode
    - `parentId` integer, nullable — ID of the parent location
    - `childrenIds` number[], nullable — IDs of the location's children
    - `thumbnail` object, nullable
      - `id` number, required — Global ID of the attachment
      - `mimeType` string, required — MIME type of the file
      - `fileName` string, required — Attachment's file name
      - `url` string, required — Url of the file. Valid for 60 minutes.
      - `createdAt` string, date-time, required — Date & time at which the attachment was uploaded
      - `width` number, nullable — Width if the file is an image
      - `height` number, nullable — Height if the file is an image
    - `attachments` object[] — List of attachments linked to the location
      - `id` number, required — Global ID of the attachment
      - `mimeType` string, required — MIME type of the file
      - `fileName` string, required — Attachment's file name
      - `url` string, required — Url of the file. Valid for 60 minutes.
      - `createdAt` string, date-time, required — Date & time at which the attachment was uploaded
      - `width` number, nullable — Width if the file is an image
      - `height` number, nullable — Height if the file is an image
    - `extraFields` object — Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "Department")
    - `teamIds` number[] — Team IDs
    - `vendorIds` number[] — Vendor IDs
    - `createdAt` string, date-time — Date & time at which the location was created
    - `updatedAt` string, date-time — Date & time at which the location was last updated. This doesn't include comments
    - `deletedAt` string, date-time, nullable — Date at which the location was deleted
    - `externalId` string, nullable — External ID for this location, unique per organization.

## Other responses

- `400` — Error with query
- `401` — Invalid token
- `404` — Could not find the specified location or the user cannot access it.

---

[API](https://skmtc.net/getmaintainx/apis/maintainx-api.md) · [All operations](https://skmtc.net/getmaintainx/apis/maintainx-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/getmaintainx/maintainx-api/revisions/ef9153fcac7c/schema)
