SHshovels
Addresses

Get Residents

Changed on

Return residents for a given address geo ID. Results are paginated using cursor-based pagination.

get/addresses/{geo_id}/residents

Request

  • Base URL
    https://api.shovels.ai/v2
  • Auth
    API key in header X-API-Key

Path parameters

geo_idstring required

Address geo ID

Query parameters

cursorstring nullable

Cursor for pagination

sizeinteger

Response

Residents for a given address geo ID

sizeinteger required

The number of items returned in the response.

next_cursorstring nullable required

The cursor for retrieving the next page of results.

Changes

  • 64df4c8074f5Revision changes
    • breaking

      for the query request parameter size, default value was changed from 50 to 10

  • 685b8866c451Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status