> ## Documentation Index > Fetch the complete documentation index at: https://docs.ionworks.com/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml https://api.ionworks.com/openapi.json get /protocol_groups openapi: 3.1.0 info: title: FastAPI version: 0.1.0 servers: - url: https://api.ionworks.com description: Production security: [] paths: /protocol_groups: get: tags: - protocol_groups summary: List Protocol Groups description: >- 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. operationId: list_protocol_groups_protocol_groups_get parameters: - name: project_id in: query required: true schema: type: string title: Project Id - name: limit in: query required: false schema: anyOf: - type: integer maximum: 100 minimum: 1 - type: 'null' title: Limit - name: offset in: query required: false schema: anyOf: - type: integer minimum: 0 - type: 'null' title: Offset - name: name in: query required: false schema: anyOf: - type: string - type: 'null' title: Name - name: created_by_email in: query required: false schema: anyOf: - type: string - type: 'null' title: Created By Email - name: created_at in: query required: false schema: anyOf: - type: string - type: 'null' title: Created At - name: created_at_gt in: query required: false schema: anyOf: - type: string - type: 'null' title: Created At Gt - name: created_at_lt in: query required: false schema: anyOf: - type: string - type: 'null' title: Created At Lt - name: updated_at in: query required: false schema: anyOf: - type: string - type: 'null' title: Updated At - name: updated_at_gt in: query required: false schema: anyOf: - type: string - type: 'null' title: Updated At Gt - name: updated_at_lt in: query required: false schema: anyOf: - type: string - type: 'null' title: Updated At Lt - name: order_by in: query required: false schema: enum: - name - created_at - updated_at type: string default: created_at title: Order By - name: order in: query required: false schema: enum: - asc - desc type: string default: desc title: Order responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ProtocolGroupListResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' components: schemas: ProtocolGroupListResponse: properties: items: items: $ref: '#/components/schemas/ProtocolGroup' type: array title: Items count: type: integer title: Count total: type: integer title: Total type: object required: - items - count - total title: ProtocolGroupListResponse description: Paginated list of protocol groups. HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError ProtocolGroup: properties: id: anyOf: - type: string - type: 'null' title: Id description: Unique identifier for the group name: type: string title: Name description: Name of the group, unique within the project description: anyOf: - type: string - type: 'null' title: Description description: Optional note on what relates the protocols in this group organization_id: type: string title: Organization Id description: ID of the organization that owns this group project_id: type: string title: Project Id description: ID of the project that owns this group created_by: anyOf: - type: string - type: 'null' title: Created By description: User ID of the user who created this group created_at: anyOf: - type: string - type: 'null' title: Created At description: When the group was created updated_at: anyOf: - type: string - type: 'null' title: Updated At description: When the group was last updated protocol_count: anyOf: - type: integer - type: 'null' title: Protocol Count description: >- Number of protocols in this group. Present on list responses, None when the group is fetched on its own. created_by_email: anyOf: - type: string - type: 'null' title: Created By Email description: Email of the user who created this group type: object required: - name - organization_id - project_id title: ProtocolGroup description: Database entity for a protocol group. ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError ````