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

# Upvoit API

Upvoit is a comprehensive business management platform API for field service, project management, and financial operations. It provides endpoints for managing clients, jobs, quotes, invoices, timesheets, expenses, checklists, and company operations. The API exposes 25 endpoints secured with bearer authentication.

## For AI agents

Programmatically user login, register new user. Covers 25 operations with bearer authentication.

## Scope

Does not handle payments, communications, or crm - use for finance and accounting only.

## Capabilities

- User login
- Register new user
- Refresh access token
- Create a client
- List all clients
- Get a client
- Update a client

## Use cases

### Finance and Accounting Operations

Use the Upvoit API to perform finance operations programmatically. The API provides 25 endpoints covering core functionality including user login, register new user, refresh access token.

Example prompt: Call POST `/auth/login` to user login

### Automated Authentication Management

Automate authentication operations by combining multiple Upvoit API endpoints. Agents can register new user and then refresh access token in a single workflow.

Example prompt: Call POST `/auth/register` to register new user, then verify the result

### AI Agent Integration via Jentic

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

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

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/auth/login` | User login |
| POST | `/auth/register` | Register new user |
| POST | `/auth/refresh-token` | Refresh access token |
| POST | `/clients` | Create a client |
| GET | `/clients` | List all clients |
| GET | `/clients/{clientId}` | Get a client |
| PUT | `/clients/{clientId}` | Update a client |
| DELETE | `/clients/{clientId}` | Delete a client |

## Key resources

- **Authentication** — Operations related to Authentication
- **Chat** — Operations related to Chat
- **Checklists** — Operations related to Checklists
- **Clients** — Operations related to Clients
- **Company** — Operations related to Company

## 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:** 71 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 90 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 52 / 100
  - Agent Usability: 94 / 100
  - Security: 75 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/upvoit.com/upvoit/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 Upvoit API by hand means running its login flow, holding the bearer token, and refreshing it against the refresh-token endpoint yourself. Through Jentic you install once, import Upvoit from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** Upvoit puts the client id in the URL path (`/clients/{clientId}`), so a rule can pin your agent to one client: it can read and update that client if you allow it. You choose the operations it may call, so destructive ones like client deletion are not included unless you add them.
- **Credential handling:** Your Upvoit 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 'log in' or 'list clients', and Jentic returns the matching Upvoit operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Plaid** — Alternative finance API
- **Xero** — Alternative finance API

## FAQ

### What authentication does the Upvoit API use?

The Upvoit API uses a Bearer token in the Authorization 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 user login with the Upvoit API?

Yes. Use the POST `/auth/login` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Upvoit 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 user login through Jentic?

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

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

The Upvoit API exposes 25 endpoints covering authentication, chat, checklists operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Upvoit operations and credentials the agent may use, so you choose exactly which endpoints it can call. Since Upvoit puts the client id in the URL path (`/clients/{clientId}`), you can pin the agent to a single client and let it read or update that one client without touching others. Destructive operations such as deleting a client (DELETE `/clients/{clientId}`) are excluded unless you explicitly allow them.