> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.caresquareapi.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.caresquareapi.com/_mcp/server.

# List participants

GET https://api.caresquareapi.com/api/public/v1/participants

Paginated list of participants for the plan manager. Optional filters: status, state, account_manager, participant_number. Requires X-Plan-Manager-Id header.

Reference: https://docs.caresquareapi.com/api-reference/contacts/participants/list-participants

## Authentication

- `Authorization` header (bearer token, required) — API key issued for your account. Send as Bearer token in the Authorization header.
- `X-Plan-Manager-Id` header (required) — Plan manager UUID. Required on all public API requests to scope data access.

## Request

### Query parameters

- `status` (enum, optional) — Filter by status
  - Allowed values: `Active`, `Inactive`, `Lead`
- `state` (enum, optional) — Filter by state
  - Allowed values: `nsw`, `qld`, `vic`, `sa`, `wa`, `tas`, `act`, `nt`
- `account_manager` (string, optional) — Filter by account manager user IDs (comma-separated UUIDs)
- `participant_number` (string, optional) — Filter by NDIS participant number
- `limit` (integer, optional, default: 20) — Items per page (max 1000)
- `offset` (integer, optional, default: 0) — Number of items to skip. Cannot be combined with after.
- `after` (string, optional) — Keyset cursor. Returns records after this id (or error_code for the error catalogue), ordered by that field ascending. Pass pagination.next_cursor from the previous page. Start a cursor walk with after=0. Cannot be combined with a non-zero offset.

## Response

### 200

List of participants

- `data` (list of ParticipantResponse, required)
- `pagination` (PaginationMeta, required)

## Errors

### 400 Bad Request Error

Invalid request parameters

- `success` (boolean, optional)
- `error` (string, optional) — Error type or code
- `detail` (string, optional) — Human-readable error message

### 403 Forbidden Error

Access denied for plan manager

- `success` (boolean, optional)
- `error` (string, optional) — Error type or code
- `detail` (string, optional) — Human-readable error message

### 500 Internal Server Error

Internal server error

- `success` (boolean, optional)
- `error` (string, optional) — Error type or code
- `detail` (string, optional) — Human-readable error message

## Types

### ParticipantResponse

Participant returned by the list endpoint (enriched with plan info and account manager).

- `id` (string, optional) — Unique identifier
- `first_name` (string, optional, nullable)
- `middle_name` (string, optional, nullable)
- `last_name` (string, optional, nullable)
- `preferred_name` (string, optional, nullable) — Preferred / display name
- `participant_number` (string, optional, nullable) — NDIS participant number
- `email` (string, optional, nullable) — Contact email
- `phone_number` (string, optional, nullable)
- `date_of_birth` (date, optional, nullable)
- `gender` (string, optional, nullable)
- `pronouns` (string, optional, nullable)
- `state` (string, optional, nullable) — State (e.g. nsw
- `postcode` (string, optional, nullable) — 4-digit postcode
- `address_line_1` (string, optional, nullable)
- `address_line_2` (string, optional, nullable)
- `city` (string, optional, nullable)
- `service_region_id` (string, optional, nullable) — Service region (remote / very_remote)
- `status` (enum, optional, nullable)
  - Allowed values: `Active`, `Inactive`, `Lead`
- `approval_required` (boolean, optional, nullable) — Whether invoice approval is required
- `onboard_date` (date, optional, nullable)
- `created_at` (datetime, optional, nullable)
- `date_ceased` (date, optional, nullable)
- `reason_for_leaving` (string, optional, nullable) — Free-text reason for leaving
- `exit_reason_category` (ExitReasonRef, optional) — Reference to an exit reason category/subcategory (present only when set).
- `exit_reason_subcategory` (ExitReasonRef, optional) — Reference to an exit reason category/subcategory (present only when set).
- `account_manager` (AccountManagerRef, optional) — Account manager identity (id + name).
- `is_pace_plan` (boolean, optional, nullable) — Whether the current plan is PACE
- `plan_start_date` (string, optional, nullable) — Current plan start date
- `plan_end_date` (string, optional, nullable) — Current plan end date
- `postal_statement` (boolean, optional, nullable) — Whether statements are posted
- `participant_receives_statements` (boolean, optional, nullable) — Whether the participant is emailed statements

### PaginationMeta

- `limit` (integer, required) — Maximum number of items per page
- `offset` (integer, required) — Number of items skipped
- `has_more` (boolean, required) — Whether there are more items after this page
- `total` (integer, optional, nullable) — Total matching items. Null for cursor pagination, which skips a full-table count.
- `next_cursor` (string, optional, nullable) — Pass as `after` to fetch the next page. Set when using cursor pagination and has_more is true.

### ExitReasonRef

Reference to an exit reason category/subcategory (present only when set).

- `id` (string, optional)
- `name` (string, optional) — Friendly name

### AccountManagerRef

Account manager identity (id + name).

- `id` (string, optional, nullable) — User ID
- `name` (string, optional, nullable) — Full name

## Examples

**Response**

```json
{
  "data": [
    {
      "id": "string",
      "first_name": "string",
      "middle_name": "string",
      "last_name": "string",
      "preferred_name": "string",
      "participant_number": "string",
      "email": "string",
      "phone_number": "string",
      "date_of_birth": "2023-01-15",
      "gender": "string",
      "pronouns": "string",
      "state": "string",
      "postcode": "string",
      "address_line_1": "string",
      "address_line_2": "string",
      "city": "string",
      "service_region_id": "string",
      "status": "Active",
      "approval_required": true,
      "onboard_date": "2023-01-15",
      "created_at": "2024-01-15T09:30:00Z",
      "date_ceased": "2023-01-15",
      "reason_for_leaving": "string",
      "exit_reason_category": {
        "id": "string",
        "name": "string"
      },
      "exit_reason_subcategory": {
        "id": "string",
        "name": "string"
      },
      "account_manager": {
        "id": "string",
        "name": "string"
      },
      "is_pace_plan": true,
      "plan_start_date": "string",
      "plan_end_date": "string",
      "postal_statement": true,
      "participant_receives_statements": true
    }
  ],
  "pagination": {
    "limit": 1,
    "offset": 1,
    "has_more": true,
    "total": 1,
    "next_cursor": "string"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.caresquareapi.com/api/public/v1/participants"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.caresquareapi.com/api/public/v1/participants';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.caresquareapi.com/api/public/v1/participants"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.caresquareapi.com/api/public/v1/participants")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.caresquareapi.com/api/public/v1/participants")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.caresquareapi.com/api/public/v1/participants', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.caresquareapi.com/api/public/v1/participants");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.caresquareapi.com/api/public/v1/participants")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```