CATEGORIES

Categories are a broader term used to describe what type of thing the Item is. These differ from subjects in that describe what an Item 'is', rather than what it might be 'about'. An example of a Category is 'Musical Instruments' or 'Ceramics'.

GET

Example

/api/v1/category/json/?api_key={your_key}&name=tec

/api/v1/category/82/items/json/?api_key={your_key}

 
 

Parameters

inherit

&start={x} start at item number x (integer, optional, default=0)

&limit={x} reurn x items in list (integer, optional, maximum=100, default=50)

 
 

Filters

inherit

'begins' Matches for when the term is at the start of the field only.

'ends' Matches for when the term is at the and of the field only.

'lt' Does a less than comparison.

'lte' Does a less than or equal to comparison.

'gt' Does a greater than comparison.

'gte' Does a greater than or equal to comparison.

'in' Term may have multiple comma separated values any of which is matched for in field via a 'contains' search.

'exact' Field must match term exactly (case sensitive).

'isblank' If term is 1 this filter matches when the field is empty, null or zero.

Use &{field}_isblank=0 to only return results where the field has some content.

So to find all collections where the name of the collection begins with 'tyrrell' use:

/api/{version}/collection/{response_format}/?api_key={your_key}&name_begins=tyrrell