---
title: "List Places"
method: GET
path: "/places"
tags: ["Places"]
---

# List Places

`GET /places`

## Request

- Base URL: `https://secure.fleetio.com/api`
- URL: `https://secure.fleetio.com/api/places`
- Auth: API key in header `Authorization` and API key in header `Account-Token`
- TypeScript: <https://skmtc.dev/fleetio/apis/fleetio-developer-api/docs/places/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a list of Places belonging to your account.

## Query parameters

- `start_cursor` string
- `per_page` integer
- `filter` object
  - `name` union
    - object
      - `like` string, required
    - object
      - `eq` string, required
  - `created_at` union
    - object
      - `lt` string, required
    - object
      - `lte` string, required
    - object
      - `gt` string, required
    - object
      - `gte` string, required
  - `updated_at` union
    - object
      - `lt` string, required
    - object
      - `lte` string, required
    - object
      - `gt` string, required
    - object
      - `gte` string, required
- `sort` object
  - `id` 'asc' | 'desc'
  - `name` 'asc' | 'desc'
  - `created_at` 'asc' | 'desc'
  - `updated_at` 'asc' | 'desc'

## Response `200`

OK

- object
  - `start_cursor` string, nullable: The current start cursor of the records returned.
  - `next_cursor` string, nullable: The next cursor to retrieve the next page of records.
  - `per_page` integer: The maximum number of records returned.
  - `estimated_remaining_count` integer: The number of remaining records including the returned records, up to a maximum of 500.
  - `filtered_by` union[]: The filters applied to the returned record set.
    - union
      - object
        - `name` union
          - object
            - `like` string, required
          - object
            - `eq` string, required
      - object
        - `created_at` union
          - object
            - `lt` string, required
          - object
            - `lte` string, required
          - object
            - `gt` string, required
          - object
            - `gte` string, required
      - object
        - `updated_at` union
          - object
            - `lt` string, required
          - object
            - `lte` string, required
          - object
            - `gt` string, required
          - object
            - `gte` string, required
  - `sorted_by` union[]: The sorts applied to the returned record set.
    - union
      - object
        - `updated_at` 'asc' | 'desc'
      - object
        - `name` 'asc' | 'desc'
      - object
        - `created_at` 'asc' | 'desc'
      - object
        - `id` 'asc' | 'desc'
  - `records` Place[]
    - `id` integer
    - `created_at` string, date-time: The date and time at which this record was created.
    - `updated_at` string, date-time: The date and time at which this record was most recently updated.
    - `name` string, required: A name for this Place.
    - `address` string, nullable, required: This Place's address.
    - `description` string, nullable, required: A description of this Place.
    - `place_visits_count` integer, nullable, required: The number of times this Place has been visited.
    - `radius_in_meters` integer, required: The radius around this Place's coordinates within which we consider this Place to have been visited.
    - `latitude` number, float, required: This Place's latitude.
    - `longitude` number, float, required: This Place's longitude.
    - `polygon_coordinates` object[], nullable: The latitude/longitude points that make up this Place's polygon geofence, when one is set. Null when the Place uses a circular geofence.
      - `lat` number, float
      - `lng` number, float

## Other responses

- `400`: The format or parameters of the request was invalid
- `401`: Request could not be authenticated
- `500`: Something unexpected happened

## Changes

- **2026-11-06** `49558d744bd7`: 2 info
  - for the `query` request parameter `per_page`, the min was decreased from `2.00` to `1.00`
  - added the optional property `records/items/polygon_coordinates` to the response with the `200` status

[Operation history](https://skmtc.dev/fleetio/apis/fleetio-developer-api/changes/places/get.md)

---

[API](https://skmtc.dev/fleetio/apis/fleetio-developer-api.md) - [All operations](https://skmtc.dev/fleetio/apis/fleetio-developer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fleetio/apis/fleetio-developer-api/revisions/49558d744bd7?raw)