Sign in
protocol_groups

Get Protocol Group

Get a single protocol group by ID.

Parameters

group_id : str ID of the group to retrieve.

Returns

ProtocolGroup The requested group.

Raises

NotFoundError If the group does not exist or belongs to another organization.

get/protocol_groups/{group_id}

Path parameters

group_idstring required

Response

Successful Response

idstring nullable

Unique identifier for the group

namestring required

Name of the group, unique within the project

descriptionstring nullable

Optional note on what relates the protocols in this group

organization_idstring required

ID of the organization that owns this group

project_idstring required

ID of the project that owns this group

created_bystring nullable

User ID of the user who created this group

created_atstring nullable

When the group was created

updated_atstring nullable

When the group was last updated

protocol_countinteger nullable

Number of protocols in this group. Present on list responses, None when the group is fetched on its own.

created_by_emailstring nullable

Email of the user who created this group

Changes

No recorded changes to this endpoint across all 1 revision of this API.