List locations

Returns the active locations under the companies linked to the API token, ordered by name. Filterable by name, company, city, and state. Requires the location.list scope.

GET /api/v2/locations

List locations

cURL

curl --request GET \
  --url https://api.stage.origin.one/api/v2/locations \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "id": "456",
      "name": "Acme Downtown",
      "object": "location",
      "address": {
        "city": "Seattle",
        "country": "US",
        "line1": "123 Main St",
        "line2": "Suite 400",
        "object": "address",
        "postalCode": "98101",
        "state": "WA"
      },
      "company": {
        "id": "123",
        "name": "Acme Inc",
        "object": "company",
        "url": "/api/v2/companies/123"
      },
      "createdAt": "2025-01-15T10:30:00.000Z",
      "phone": "[phone]",
      "url": "/api/v2/locations/456"
    }
  ],
  "limit": 10,
  "page": 1,
  "total": 1
}

Authorizations

Authorization · string · header · required

Origin One API token. Pass it in the Authorization header: Authorization: Bearer <token>.

Query Parameters

limit · integer · default: 10

Number of items per page (max 20).

Required range: 1 <= x <= 20

Example:

10

page · integer · default: 1

Page of results to return (1-based).

Required range: 1 <= x <= 10000

Example:

1

city · string

Filter by city (case-insensitive partial match).

Required string length: 1 - 255

Example:

"seattle"

companyId · string

Filter by parent company. A company that is inactive, deleted, or not linked to the API token returns an empty page.

Example:

"123"

name · string

Filter by location name (case-insensitive partial match).

Required string length: 1 - 255

Example:

"downtown"

state · string

Filter by state or region code (exact match, case-insensitive).

Required string length: 1 - 255

Example:

"WA"

Response

200

application/json

Success.

data · object[] · required

Items on this page.

Show child attributes

limit · integer · required

Number of items per page.

Example:

10

page · integer · required

Current page number (1-based).

Example:

1

total · integer · required

Number of matching items across all pages.

Example:

1