protocol_groups

List Protocol Groups

List a project's protocol groups.

project_id is required — groups are project-scoped, exactly like the protocols they group. Each item carries protocol_count, the number of protocols currently filed under it.

Parameters

project_id : str Project whose groups to list. limit : int | None, optional Page size, 1–100. When None, returns all groups. offset : int | None, optional Number of records to skip. order_by : {"name", "created_at", "updated_at"}, optional Column to sort by. Defaults to created_at. order : {"asc", "desc"}, optional Sort direction. Defaults to desc.

Returns

ProtocolGroupListResponse Page of groups plus the total number matching the filters.

get/protocol_groups

Query parameters

project_idstring required
limitinteger nullable
offsetinteger nullable
namestring nullable
created_by_emailstring nullable
created_atstring nullable
created_at_gtstring nullable
created_at_ltstring nullable
updated_atstring nullable
updated_at_gtstring nullable
updated_at_ltstring nullable
order_by'name' | 'created_at' | 'updated_at'
order'asc' | 'desc'

Response

Successful Response

countinteger required
totalinteger required

Changes