---
title: "Retrieves the collection of Location resources."
method: GET
path: "/locations"
tags: ["Location"]
---

# Retrieves the collection of Location resources.

`GET /locations`

## Request

- Base URL: `https://example.myintranetapps.com/api`
- URL: `https://example.myintranetapps.com/api/locations`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/bossinsights/apis/boss-insights/docs/locations/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves the collection of Location resources.

## Query parameters

- `page` integer
- `itemsPerPage` integer

## Response `200`

Location collection

- Location[]
  - `id` string: unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "square-LH49301JKSV2Y"
  - `integration` string: The key of the integration source e.g. "square""
  - `srcId` string: The unique identifier of the source 3rd party integration
  - `created` string, date-time, nullable: Date entry was created e.g. "2013-11-18T02:17:40.080Z"
  - `businessName` string, nullable: Name of the business e.g. "Bowman and Co"
  - `currency` string, nullable: Currency code e.g. "USD"
  - `type` string, nullable: Type of the Sales term e.g. STANDARD
  - `country` string, nullable: Country of the address * e.g. "United States"
  - `city` string, nullable: City of the address e.g. "St Paul"
  - `state` string, nullable: Vendor state address e.g. "Alaska"
  - `postalCode` string, nullable: Postal code of the address * e.g. "99660"
  - `address` string, nullable: First line of customer address e.g. "708 Woodland Avenue"

---

[API](https://skmtc.dev/bossinsights/apis/boss-insights.md) - [All operations](https://skmtc.dev/bossinsights/apis/boss-insights/llms.txt) - [OpenAPI document](https://skmtc.dev/bossinsights/apis/boss-insights/revisions/d08a107895ad?raw)