---
title: "Show location"
method: GET
path: "/api/v1/locations/{id}"
tags: ["locations"]
---

# Show location

`GET /api/v1/locations/{id}`

## Request

- Base URL: `https://demo.invoiceninja.com`
- URL: `https://demo.invoiceninja.com/api/v1/locations/{id}`
- Auth: none declared. Required headers: `X-API-TOKEN`, `X-Requested-With`
- TypeScript: <https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/docs/api/v1/locations/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

##  GET /api/v1/locations/{id}

Displays a location by id

## Path parameters

- `id` string, string, required

## Query parameters

- `index` string

## Headers

- `X-API-TOKEN` string, required
- `X-Requested-With` string, required

## Response `200`

Returns the location object

- Location
  - `id` string: The location hashed id
  - `name` string: The location name
  - `address1` string: The first line of the address
  - `address2` string: The second line of the address
  - `city` string: The city name
  - `state` string: The state or region
  - `postal_code` string: The postal or zip code
  - `country_id` string: The ID of the associated country
  - `custom_value1` string, nullable: Custom field value 1
  - `custom_value2` string, nullable: Custom field value 2
  - `custom_value3` string, nullable: Custom field value 3
  - `custom_value4` string, nullable: Custom field value 4
  - `is_deleted` boolean: Indicates if the location has been deleted
  - `is_shipping_location` boolean: Indicates if this is a shipping location
  - `user_id` string: The user hashed id
  - `assigned_user_id` string: The assigned user hashed id
  - `client_id` string: The client hashed id
  - `vendor_id` string: The vendor hashed id
  - `created_at` integer: Timestamp of when the location was created
  - `updated_at` integer: Timestamp of when the location was last updated

## Other responses

- `401`: Authentication error
- `403`: Authorization error
- `422`: Validation error
- `429`: Rate Limit Exceeded
- `default`: Unexpected Error

## Changes

> 110 revisions in range; 1 not diffed.

- **2026-04-20** `69a36036d334`: 1 info
  - the response optional property `id` became read-only for the status `200`
- **2025-02-27** `50bf3f8e5d03`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/changes/api/v1/locations/:id/get.md)

---

[API](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference.md) - [All operations](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/revisions/bcda1f823746?raw)
