Accompany

Accompany API

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

GitHub OpenAPI

Operations 41

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. #
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 #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/accompany/openapi/_ae-authored/accompany-openapi-generated.yml

Schemas & Data

📊
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

Other Resources

🔗
APIsJSON
https://artifacts.apis.io/accompany/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/accompany:accompany-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

accompany-openapi-generated.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Accompany API
  version: '2026-10-27'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-27: 41 operation(s) read from 15 public documentation page(s) (each
    operation names its page in x-source). This is not the provider''s published contract; Accompany has published no machine-readable contract
    that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 29
    documentation: 12
    pages-with-code: 14
    pages-read: 15
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-27'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://developer.zendesk.com/documentation/developer-tools/working-with-the-zendesk-apis/exploring-zendesk-apis-with-postman
  - https://developer.zendesk.com/documentation/ticketing/events/getting-started-with-events
  - https://developer.zendesk.com/documentation/ticketing/profiles/getting-started-with-profiles
  - https://developer.zendesk.com/documentation/custom-data/custom-objects/getting-started-with-custom-objects
  - https://developer.zendesk.com/documentation/developer-tools/getting-started/getting-a-trial-or-sponsored-account-for-development
  - https://developer.zendesk.com/api-reference/ticketing/introduction
  - https://developer.zendesk.com/api-reference/status_api/status_api
  - https://developer.zendesk.com/api-reference/live-chat/introduction
  - https://developer.zendesk.com/api-reference/live-chat/chat-conversations-api/conversations-api
  - https://developer.zendesk.com/api-reference/integration-services/configs/configs
  - https://developer.zendesk.com/api-reference/integration-services/connections/all_connections
  - https://developer.zendesk.com/api-reference/integration-services/inbound-webhooks/inbound_webhooks
  - https://developer.zendesk.com/api-reference/integration-services/links/links
  - https://developer.zendesk.com/api-reference/integration-services/registry/bundles


# --- truncated at 32 KB (64 KB total) ---
# Full source: https://artifacts.apis.io/accompany/openapi/_ae-authored/accompany-openapi-generated.yml