list
GET /category
GET
/category
Lists all categories.
Parameters
Query Parameters
page
number
Page number starting at 1
Example
1
perPage
number
Items per page
Example
5
sort
string
Sort string (-/+
Example
-created
filter
string
Filter string (https://pocketbase.io/docs/api-rules-and-filters/#filters-syntax)
Example
name="abc"
expand
string
Expand a foreign key column (https://pocketbase.io/docs/working-with-relations/#expanding-relations).
Example
id
requestKey
string
Unique request key. Prevents auto cancel when sending multiple requests.
Example
my-key
Responses
200
object
page
required
integer
perPage
required
integer
totalItems
required
integer
totalPages
required
integer
items
required
Array<object>
object
collectionId
required
string
collectionName
required
string
created
required
string
id
required
string
img
required
string
name
required
string
updated
required
string
Examples
Success
{ "page": 1, "perPage": 5, "totalItems": 6, "totalPages": 2, "items": [ { "collectionId": "kjxvi8asj2igqwf", "collectionName": "categories", "created": "2024-06-29 19:23:12.632Z", "id": "8m2qclsl6p8at9k", "img": "hiking_EwOAWJFKCg.jpg", "name": "Hiking", "updated": "2024-06-29 19:23:12.632Z" }, { "collectionId": "kjxvi8asj2igqwf", "collectionName": "categories", "created": "2024-06-29 19:23:12.648Z", "id": "x5y2ikswxzoznek", "img": "walking_YOtlMqoDps.jpg", "name": "Walking", "updated": "2024-06-29 19:23:12.648Z" }, { "collectionId": "kjxvi8asj2igqwf", "collectionName": "categories", "created": "2024-06-29 19:23:12.658Z", "id": "9ecf7bunl88bt4k", "img": "climbing_vRyCdFwURk.jpg", "name": "Climbing", "updated": "2024-06-29 19:23:12.658Z" }, { "collectionId": "kjxvi8asj2igqwf", "collectionName": "categories", "created": "2024-06-29 19:23:12.669Z", "id": "pbwx1lg2nmcih0w", "img": "skiing_KdUASbxv4C.jpg", "name": "Skiing", "updated": "2024-06-29 19:23:12.669Z" }, { "collectionId": "kjxvi8asj2igqwf", "collectionName": "categories", "created": "2024-06-29 19:23:12.679Z", "id": "7sqwezntokmbvdr", "img": "canoeing_QBmwxRx6uh.jpg", "name": "Canoeing", "updated": "2024-06-29 19:23:12.679Z" } ]}
400
object
message
required
string
detail
required
Array<object>
object
code
string
minimum
integer
type
string
inclusive
boolean
exact
boolean
message
string
path
Array<string>
Examples
Exception
{ "message": "invalid_params", "detail": [ { "code": "too_small", "minimum": 0, "type": "number", "inclusive": false, "exact": false, "message": "Number must be greater than 0", "path": [ "page" ] } ]}
x-400:Invalid sort/expand/filter
object
message
required
string
detail
required
object
code
required
integer
message
required
string
data
required
object
Examples
Exception
{ "message": "Something went wrong while processing your request.", "detail": { "code": 400, "message": "Something went wrong while processing your request.", "data": {} }}