Querying for regions

Use the following endpoints to query for regions:

  • GET /admin/v1/regions
  • GET /admin/v1/regions/{regionId}
  • GET /admin/v1/users/{userId}/regions
  • GET /admin/v1/users/{userId}/regions/{userRegionId}
  • GET /admin/v1/groups/{groupId}/regions
  • GET /admin/v1/groups/{groupId}/regions/{groupRegionId}

For example, the following request in ClaimCenter retrieves information about the single region that the user demo_sample:8 (Betty Baker) belongs to:

Command
GET /admin/v1/users/demo_sample:8/regions
Response
{
    "count": 1,
    "data": [
        {
            "attributes": {
                "id": "cc:SXhGC66x9rcJSkNhxrz3T",
                "region": {
                    "displayName": "Los Angeles Claims Center - SoCal",
                    "id": "demo_sample:14",
                    "type": "Region",
                    "uri": "/admin/v1/regions/demo_sample:14"
                }
            },
        ...