canonical: https://jentic.com/apis/zendesk.com/zendesk

# Zendesk Support API

Zendesk Support API endpoints. The API exposes 489 endpoints secured with basic authentication.

## For AI agents

Programmatically list assignable groups and agents based on query matched against name, list assignable groups on the assigneefield. Covers 489 operations with basic authentication.

## Scope

Does not handle payments, communications, or developer tools - use for crm only.

## Capabilities

- List assignable groups and agents based on query matched against name
- Get sources by target
- Show Settings
- Update Account Settings
- Create Trial Account

## Use cases

### CRM Operations

Use the Support API to perform crm operations programmatically. The API provides 489 endpoints covering core functionality including list assignable groups and agents based on query matched against name, list assignable groups on the assigneefield, list assignable agents from a group on the assigneefield.

Example prompt: Call GET /api/lotus/assignables/autocomplete.json to list assignable groups and agents based on query matched against name

### Automated Attachments Management

Automate attachments operations by combining multiple Support API endpoints. Agents can list assignable groups on the assigneefield and then list assignable agents from a group on the assigneefield in a single workflow.

Example prompt: Call GET /api/lotus/assignables/groups.json to list assignable groups on the assigneefield, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Support API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle basic tokens manually.

Example prompt: Search Jentic for 'list assignable groups and agents based on query matched against name', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /api/lotus/assignables/autocomplete.json | List assignable groups and agents based on query matched against name |
| GET | /api/lotus/assignables/groups.json | List assignable groups on the AssigneeField |
| GET | /api/lotus/assignables/groups/{group_id}/agents.json | List assignable agents from a group on the AssigneeField |
| GET | /api/v2/{target_type}/{target_id}/relationship_fields/{field_id}/{source_type} | Get sources by target |
| GET | /api/v2/account/settings | Show Settings |
| PUT | /api/v2/account/settings | Update Account Settings |
| POST | /api/v2/accounts | Create Trial Account |
| GET | /api/v2/accounts/available | Verify Subdomain Availability |

## Key resources

- **Attachments** — Operations related to Attachments
- **Sessions** — Operations related to Sessions
- **Trigger Categories** — Operations related to Trigger Categories
- **Tags** — Operations related to Tags
- **Targets** — Operations related to Targets

## Why Jentic

- **Setup:** Wiring the Zendesk Support API by hand means encoding its basic auth on every request, filling in your {subdomain}.{domain}.com host, and coding request handling across hundreds of endpoints yourself. Through Jentic you install once, import Support from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** The Support API puts resource ids in the URL path (for example /assignables/groups/{group_id}/agents.json and relationship fields keyed by target id), so a rule can pin your agent to one group or account resource. You choose the operations it may call, so writes like updating account settings are not included unless you add them.
- **Credential handling:** Your Zendesk credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list assignable groups' or 'read account settings', and Jentic returns the matching Support operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Hubspot** — Alternative crm API
- **Salesforce** — Alternative crm API
- **Pipedrive** — Complementary crm API
- **Zoho** — Complementary crm API

## FAQ

### What authentication does the Support API use?

The Support API uses HTTP Basic authentication with username and password. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I list assignable groups and agents based on query matched against name with the Support API?

Yes. Use the GET /api/lotus/assignables/autocomplete.json endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Support API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I list assignable groups and agents based on query matched against name through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'list assignable groups and agents based on query matched against name'. Jentic returns the matching Support API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Support API have?

The Support API exposes 489 endpoints covering attachments, sessions, trigger categories operations.

### Can I limit what my agent is allowed to do with the Zendesk Support API?

Yes. Jentic One runs self-hosted, so your own rules decide which Support API operations and credentials the agent may use. Because the API keys resources by id in the URL path, such as /api/lotus/assignables/groups/{group_id}/agents.json and relationship fields keyed by target id, you can pin the agent to a single group or account resource. You also choose which operations it may call, so writes like Update Account Settings (PUT /api/v2/account/settings) or Create Trial Account stay off limits unless you explicitly allow them.
