Skip to content

List all parties

GET
/parties
curl --request GET \
--url 'http://localhost:8000/api/v1/parties?limit=20' \
--header 'Authorization: Bearer <token>'
limit
integer
default: 20

Number of items to return per page

synced_since
string format: date-time

Get recent changes after this date

no_client_id
boolean

Get results with no client id

Successful response

Media type application/json
object
last_sync
string format: date-time
data
Array<object>
object
id

ID of the party

integer
type

Type of the party

string
name

Name of the party

string
description

Description of the party

string
icon

Party icon

object
id

ID of the icon

integer
path

Image of the icon

string
type

Type of icon( image or icon or emoji)

string
Example generated
{
"last_sync": "2026-04-15T12:00:00Z",
"data": [
{
"id": 1,
"type": "example",
"name": "example",
"description": "example",
"icon": {
"id": 1,
"path": "example",
"type": "example"
}
}
]
}

Unauthorized

Server error