Skip to content

Get a specific group

GET
/groups/{id}
curl --request GET \
--url http://localhost:8000/api/v1/groups/1 \
--header 'Authorization: Bearer <token>'
id
required
integer

ID of the group

Successful operation

Media type application/json
object
id

ID of the group

integer
name

Name of the group

string
description

Description of the group

string
icon

Category icon

object
id

ID of the icon

integer
path

Image of the icon

string
type

Type of icon( image or icon or emoji)

string
sync_state

Sync state

object
id

ID of the sync state

integer
syncable_id

ID of the syncable

integer
client_generated_id

ID from the client

integer
syncable_type

Syncable type

string
source
string
last_synced_at

Date last synced

string format: date-time
created_at

Date created

string format: date-time
deleted_at

Date deleted

string format: date-time
Example generated
{
"id": 1,
"name": "example",
"description": "example",
"icon": {
"id": 1,
"path": "example",
"type": "example"
},
"sync_state": {
"id": 1,
"syncable_id": 1,
"client_generated_id": 1,
"syncable_type": "example",
"source": "example",
"last_synced_at": "2026-04-15T12:00:00Z",
"created_at": "2026-04-15T12:00:00Z",
"deleted_at": "2026-04-15T12:00:00Z"
}
}

Group not found

Internal server error