# Accompany API

**Canonical:** https://apis.io/apis/accompany/accompany-api/  
**Provider:** Accompany — https://apis.io/providers/accompany/  
**Documentation:** https://developer.zendesk.com/documentation/developer-tools/working-with-the-zendesk-apis/exploring-zendesk-apis-with-postman

Accompany API is published by [Accompany](https://apis.io/providers/accompany/) on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Accompany API as documented publicly: 41 operations. Contract generated from the documentation by API Evangelist (2026-10-27); not the provider's own document.

## Operations (41)

| Method | Path | Summary |
|---|---|---|
| DELETE | `/` | DELETE / |
| GET | `/` | GET / |
| PATCH | `/` | PATCH / |
| POST | `/` | POST / |
| POST | `/api/services/zis/inbound_webhooks/generic/ingest/{token}` | Ingests an incoming webhook request as an event. |
| GET | `/api/services/zis/inbound_webhooks/generic/my_integration` | GET /api/services/zis/inbound_webhooks/generic/my_integration |
| POST | `/api/services/zis/inbound_webhooks/generic/{integration}` | Creates an inbound webhook that is used to receive HTTP requests. |
| GET | `/api/services/zis/inbound_webhooks/generic/{integration}/{uuid}` | Returns webhook details by UUID. |
| GET | `/api/services/zis/integrations/my_integration/configs/my_scope` | GET /api/services/zis/integrations/my_integration/configs/my_scope |
| GET | `/api/services/zis/integrations/{integration}/configs` | GET /api/services/zis/integrations/{integration}/configs |
| POST | `/api/services/zis/integrations/{integration}/configs` | POST /api/services/zis/integrations/{integration}/configs |
| DELETE | `/api/services/zis/integrations/{integration}/configs/{scope}` | Deletes the existing configuration settings. |
| PATCH | `/api/services/zis/integrations/{integration}/configs/{scope}` | Merges the provided configuration settings with the existing configuration. |
| PUT | `/api/services/zis/integrations/{integration}/configs/{scope}` | Updates the configuration settings for an integration. |
| GET | `/api/services/zis/integrations/{integration}/connections/all` | Returns a list of connections of all types for the integration. |
| DELETE | `/api/services/zis/links/{integration}` | DELETE /api/services/zis/links/{integration} |
| GET | `/api/services/zis/links/{integration}` | GET /api/services/zis/links/{integration} |
| PATCH | `/api/services/zis/links/{integration}` | Update Link |
| POST | `/api/services/zis/links/{integration}` | Create Link |
| GET | `/api/services/zis/registry/{integration}/bundles` | List all existing bundles for an integration from the ZIS Registry. |
| POST | `/api/services/zis/registry/{integration}/bundles` | Uploads a new bundle or updates an existing bundle for a ZIS integration. |
| DELETE | `/api/services/zis/registry/{integration}/bundles/{uuid}` | Delete a bundle for a ZIS integration. |
| GET | `/api/services/zis/registry/{integration}/bundles/{uuid}` | Returns information about an uploaded bundle. |
| POST | `/api/sunshine/objects/records` | The first task is to create an object record for each PC. You can use the Create Legacy Object Record endpoint: |
| GET | `/api/sunshine/objects/records/{resourceId}/relationships/{relationshipTypeKey}` | Use the List Legacy Relationship Records by Object Record endpoint to retrieve the relationship records: |
| POST | `/api/sunshine/objects/types` | To create the "pc" object type, include the schema in a POST request to the following endpoint: |
| POST | `/api/sunshine/relationships/records` | To create a legacy relationship record, make a POST request to the Create Legacy Relationship Record endpoint: |
| POST | `/api/sunshine/relationships/types` | To define a legacy relationship type, you make a POST request to the Create Legacy Relationship Type endpoint: |
| GET | `/api/v2/chat/agents` | This is the reference documentation for the Zendesk Chat API, which is also known as the Live Chat API. |
| GET | `/api/v2/chat/agents/me` | This is the reference documentation for the Zendesk Chat API, which is also known as the Live Chat API. |
| GET | `/api/v2/tickets/3.json` | GET /api/v2/tickets/3.json |
| GET | `/api/v2/user_profiles` | GET /api/v2/user_profiles |
| PATCH | `/api/v2/user_profiles` | Update a profile |
| PUT | `/api/v2/user_profiles` | Create a profile |
| GET | `/api/v2/user_profiles/events` | GET /api/v2/user_profiles/events |
| POST | `/api/v2/user_profiles/events` | Create an event |
| GET | `/api/v2/user_profiles/{profileId}/events` | Get a profile |
| GET | `/api/v2/webhooks` | GET /api/v2/webhooks |
| GET | `/api/v2/webhooks/{webhookId}/invocations/{invocationId}/attempts` | Each invocation of a webhook has a unique id that can be used to get detailed information about the attempts made for that invocation. |
| POST | `/graphql/request` | POST /graphql/request |
| GET | `/register/free-trial` | GET /register/free-trial |

## Machine-readable artifacts (8)

- **OpenAPI** — https://artifacts.apis.io/accompany/openapi/_ae-authored/accompany-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/accompany/json-schema/accompany-post-api-v2-user-profiles-events-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/accompany/json-schema/accompany-get-api-services-zis-inbound-webhooks-generic-integration-uuid-respon-schema.json
- **JSONSchema** — https://artifacts.apis.io/accompany/json-schema/accompany-post-api-sunshine-objects-types-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/accompany/json-schema/accompany-post-api-services-zis-inbound-webhooks-generic-integration-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/accompany/json-schema/accompany-put-api-v2-user-profiles-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/accompany/json-schema/accompany-put-api-v2-user-profiles-response-schema.json
- **APIsJSON** — https://artifacts.apis.io/accompany/apis.yml

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/accompany/accompany-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/accompany/.