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

# Sirportly API

Sirportly helpdesk and ticketing system REST API for managing tickets, ticket updates, contacts, and related resources. The API exposes 4 endpoints secured with apiKey authentication.

## For AI agents

Programmatically list all tickets, submit a new ticket. Covers 4 operations with apiKey authentication.

## Scope

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

## Capabilities

- List all tickets
- Submit a new ticket
- Search tickets
- Query and filter Sirportly API records by parameters
- Monitor Sirportly API operational status and events

## Use cases

### CRM Operations

Use the Sirportly API to perform crm operations programmatically. The API provides 4 endpoints covering core functionality including list all tickets, submit a new ticket, search tickets.

Example prompt: Call GET `/api/v2/tickets/all` to list all tickets

### Automated Tickets Management

Automate tickets operations by combining multiple Sirportly API endpoints. Agents can submit a new ticket and then search tickets in a single workflow.

Example prompt: Call POST `/api/v2/tickets/submit` to submit a new ticket, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Sirportly 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 apiKey tokens manually.

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

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/v2/tickets/all` | List all tickets |
| POST | `/api/v2/tickets/submit` | Submit a new ticket |
| POST | `/api/v2/tickets/search` | Search tickets |
| GET | `/api/v2/ticket_updates/all` | List all updates for a ticket |

## Key resources

- **Tickets** — Ticket management
- **TicketUpdates** — Ticket update operations

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 64 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 47 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 69 / 100
- **View full report:** https://jentic.com/apis/sirportly.com/sirportly/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Sirportly API by hand means setting up its paired token and secret headers, X-Auth-Token and X-Auth-Secret, and carrying both across every ticket call yourself. Through Jentic you install once, import Sirportly from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** Sirportly carries its ticket targets in the request body rather than as a resource id in the URL path, so scope the agent by operations: limit it to the operations it needs, such as listing or searching tickets, and leave out ticket submission unless you add it.
- **Credential handling:** Your Sirportly token and secret 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 'list all tickets' or 'search tickets', and Jentic returns the matching Sirportly 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 Sirportly API use?

The Sirportly API uses an API key passed in the `X-Auth-Token` header. 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 all tickets with the Sirportly API?

Yes. Use the GET `/api/v2/tickets/all` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Sirportly 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 all tickets through Jentic?

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

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

The Sirportly API exposes 4 endpoints covering tickets, ticketupdates operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Sirportly operations and credentials the agent may use. Since Sirportly identifies its ticket targets in the request body rather than in the URL path, you scope the agent by operation: allow only what it needs, such as listing tickets with GET `/api/v2/tickets/all`, searching with POST `/api/v2/tickets/search`, or reading updates with GET `/api/v2/ticket_updates/all`, and leave out ticket submission via POST `/api/v2/tickets/submit` unless you grant it. The stored token and secret are injected only for the operations you permit.