List of Categories
GET /v1/entities/category
Retrieves a list of categories.
Request Parameters
Location | Parameter | Type | Required/ Optional | Description |
---|---|---|---|---|
query | cursor |
string | optional | The cursor id of the first record to return. Example: mood |
query | id |
string | optional | Filter. Will match to records whose id contains the given string |
query | limit |
number | optional | The number of records to return. May be a value between 1 and 100 inclusive. If a value is not specified, the default is 10 |
query | name |
string | optional | Filter. Will match to records whose name contains the given string |
query | offset |
number | optional | The numeric offset of the first record to return. May be a value between 1 and 100,000 inclusive |
For a description of how to use these query parameters, see Pagination.
Example Request
Header
GET /v1/entities/category?offset=0&limit=2 HTTP/1.1
Host: api.ampermusic.com
Content-Type: application/vnd.api+json
Authorization: Basic abcxyz
Response Data
Data Item | Type | Description |
---|---|---|
data |
array | |
data[].attributes |
object | |
data[].attributes.name |
string | The string name of the category |
data[].id |
string | The string id of the category |
data[].links |
object | |
data[].links.self |
string | The URL of the category |
data[].type |
string | The type of data (entity_category in this case) |
links |
object | |
links.first |
string | The URL of the first (or possibly only) page of results. It is always available |
links.next |
string | The URL of the next page of results when using offset/limit mode. It is omitted if there are no additional pages and is available on the first page, and on any subsequent page, accessed with offset/limit mode |
links.next_cursor |
string | The URL of the next page of results when using cursor/limit mode. It is omitted if there are no additional pages and is available on the first page, and on any subsequent page, accessed with cursor/limit mode |
links.prev |
string | The URL of the previous page of results when using offset/limit mode. It is omitted if there is no previous page and is not available in cursor/limit mode |
links.self |
string | The URL of this list of categories |
Example Response
Header
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
Body
{
"data": [
{
"attributes": {
"name": "Instrument Type"
},
"id": "instrument_type",
"links": {
"self": "https://api.ampermusic.com/v1/entities/category/instrument_type"
},
"type": "entity_category"
},
{
"attributes": {
"name": "Mood"
},
"id": "mood",
"links": {
"self": "https://api.ampermusic.com/v1/entities/category/mood"
},
"type": "entity_category"
}
],
"links": {
"first": "https://api.ampermusic.com/v1/entities/category?limit=2",
"next": "https://api.ampermusic.com/v1/entities/category?limit=2&offset=2",
"next_cursor": "https://api.ampermusic.com/v1/entities/category?cursor=style&limit=2",
"prev": "https://api.ampermusic.com/v1/entities/category?limit=2",
"self": "https://api.ampermusic.com/v1/entities/category?limit=2"
}
}