# Pro Convey API

## Docs

- [Archive case](https://docs.proconvey.co.uk/api-reference/cases/archive-case.md): Soft-archive a case by ID.
- [Create a new case](https://docs.proconvey.co.uk/api-reference/cases/create-a-new-case.md): Creates a new case with the specified type, branch, fee earner, and property details.
- [Get case](https://docs.proconvey.co.uk/api-reference/cases/get-case.md): Returns detailed information about a specific case by ID.
- [Get case data](https://docs.proconvey.co.uk/api-reference/cases/get-case-data.md): Returns comprehensive data associated with a specific case.
- [Get case representatives](https://docs.proconvey.co.uk/api-reference/cases/get-case-representatives.md): Returns all representatives associated with a specific case.
- [List case documents](https://docs.proconvey.co.uk/api-reference/cases/list-case-documents.md): Returns all documents associated with a specific case, with optional filtering by category.
- [List cases](https://docs.proconvey.co.uk/api-reference/cases/list-cases.md): Returns a paginated list of cases. Archived cases are excluded unless includeArchived=true.
- [Get client](https://docs.proconvey.co.uk/api-reference/clients/get-client.md): Returns a single client by ID for the authenticated organisation. Same shape as each item in GET /api/v2/clients.
- [List clients](https://docs.proconvey.co.uk/api-reference/clients/list-clients.md): Returns a paginated list of clients for the authenticated organisation. Sensitive fields (invite codes, search vectors, internal IDs) are omitted.
- [Get organisation details](https://docs.proconvey.co.uk/api-reference/organisations/get-organisation-details.md): Returns basic details about the current organisation.
- [List branches](https://docs.proconvey.co.uk/api-reference/organisations/list-branches.md): Returns a list of branches for the organization.
- [List fee earners for a branch](https://docs.proconvey.co.uk/api-reference/organisations/list-fee-earners-for-a-branch.md): Returns all team members who are designated as fee earners for the specified branch.
- [List introducers](https://docs.proconvey.co.uk/api-reference/organisations/list-introducers.md): Returns a list of introducers for the organisation. Use the `id` field when creating a case with an associated introducer.
- [Get OpenAPI specification](https://docs.proconvey.co.uk/api-reference/system/get-openapi-specification.md): Returns the OpenAPI specification for the v2 API
- [Case archived](https://docs.proconvey.co.uk/api-reference/webhooks/case-archived.md): Triggered when a case is archived (soft-deleted). Fired from the case update subscriber when the case becomes archived.
- [Case created](https://docs.proconvey.co.uk/api-reference/webhooks/case-created.md): Triggered when a new case is created in the system
- [Case updated](https://docs.proconvey.co.uk/api-reference/webhooks/case-updated.md): Triggered when case details are modified
- [Onboarding completed](https://docs.proconvey.co.uk/api-reference/webhooks/onboarding-completed.md): Triggered when onboarding completion notifications are created (same moment as conveyancer DSR/onboarding emails). A second delivery may be sent to the referring estate agent’s webhook when a referred case completes onboarding.
- [Task completed](https://docs.proconvey.co.uk/api-reference/webhooks/task-completed.md): Triggered when a task on a case moves to Completed (from any non-Completed status).

## OpenAPI Specs

- [doc](https://v2.proconvey.co.uk/api/v2/doc)