> For the complete documentation index, see [llms.txt](https://peoplescourt.ai/llms.txt). This page is also available as Markdown.

# List registered partner callback endpoints

Partner platforms: requires a partner key with callbacks:manage and the platform_orchestrator role. List registered partner callback endpoints. All results are tenant scoped.

Reference

Webhooks

GET

live

`/api/webhooks/endpoints`

`listWebhookEndpoints`

## Authentication and authority

Send one of the allowed bearer credential roles. Alternatives are OR; credentials named within one alternative are AND.

`platformOrchestratorBearer`

Credential bound to the platform_orchestrator role.

## Parameters

This operation has no path, query, or header parameters.

## Responses

### 200

Authorized operation result.

application/json

```json
{
  "$ref": "#/components/schemas/CanonicalListWebhookEndpointsResponse",
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/CanonicalWebhookEndpointList",
      "type": "object",
      "properties": {
        "schemaVersion": {
          "type": "string",
          "const": "partner-webhook-endpoints-v2"
        },
        "endpoints": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/CanonicalWebhookEndpoint",
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "partnerId": {
                "type": "string"
              },
              "url": {
                "type": "string"
              },
              "status": {
                "type": "string",
                "enum": [
                  "active",
                  "retiring",
                  "disabled"
                ]
              },
              "signatureVersion": {
                "type": "string",
                "const": "pc-webhook-ed25519-v1"
              },
              "replacesEndpointId": {
                "type": "string"
              },
              "overlapUntil": {
                "type": "string"
              },
              "createdAt": {
                "type": "string"
              },
              "updatedAt": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "partnerId",
              "url",
              "status",
              "signatureVersion",
              "createdAt",
              "updatedAt"
            ]
          }
        }
      },
      "required": [
        "schemaVersion",
        "endpoints"
      ]
    },
    "requestId": {
      "type": "string"
    }
  },
  "required": [
    "data",
    "requestId"
  ]
}
```

### default

RFC 9457 style problem response.

application/problem+json

```json
{
  "$ref": "#/components/schemas/Problem",
  "type": "object",
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "requestId"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer"
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    },
    "details": {
      "description": "Account-readiness refusals include a value-free checklist and exact account-page link. Other error codes may provide different details.",
      "anyOf": [
        {
          "$ref": "#/components/schemas/AccountReadinessDetails",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "ready",
            "accountSetupUrl",
            "missing"
          ],
          "properties": {
            "ready": {
              "type": "boolean"
            },
            "accountSetupUrl": {
              "type": "string",
              "format": "uri"
            },
            "missing": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/AccountReadinessRequirement",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "label",
                  "section",
                  "accountUrl"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "section": {
                    "type": "string",
                    "enum": [
                      "email",
                      "identity",
                      "legal_documents"
                    ]
                  },
                  "accountUrl": {
                    "type": "string",
                    "format": "uri"
                  }
                }
              }
            }
          }
        },
        {
          "$ref": "#/components/schemas/LegalDocumentsRequiredDetails",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "legalDocumentsUrl"
          ],
          "properties": {
            "legalDocumentsUrl": {
              "type": "string",
              "format": "uri",
              "description": "Absolute account-page URL where the person reviews and accepts the current Terms and Privacy Notice. Uses the configured public application origin. After accepting the documents, retry the original operation."
            },
            "ready": {
              "type": "boolean"
            },
            "accountSetupUrl": {
              "type": "string",
              "format": "uri"
            },
            "missing": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/AccountReadinessRequirement",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "label",
                  "section",
                  "accountUrl"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "section": {
                    "type": "string",
                    "enum": [
                      "email",
                      "identity",
                      "legal_documents"
                    ]
                  },
                  "accountUrl": {
                    "type": "string",
                    "format": "uri"
                  }
                }
              }
            }
          }
        },
        {}
      ]
    }
  }
}
```

## Example response

### Successful response

```json
{
  "data": {
    "schemaVersion": "partner-webhook-endpoints-v2",
    "endpoints": [
      {
        "id": "id_test",
        "partnerId": "partner_test_123",
        "url": "https://partner.test.example/callbacks/peoples-court",
        "status": "active",
        "signatureVersion": "pc-webhook-ed25519-v1",
        "createdAt": "createdAt_test",
        "updatedAt": "updatedAt_test"
      }
    ]
  },
  "requestId": "requestId_test"
}
```

## Errors

Read the response status and stable error code. See [errors](https://peoplescourt.ai/docs/api/errors.md) and [rate limits](https://peoplescourt.ai/docs/api/rate-limits.md) for recovery. Refresh the resource before resolving a state or digest conflict.

## Idempotency and retries

- For throttling, honor Retry-After when present. Back off on retryable server failures.

## Request examples

Use `https://peoplescourt.ai` with the test credential issued for your integration.

```sh
curl --request GET \
  --url 'https://peoplescourt.ai/api/webhooks/endpoints' \
  --header 'Authorization: Bearer pk_test_replace_me'
```

```ts
const response = await fetch("https://peoplescourt.ai/api/webhooks/endpoints", {
  method: "GET",
  headers: {
    "Authorization": "Bearer pk_test_replace_me"
  },
});
if (!response.ok) throw await response.json();
const result = await response.json();
```

```python
import requests

response = requests.get(
    "https://peoplescourt.ai/api/webhooks/endpoints",
    headers={
      "Authorization": "Bearer pk_test_replace_me"
    },
    timeout=30,
)
response.raise_for_status()
result = response.json()
```