map

The people behind a many-people or approximate-area pin

One page of the people a groupId stands for. A groupId comes from a pin with id: null (several people at one address) or from an entry in areas. Each member id opens with GET /v1/map/records/{markerId}.

Members carry label only when the group id came from a view at zoom 15 or closer (named: true). A group id works for 24 hours, and only for the account it was issued to.

Billing. One map request per page. Test mode and any error response are free.

get/v1/map/groups/{groupId}

Request

  • Base URL: https://api.offendersearch.app
  • URL: https://api.offendersearch.app/v1/map/groups/{groupId}
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

groupIdstring required

A groupId (mg_…) from a viewport or area response.

Query parameters

pageinteger

Page number, starting at 1.

perPageinteger

People per page, 1 to 100.

Response

One page of the group.

totalinteger

People in the group.

pageinteger
perPageinteger
totalPagesinteger
kind'address' | 'area'

address for several people at one address; area for an approximate-area pin.

namedboolean

true when the group id came from a view at zoom 15+; members then carry label.

sandboxboolean

Present and true on a test-mode answer.

noticestring

Example response

{
  "total": 12,
  "page": 1,
  "perPage": 50,
  "totalPages": 1,
  "kind": "address",
  "named": true,
  "members": [
    {
      "id": "mk_…",
      "addressType": "home",
      "label": "S. Jones",
      "housingStatus": null,
      "hasPhoto": false
    }
  ]
}

Changes

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