LOlocalfalcon
Locations

List All Location Groups

Get a full list of all location groups in your Local Falcon account, including the number of locations and the Place IDs contained in each group.

Groups may be nested. A group with a parent is returned with type set to child, and its parent object identifies the containing group by key and name. Top-level groups are returned with type set to parent.

If more records exist than is allowed within the set limit, a value will be returned under next_token that can be used as a parameter to request the next page of results.

post/v1/location-groups/

Request

  • Base URL
    https://api.localfalcon.com
  • Auth
    none declared

Request body application/x-www-form-urlencoded

api_keystring required

Your Local Falcon API key.

querystring

Search query. Matches against the group key or name.

limitinteger

The number of results you wish to retrieve.

next_tokenstring

This parameter is used to get the next 'page' of results. The value used with the parameter is provided from a previous response by this endpoint if more 'pages' of results exist.

Response

Successful response

codeinteger
code_descboolean
successboolean
messageboolean
parametersobject

Changes

No recorded changes to this operation across all 5 revisions of this API.