---
title: "Get Participant Data For Pm"
method: GET
path: "/api/v2/retool/participants/participant-data"
tags: ["v2", "Participants"]
---

# Get Participant Data For Pm

`GET /api/v2/retool/participants/participant-data`

Returns participants data 

Requestor must have authority to access (be the partipants assigned plan_manager)

## Query parameters

- `participant_id` string, uuid, required

## Response `200`

Successful Response

- ApiResponseJSONParticipantsModel
  - `data` ParticipantsModel[] — List of items returned in the response following given criteria
    - `id` string, uuid, nullable
    - `first_name` string, nullable
    - `middle_name` string, nullable
    - `last_name` string, nullable
    - `service_region_id` string, nullable
    - `postcode` string, nullable
    - `participant_number` integer, nullable
    - `status` string, nullable
    - `status_category` integer, nullable
    - `plan_manager` string, uuid, nullable
    - `shortcode` string, nullable
    - `xero_item_ref` string, uuid, nullable
    - `created_at` string, date-time, nullable
    - `xero_status` string, nullable
    - `approval_email` string, nullable
    - `last_modified_by` string, nullable
    - `modified_at` string, date-time, nullable
    - `approval_required` boolean, nullable
    - `alias_first` string, nullable
    - `alias_last` string, nullable
    - `account_manager` string, nullable
    - `date_of_birth` string, date, nullable
    - `phone_number` string, nullable
    - `is_pace_plan` boolean, nullable
    - `statement_period` unknown
    - `statements_email` string, nullable
    - `gender` string, nullable
    - `title` string, nullable
    - `preferred_name` string, nullable
    - `contact_email` string, nullable
    - `setup_fee` boolean, nullable
    - `approval_timeout` integer, nullable
    - `address_line_1` string, nullable
    - `address_line_2` string, nullable
    - `city` string, nullable
    - `state` string, nullable
    - `bsb` string, nullable
    - `bank_account_number` string, nullable
    - `custom_fields` unknown
    - `primary_disability` string, nullable
    - `xero_contact_id` string, uuid, nullable
    - `klaviyo_id` string, nullable
    - `date_ceased` string, date, nullable
    - `reason_for_leaving` string, nullable
    - `aboroginal_torres_strait` string, nullable
    - `preferred_communication` string, nullable
    - `pronouns` string, nullable
    - `participant_approved` boolean, nullable
    - `approval_list` unknown
  - `meta` ApiResponseMeta — Standardised Api Response Meta Not always required (except for example; with paginated results) Future: Could provide base that includes org information, copy-write etc
    - `processing_time_ms` integer, nullable
    - `total_records` integer, nullable
    - `page` integer, nullable
    - `limit` integer, nullable
    - `count` integer, nullable
    - `cursor` unknown
    - `cursor_last` unknown
    - `more_data_available` boolean, nullable
  - `messages` ApiResponseMessage[], nullable — Response Messages
    - `message_type` 'debug' | 'info' | 'warning' | 'error', required
    - `message` string, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/caresquare/apis/fastapi.md) · [All operations](https://skmtc.dev/caresquare/apis/fastapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/caresquare/fastapi/revisions/c9df874d8d59/schema)