Documentation menu

← Lists and monitors

API reference

List lists

GET/v1/list

Lists all lists, most recently updated first.

Not paginated: has_more is always false.

Parameters

query

parcelstring | null
Only lists with a site that includes this parcel.

Responses

200
array of list objects
A page of saved lists.
401
ProblemDetail
credential_missing, credential_invalid or credential_expired. The request has no valid credential.
403
ProblemDetail
scope_missing, person_required, api_key_not_accepted or entitlement_missing. The credential or plan does not allow this request. detail names the reason.
422
ProblemDetail
parameter_invalid, id_malformed or a cursor code. A parameter is missing or invalid. errors lists each one.
429
ProblemDetail
rate_limited. Too many requests. Retry after the Retry-After interval. Nothing is charged.

Example request

curl -G 'https://api.placestack.com/v1/list' \
  --data-urlencode 'parcel=prc_01h455vb4pex5vsknk084sn02q' \
  -H "Authorization: Bearer $PLACESTACK_API_KEY"

Example response

{
  "object": "list",
  "data": [
    {
      "object": "list",
      "id": "lst_01h455vb4pex5vsknk084sn02q",
      "name": "Sites under review",
      "item_count": 12,
      "created_at": "2026-09-13T12:00:00Z",
      "updated_at": "2026-09-13T12:00:00Z",
      "href": "/v1/list/lst_01h455vb4pex5vsknk084sn02q"
    }
  ],
  "has_more": true,
  "next_cursor": "eyJrIjoiMjAyNi0xMC0wMSIsInQiOjQyfQ",
  "suppressed": 0,
  "total": {
    "value": 1,
    "relation": "eq"
  }
}

Next steps

POST /list

Create a list

Continue