/categories/{categoryId}

Click to copy

Get the category details for a category ID.

The /categories/{categoryId} request returns all the groups to which the category belongs. You must supply a category ID to use this request.

Note: Query parameters are case-sensitive.

Query parameters

NameTypeRequiredDefault valueDescription

string

json

The requested response format - either json or pjson (pretty json).

string

The authentication token with the premium:user:places privilege, used to access the Places service.

f

The requested response format - either json or pjson (pretty json).

Default
json
Enumerated values
json
Click to copy
pjson
Click to copy

token

The authentication token with the premium:user:places privilege, used to access the Places service.

The token parameter can be either an API Key or short-lived token. See ArcGIS security documentation for more information on authenticating with a token or API key.

Alternatively, you can supply a token in the request header with one of the following keys using the "Bearer" scheme:

  • Authorization: Bearer <YOUR_TOKEN>
  • X-Esri-Authorization: Bearer <YOUR_TOKEN>

Path parameters

NameTypeRequiredDefault valueDescription

The ID of the category that you want to fetch details for.

categoryId

The ID of the category that you want to fetch details for.

For example, using a category ID of 13035 would fetch details about the "Coffee Shop" category.

Examples

Request

Use dark colors for code blocksCopy
1
2
3
# You can also use wget
curl -X GET https://places-api.arcgis.com/arcgis/rest/services/places-service/v1/categories/{categoryId} \
  -H 'Accept: application/json'

Response

200 Response

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "categoryId": "17119",
  "fullLabel": [
    [
      "Retail",
      "Sporting Goods Retail",
      "Bicycle Store"
    ]
  ],
  "parents": [
    [
      "17117"
    ]
  ]
}
StatusMeaningDescriptionSchema

200

OK

A successful request to return details for a single category.

CategoryDetails

400

Bad Request

Invalid query parameters.

Error

401

Unauthorized

Authentication Error. The API key or token is missing, invalid or expired.

Error

403

Forbidden

The required parameter 'token' is valid but does not have permission to access the service.

Error

404

Not Found

A resource with the supplied Id was not found.

Error

5XX

Unknown

An error occurred on the server.

Error

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.