LocalGroupLocationList

Search API documentation

⌘K

List locations in a given group. This endpoint returns a simplified response containing only location IDs.

JSON-RPC Method:

local.group.location.list

Go to Example Code

Request

group_id

number

The ID of the local group.

page

object

Control the number of results returned per call in addition to fetching additional results. The default limit is 25 with an n value of 0 (indicating the first page of results). Make subsequent calls to the endpoint with incrementing n values to fetch additional pages of results. To get all results, you must continue making calls with incrementing n values until an empty result set is returned.

1{
2  "group_id": 123,
3  "page": {
4    "n": 0,
5    "limit": 25
6  }
7}

Response

locations

array

id

number

The id of the location

page

object

Control how much data is returned by providing a specific page number (n) and limit to the number of results in a given page. Additionally, may provide a sort order.

1{
2  "locations": [
3    {
4      "id": 1001
5    },
6    {
7      "id": 1002
8    },
9    {
10      "id": 1003
11    }
12  ],
13  "page": {
14    "n": 0,
15    "limit": 25
16  }
17}

Example Code

Quota Usage

Does not require any quota.