list

List lists

Lists all lists, most recently updated first.

Not paginated: has_more is always false.

get/v1/list

Request

  • Base URL: http://localhost:3030
  • URL: http://localhost:3030/v1/list
  • Auth: HTTP bearer

Query parameters

parcelstring nullable

A parcel id.

Example:prc_01h455vb4pex5vsknk084sn02q

Only lists with a site that includes this parcel.

Response

A page of saved lists.

object'list' required

The object's type. Always list.

has_moreboolean required

Whether there are more results after this page.

next_cursorstring nullable required

The cursor for the next page. Send it as cursor. Null on the last page.

suppressedinteger required

The number of matching results withheld because the plan does not include them.

Example response

{
  "data": [
    {
      "id": "lst_01h455vb4pex5vsknk084sn02q",
      "name": "Sites under review",
      "item_count": 12,
      "status_counts": {
        "new": 5,
        "reviewing": 4,
        "pursuing": 2,
        "passed": 1
      },
      "href": "/v1/list/lst_01h455vb4pex5vsknk084sn02q"
    }
  ],
  "next_cursor": "eyJrIjoiMjAyNi0xMC0wMSIsInQiOjQyfQ"
}

Changes

No recorded changes to this operation across all 1 revision of this API.