canonical: https://jentic.com/apis/swaggerhub.anexya/anexya-cloud---public-api

# anexya Cloud - Public API

This document contains the necessary APIs fetch data of operations, orders, containers, and organizations. Notes: - When using OAuth2 to get an access token, contact the support team to get the client_id and client_secret. The API exposes 15 endpoints secured with oauth2 authentication.

## For AI agents

Programmatically list operations, get operation by id. Covers 15 operations with oauth2 authentication.

## Scope

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

## Capabilities

- List operations
- Get operation by ID
- Integrate anexya Cloud - Public API into automated workflows
- Query and filter anexya Cloud - Public API records by parameters
- Monitor anexya Cloud - Public API operational status and events

## Use cases

### CRM Operations

Use the anexya Cloud - Public API to perform crm operations programmatically. The API provides 15 endpoints covering core functionality including list operations, get operation by id, list items within an operation.

Example prompt: Call GET /rest/api/public/rvs/v1/operations to list operations

### Automated Rest Management

Automate rest operations by combining multiple anexya Cloud - Public API endpoints. Agents can get operation by id and then list items within an operation in a single workflow.

Example prompt: Call GET /rest/api/public/rvs/v1/operations/{operationId} to get operation by id, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call anexya Cloud - Public 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 oauth2 tokens manually.

Example prompt: Search Jentic for 'list operations', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /rest/api/public/rvs/v1/operations | List operations |
| GET | /rest/api/public/rvs/v1/operations/{operationId} | Get operation by ID |
| GET | /rest/api/public/rvs/v1/operations/{operationId}/items | List items within an operation |
| GET | /rest/api/public/rvs/v1/operations/{operationId}/items/{operationItemId}/serials | List serials of an item within an operation |
| GET | /rest/api/public/rvs/v1/operations/types | List operation types |
| GET | /rest/api/public/rvs/v1/organizations | List organizations |
| GET | /rest/api/public/rvs/v1/orders | List orders |
| GET | /rest/api/public/rvs/v1/orders/{number} | Get order by number |

## Key resources

- **Rest** — Operations for rest

## Why Jentic

- **Setup:** Wiring the anexya Cloud Public API by hand means implementing its OAuth2 password flow against the anexya token URL, refreshing tokens, and tracking the operation and order resource paths yourself. Through Jentic you install once, import the anexya Cloud Public API from the API Directory, store the OAuth credentials once, and your agent calls it.
- **Permission scoping:** This API puts the operation id in the URL path (/rest/api/public/rvs/v1/operations/{operationId}/...), so a rule can pin your agent to one operation and its items and serials, and nothing else. The endpoints here are read-only GETs, so the agent only retrieves what you allow it to reach.
- **Credential handling:** Your anexya OAuth credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'get an order by number' or 'list serials for an operation item', and Jentic returns the matching 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 anexya Cloud - Public API use?

The anexya Cloud - Public API uses OAuth 2.0 for authorization. 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 operations with the anexya Cloud - Public API?

Yes. Use the GET /rest/api/public/rvs/v1/operations endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the anexya Cloud - Public 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 operations through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'list operations'. Jentic returns the matching anexya Cloud - Public API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the anexya Cloud - Public API have?

The anexya Cloud - Public API exposes 15 endpoints covering rest operations.

### Can I limit what my agent is allowed to do with the anexya Cloud - Public API?

Yes. Because you run Jentic One yourself, your own rules decide which anexya Cloud operations the agent may call and which OAuth credentials it may use. Since this API carries the operation id in the URL path, you can pin the agent to a single operation and its items and serials, and every endpoint here is a read-only GET, so the agent can only retrieve the operations, orders, and organizations you permit and cannot write or delete anything.