Skip to content
Developers
No results found.

List Categories

Scopes
read:auth-plus-category

Query Parameters

fields
string | array<string>

Include only defined fields. You can pass this parameter multiple times or you can include all values separated by commas.

Examples: "id,created_at" 

limit
integer
min-1
max
500

Limit the number of results returned

Examples: 5 

offset
integer
min0
max
99999999999999

Page number of records you wish to skip before selecting records. Final skipped records count would be limit * offset.

q
string

Additional query in PlusAuth Query Language format.

sort_by
string | array<string>

Properties that should be ordered by, with their ordering type. To define order type append it to the field with dot. You can pass this parameter multiple times or you can include all values separated by commas.

Examples: "id.asc,created_at.desc" "email.asc" 

GET
/api/v1/auth-plus/categories
cURL
cURLC#DartGoJavaJavaScriptPHPPythonRubyRustSwift
1
2
3
Loading...
Response
200
Paginated list of categories
Loading...

Response Body Schema

total
integer
Required
results
array<object>
results.
created_at
string
Required

Creation date in the ISO 8601 format according to universal time.

results.
id
string
Required
length
0-36

Unique identifier of entity

results.
name
string
Required
length
0-256

Category name

results.
order
number
min0
max
65535

Category order

results.
updated_at
string

Update date in the ISO 8601 format according to universal time.