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

# Usesocket Socket API

Socket API provides read access to practices, proposals, and documents, and creation capabilities for clients and leads for accounting and bookkeeping professionals. The API exposes 17 endpoints secured with bearer authentication.

## For AI agents

Programmatically get authenticated user profile, list accessible practices. Covers 17 operations with bearer authentication.

## Scope

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

## Capabilities

- Get authenticated user profile
- List accessible practices
- Create a client
- Query and filter Socket API records by parameters
- Monitor Socket API operational status and events

## Use cases

### Finance and Accounting Operations

Use the Socket API to perform finance operations programmatically. The API provides 17 endpoints covering core functionality including get authenticated user profile, list accessible practices, get specific practice.

Example prompt: Call GET `/api/user` to get authenticated user profile

### Automated Clients Management

Automate clients operations by combining multiple Socket API endpoints. Agents can list accessible practices and then get specific practice in a single workflow.

Example prompt: Call GET `/api/v1/practices` to list accessible practices, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Socket 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 'get authenticated user profile', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/user` | Get authenticated user profile |
| GET | `/api/v1/practices` | List accessible practices |
| GET | `/api/v1/practices/{practice}` | Get specific practice |
| POST | `/api/v1/clients` | Create a client |
| GET | `/api/v1/clients` | List clients |
| GET | `/api/v1/clients/{client}` | Get client details |
| POST | `/api/v1/leads` | Create a lead |
| GET | `/api/v1/leads` | List leads |

## Key resources

- **Clients** — Operations for clients
- **Documents** — Operations for documents
- **Leads** — Operations for leads
- **Practices** — Operations for practices
- **Proposals** — Operations for proposals

## 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:** 70 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 93 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 49 / 100
  - Agent Usability: 94 / 100
  - Security: 75 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/usesocket.com/usesocket/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 Socket API by hand means attaching its bearer token and moving between the user, practice, client, and lead endpoints yourself. Through Jentic you install once, import the Socket API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Socket puts the practice and client ids in the URL path (`/api/v1/practices/{practice}`, `/api/v1/clients/{client}`), so a rule can pin your agent to one practice or client: it can read that record if you allow it. You choose the operations it may call, so creating clients or leads is not included unless you add it.
- **Credential handling:** Your Socket token 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 'get the authenticated user profile' or 'list clients', and Jentic returns the matching Socket 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 Socket API use?

The Socket 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 get authenticated user profile with the Socket API?

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

### What are the rate limits for the Socket 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 get authenticated user profile through Jentic?

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

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

The Socket API exposes 17 endpoints covering clients, documents, leads operations.

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

Yes. Because you run Jentic One yourself and set its rules, you decide which Socket operations your agent may call and which token it uses, so you can allow only reads like GET `/api/user` or GET `/api/v1/practices` while withholding the client and lead creation endpoints (POST `/api/v1/clients`, POST `/api/v1/leads`). Since Socket puts practice and client ids in the URL path (`/api/v1/practices/{practice}`, `/api/v1/clients/{client}`), a rule can pin the agent to a single practice or client record. Nothing beyond the operations you explicitly permit is available to the agent.
