---
title: "List participants"
method: GET
path: "/v1/participants"
---

# List participants

`GET /v1/participants`

## Request

- Base URL: `https://api.condens.io`
- URL: `https://api.condens.io/v1/participants`
- Auth: HTTP bearer

## Query parameters

- `workspaceId` string
- `page` integer: Page number (starting at 1).
- `pageSize` integer: Number of items per page.
- `filter` string: JSON-encoded filter object
- `sort` string: Sort order: prefix with '-' for descending, omit for ascending.

## Response `200`

Participants page

- object
  - `page` integer, required: Page number (starting at 1).
  - `pageSize` integer, required: Number of items per page.
  - `total` integer, required
  - `totalPages` integer, required
  - `hasNext` boolean, required
  - `items` ParticipantListItem[], required
    - `id` string, required
    - `name` string, required
    - `workspaceId` string, required
    - `informationFields` InformationField[]
      - union
        - TextInformationField
          - `fieldName` string, required
          - `fieldType` 'text', required
          - `value` string, required
        - NumberInformationField
          - `fieldName` string, required
          - `fieldType` 'number', required
          - `value` integer, required
        - DateInformationField
          - `fieldName` string, required
          - `fieldType` 'date', required
          - `value` string, date, required
        - CheckboxInformationField
          - `fieldName` string, required
          - `fieldType` 'checkbox', required
          - `value` boolean, required
        - SingleSelectInformationField
          - `fieldName` string, required
          - `fieldType` 'single_select', required
          - `value` string, required
        - MultiSelectInformationField
          - `fieldName` string, required
          - `fieldType` 'multi_select', required
          - `value` string[], required
        - ParticipantsInformationField
          - `fieldName` string, required
          - `fieldType` 'participant', required
          - `value` union[], required
            - union
              - …
        - UserInformationField
          - `fieldName` string, required
          - `fieldType` 'user', required
          - `value` union[], required
            - union
              - …
        - UrlInformationField
          - `fieldName` string, required
          - `fieldType` 'url', required
          - `value` string, uri, required
        - EmailInformationField
          - `fieldName` string, required
          - `fieldType` 'email', required
          - `value` string, email, required
        - NpsInformationField
          - `fieldName` string, required
          - `fieldType` 'nps', required
          - `value` integer, required
    - `updatedAt` string, date-time, required: ISO-8601 timestamp of last update

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/condens/apis/condens-api.md) · [All operations](https://skmtc.dev/condens/apis/condens-api/llms.txt) · [OpenAPI document](https://skmtc.dev/condens/apis/condens-api/revisions/7b93612e150f?raw)