---
title: "List participant pools"
method: GET
path: "/participant-pools"
tags: ["Participant Pools"]
---

# List participant pools

`GET /participant-pools`

Returns a paginated list of participant pools

## Query parameters

- `limit` integer
- `skip` integer

## Response `200`

A directory with a `data` property that contains an array of up to `limit` participant pools, starting after `skip`. Each entry in the array is a separate participant pool object. If no more pools are available, the resulting array will be empty. This request should never return an error.

- object
  - `data` ParticipantPool[]
    - `id` string — Unique identifier for the participant pool
    - `ownerId` string — ID of the user who owns this pool
    - `teamId` string — Optional team ID this pool belongs to
    - `name` string, required — Display name of the participant pool
    - `description` string — Description of the participant pool
    - `visibility` 'PRIVATE' | 'PUBLIC' | 'TEAM' | 'INTERNAL_TEAM' | 'EXTERNAL_TEAM', required — Defines who can use/consume this participant pool
    - `members` ParticipantPoolMember[] — List of members in this pool
      - `publicId` string, required — Public identifier of the pool member
      - `createdAt` string, date-time — Timestamp when the member was added to the pool
      - `updatedAt` string, date-time — Timestamp when the member was last updated
      - `roles` ParticipantPoolMemberRoleEnum[], required — Roles assigned to this member in the pool
      - `name` string — Name of the member
      - `email` string — Email of the member
    - `invitations` ParticipantPoolInvitation[] — List of pending invitations to join this pool
      - `id` string — Unique identifier for the invitation
      - `name` string, required — Name of the person being invited
      - `email` string, required — Email address of the person being invited
      - `roles` ParticipantPoolMemberRoleEnum[], required — Roles that will be assigned to the member when they accept the invitation
      - `createdAt` string, date-time — Timestamp when the invitation was created
      - `expiresAt` string, date-time — Timestamp when the invitation expires
    - `rules` ParticipantPoolRule[] — List of rules that define various constraints and requirements for this pool (e.g., membership eligibility, pricing criteria, etc.)
      - `id` string — Unique identifier for the rule
      - `name` string, required — Human-readable rule name (e.g., "department", "experience_years")
      - `description` string — Detailed description of what this rule validates
      - `dataType` 'STRING' | 'NUMBER' | 'BOOLEAN' | 'DATE', required — Data type for participant pool rule values
      - `selectionMode` 'SINGLE' | 'MULTIPLE' | 'RANGE' | 'FREEFORM', required — Selection mode for participant pool rule values
      - `allowedValues` union[] — Predefined values for SINGLE/MULTIPLE selection modes
        - union
          - string
          - number
          - boolean
      - `values` union[] — Actual selected/assigned values for this rule instance
        - union
          - string
          - number
          - boolean
      - `constraints` ParticipantPoolRuleConstraints — Additional validation constraints for Participant Pools - Rules
        - `minValue` number — Minimum numeric value (for NUMBER dataType)
        - `maxValue` number — Maximum numeric value (for NUMBER dataType)
        - `minLength` integer — Minimum string length (for STRING dataType)
        - `maxLength` integer — Maximum string length (for STRING dataType)
        - `pattern` string — Regular expression pattern for string validation (for STRING dataType)
        - `minDate` string, date — Minimum date value (for DATE dataType)
        - `maxDate` string, date — Maximum date value (for DATE dataType)
      - `createdAt` string, date-time — Timestamp when the rule was created
      - `updatedAt` string, date-time — Timestamp when the rule was last updated
      - `isEditable` boolean — Whether this rule is editable
    - `advancedOptions` ParticipantPoolAdvancedOptions — Advanced configuration options for participant pools
      - `inlineWebhook` InlineWebhook — unresolved $ref
  - `hasMore` boolean — Indicates if there are more pools to fetch
  - `total` integer — Total number of pools matching the filter criteria

---

[API](https://skmtc.net/pactima/apis/esignature-packages-api.md) · [All operations](https://skmtc.net/pactima/apis/esignature-packages-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pactima/esignature-packages-api/revisions/1570128383ef/schema)