# Provision Public API

> Integrate with Provision conversations, clients, users, and addresses over HTTPS.

## Docs

- [Get site (address) details](https://dev-eve-docs.provisionapp.xyz/api-reference/address/get-site-address-details.md): Fetch a single site (the physical or virtual location associated with a conversation, sometimes called an address) by ID. Scoped to the partner the API key belongs to. Requires the `site:read` scope.
- [Get client details](https://dev-eve-docs.provisionapp.xyz/api-reference/client/get-client-details.md): Fetch a single client (the end customer of the partner) by ID. Returns the client identity and contact fields. Scoped to the partner the API key belongs to. Requires the `client:read` scope.
- [Get conversation context](https://dev-eve-docs.provisionapp.xyz/api-reference/conversation/get-conversation-context.md): Return the contextual data attached to a conversation (notes, key-value attributes, and related entities) without re-fetching the conversation itself. Useful when your integration already has the conversation row cached and only needs the side data. Requires the `conversation:read` scope.
- [Get conversation details](https://dev-eve-docs.provisionapp.xyz/api-reference/conversation/get-conversation-details.md): Fetch a single conversation by ID, scoped to the partner the API key belongs to. Use the `include` query parameter to expand related resources (assignee, sites, etc.) inline. Requires the `conversation:read` scope.
- [Update conversation](https://dev-eve-docs.provisionapp.xyz/api-reference/conversation/update-conversation.md): Update mutable fields on a conversation: assignee, status, priority, labels, and the free-form attribute map. Only the fields you include in the request body are modified; omitted fields are left as-is. Requires the `conversation:write` scope.
- [Service health check](https://dev-eve-docs.provisionapp.xyz/api-reference/system/service-health-check.md): Returns 200 OK with `{ "status": "ok" }` when the API is reachable and your API key is valid. Use this from your integration after deployment to confirm the credentials load correctly.
- [Get platform user details](https://dev-eve-docs.provisionapp.xyz/api-reference/user/get-platform-user-details.md): Fetch a single platform user (a Provision agent or administrator) by ID. Useful for resolving an assignee or actor reference returned by the conversation endpoints. Requires the `user:read` scope.
- [Authentication](https://dev-eve-docs.provisionapp.xyz/authentication.md): How Provision Public API keys are issued, sent, and rotated.
- [Introduction](https://dev-eve-docs.provisionapp.xyz/introduction.md): Integrate with Provision conversations, clients, users, and addresses over HTTPS.
- [Permissions](https://dev-eve-docs.provisionapp.xyz/permissions.md): The operation-scope model that controls which endpoints a key can call.
- [Quickstart](https://dev-eve-docs.provisionapp.xyz/quickstart.md): Make your first authenticated request in under two minutes.
- [Rate limits](https://dev-eve-docs.provisionapp.xyz/rate-limits.md): Per-key throttling, 429 responses, and Retry-After handling.

## OpenAPI Specs

- [openapi](https://dev-eve-docs.provisionapp.xyz/openapi.yaml)