List Places

Returns a list of Places belonging to your account.

Responses

• 200
• 401
• 500

---

OK

Response Headers

• X-PaginationLimit string

  The per page limit. Currently set to 100 but subject to change at any time.

• X-Pagination-Current-Page string

  The current page. Defaults to 1.

• X-Pagination-Total-Pages string

  The total number of pages in the result set. Use this along with Pagination-Current-Page to determine if there are any remaining pages/records to be retrieved.

• X-Pagination-Total-Count string

  The total number of records in the result set (across all pages).

application/json

• Schema
• Example (from schema)

---

Schema

array

• id integer

  Possible values: >= 1

• created_at date-time

  The date and time at which this record was created.

• updated_at date-time

  The date and time at which this record was most recently updated.

• name string

  A name for this Place.

• address string

  This Place's address.

• description string

  A description of this Place.

• place_visits_count integer

  The number of times this Place has been visited.

• radius_in_meters integer

  The radius around this Place's coordinates within which we consider this Place to have been visited.

• latitude float

  This Place's latitude.

• longitude float

  This Place's longitude.

[
  {
    "id": 0,
    "created_at": "2023-03-14T13:46:27-06:00",
    "updated_at": "2023-03-14T13:46:27-06:00",
    "name": "string",
    "address": "string",
    "description": "string",
    "place_visits_count": 0,
    "radius_in_meters": 0,
    "latitude": 33.515,
    "longitude": -86.80761
  }
]

Request could not be authenticated

application/json

• Schema
• Example (from schema)

---

Schema

• status integer

  Possible values: >= 400 and <= 599

• title string

  A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

• detail string

  A human-readable explanation specific to this occurrence of the problem.

• instance string

  A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Something unexpected happened

application/json

• Schema
• Example (from schema)

---

Schema

• status integer

  Possible values: >= 400 and <= 599

• title string

  A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

• detail string

  A human-readable explanation specific to this occurrence of the problem.

• instance string

  A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Loading...