Routes
Regions

This request returns your Regions in Limble.

Return data description

PropertyDescription
regionIDThe ID of the Region
regionNameThe name of the Region
parentRegionIDThe regionID of the parent of a region.
get/v2/regions

Request

Query parameters

regionsinteger

This parameter is used to only get regions in the list provided. This parameter accepts a comma delimited list of Region IDs.

namestring

This parameter is used to only get specific regions by name. This parameter expects a string- the full name of a region or partial name with the wildcard %.

cursorinteger

This parameter is a cursor that selects what regionID you want to start receiving results at. e.g. passing 137 here will only get you regions with an id greater than 137.

limitinteger

This parameter is a result limiter. The default is set to return no more than 100 results at one time.

Response

Regions

regionIDinteger
regionNamestring
parentRegionIDinteger

Changes

    • warning

      for the query request parameter limit, the max was set to 1000.00

    • warning

      for the query request parameter limit, the min was set to 1.00

    • info

      added the non-success response with the status