canonical: https://jentic.com/apis/swaggerhub.lennert-onyx/api2clients

# Lennert Onyx Api2Clients

API to fetch contractor/user information from OnyxOne. The apikey will be provided by OnyxOne upon request Changelog: * 2.0.0 (Expected beta release: 03/10/2023, Expected live release: 03/10/2023) * * Not backward compatible change: UIN is removed from the user response. The API exposes 2 endpoints.

## For AI agents

Programmatically fetch contractor info, fetch user info. Covers 2 operations.

## Scope

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

## Capabilities

- Fetch contractor info
- Manage developer tools data programmatically
- Integrate Api2Clients into automated workflows
- Query and filter Api2Clients records by parameters
- Monitor Api2Clients operational status and events

## Use cases

### Developer Tools Operations

Use the Api2Clients to perform developer tools operations programmatically. The API provides 2 endpoints covering core functionality including fetch contractor info, fetch user info.

Example prompt: Call GET /companies to fetch contractor info

### Data Retrieval and Monitoring

Query Api2Clients resources on a schedule to track changes, generate alerts, or feed downstream dashboards. Agents poll relevant endpoints, compare against previous state, and trigger actions when thresholds are crossed.

Example prompt: Poll the primary Api2Clients endpoint, compare response to last known state, and alert if changed

### AI Agent Integration via Jentic

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

Example prompt: Search Jentic for 'fetch contractor info', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /companies | Fetch contractor info |
| GET | /users | Fetch user info |

## Key resources

- **Companies** — Operations for companies
- **Users** — Operations for users

## Why Jentic

- **Setup:** Wiring Api2Clients by hand means choosing between its SwaggerHub mock host and the beta.onyxone.com backend and shaping its company and user reads yourself. Through Jentic you install once, import Api2Clients from the API Directory, and your agent calls it without you hand-building each request.
- **Permission scoping:** Api2Clients exposes only company and user reads and carries any filters outside the resource path, so limit the agent to the operations it needs, such as listing companies or users. Both exposed operations are read-only, and you choose which of them the agent may call.
- **Credential handling:** Any Api2Clients 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 'list companies' or 'fetch users', and Jentic returns the matching Api2Clients operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the Api2Clients use?

The Api2Clients uses no authentication. 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 fetch contractor info with the Api2Clients?

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

### What are the rate limits for the Api2Clients?

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 fetch contractor info through Jentic?

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

### How many endpoints does the Api2Clients have?

The Api2Clients exposes 2 endpoints covering companies, users operations.

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

Yes. Api2Clients exposes only two read-only operations, listing companies with GET /companies and fetching users with GET /users, and because you run Jentic One yourself, your own rules decide which of these the agent may call. You can grant just GET /companies for contractor lookups while withholding the user read, or allow both. Since the credentials and the allowed operation list live in your self-hosted instance, the agent can only invoke the reads you have explicitly permitted.