Query Locations
List of paths to query for all locations across an application.
#
Methods and PathsMethod | URI | Name | Summary |
---|---|---|---|
GET | /v1.0/admin/locations | Retrieve locations for current application | |
GET | /v1.0/admin/locations/count | Count all locations for current application | |
GET | /v1.0/admin/locations/{location_id} | Retrieve a single location | |
POST | /v1.0/admin/locations | Create a location | |
PUT | /v1.0/admin/locations/{location_id} | Update a location | |
DELETE | /v1.0/admin/locations/{location_id} | Delete location |
#
Query ParametersName | Source | Type |
---|---|---|
application_id | query | string |
limit | query | number |
page | query | number |
user_id | query | string |
external_id | query | string |
#
ResponsesCode | Status | Description | Has headers | Schema |
---|---|---|---|---|
200 | OK | Successful company retrieval | schema | |
400 | Bad Request | Bad request sent to server | schema | |
401 | Unauthorized | You are unauthorized | schema | |
403 | Forbidden | You are forbidden to perform this action | schema |
#
Example 1List all locations within your realm
Example Response:
#
Example 2Create a Location
Example Response:
#
Example 3Update a Location
Example Response:
#
Example 4Delete a Location
Example Response:
#
Example 5External Id Query Parameter