list

Add items to a list

Adds sites, jurisdictions, ZIP codes or areas to a list.

A site with the same parcels, or a jurisdiction or ZIP code with no filter, that is already on the list is returned as is and not added again.

post/v1/list/{list_id}/item

Request

Base URL: http://localhost:3030
URL: http://localhost:3030/v1/list/{list_id}/item
Auth: HTTP bearer

Path parameters

list_idstring required

The list's id, lst_....

Request body

Example request

{
  "item": [
    {
      "parcel": [
        "prc_01h455vb4pex5vsknk084sn02q"
      ],
      "jurisdiction": "jur_01h455vb4pex5vsknk084sn02q",
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -78.6999,
              35.849
            ],
            [
              -78.6993,
              35.849
            ],
            [
              -78.6993,
              35.8494
            ],
            [
              -78.6999,
              35.8494
            ],
            [
              -78.6999,
              35.849
            ]
          ]
        ]
      }
    }
  ]
}

Response

A page of list items.

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": "lsi_01h455vb4pex5vsknk084sn02q",
      "name": "Hwy 101 site",
      "tags": [
        "Owner contacted",
        "Needs survey"
      ],
      "parcel": [
        {
          "id": "prc_01h455vb4pex5vsknk084sn02q",
          "number": "0787517396",
          "address": "4516 PRINTER LN, RALEIGH, NC 27613",
          "acres": 0.26,
          "href": "/v1/parcel/prc_01h455vb4pex5vsknk084sn02q"
        }
      ],
      "address": "4516 PRINTER LN, RALEIGH, NC 27613",
      "acres": 3.09,
      "jurisdiction": {
        "id": "jur_01h455vb4pex5vsknk084sn02q",
        "name": "Wake",
        "type": "county",
        "fips": "37183",
        "href": "/v1/jurisdiction/jur_01h455vb4pex5vsknk084sn02q"
      },
      "postal_code": "27613",
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -78.6999,
              35.849
            ],
            [
              -78.6993,
              35.849
            ],
            [
              -78.6993,
              35.8494
            ],
            [
              -78.6999,
              35.8494
            ],
            [
              -78.6999,
              35.849
            ]
          ]
        ]
      },
      "filter": {
        "min_acres": 10
      },
      "centroid": {
        "lat": 35.8492,
        "lon": -78.6996
      },
      "added_by": "ana@example.com",
      "href": "/v1/list/lst_01h455vb4pex5vsknk084sn02q/item/lsi_01h455vb4pex5vsknk084sn02q"
    }
  ],
  "next_cursor": "eyJrIjoiMjAyNi0xMC0wMSIsInQiOjQyfQ"
}

Changes

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