canonical: https://jentic.com/apis/xtrf.eu/xtrf-eu

# XTRF Home Portal API

XTRF Home Portal API enables you to perform operations on Projects, Quotes, Customers, Vendors etc. as a XTRF Home Portal user. <br>The documentation is generated from OpenAPI specification 3.0 available <a href="/home-api/openapi.json">here</a> <br> The API client/consumer code may be easily generated in 60+ programming languages using an open source code generator available at the time of writin. The API exposes 326 endpoints secured with apiKey authentication.

## For AI agents

Programmatically searches for data (ie. customer, task, etc) and returns it in a csv form., searches for data (ie. customer, task, etc) and returns it in a tabular form.. Covers 326 operations with apiKey authentication.

## Scope

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

## Capabilities

- Searches for data (ie. customer, task, etc) and returns it in a CSV form.
- Creates view for given class.
- Returns views' brief.
- Updates all view's information.
- Removes a view.

## Use cases

### Developer Tools Operations

Use the XTRF Home Portal API to perform developer tools operations programmatically. The API provides 326 endpoints covering core functionality including searches for data (ie. customer, task, etc) and returns it in a csv form., searches for data (ie. customer, task, etc) and returns it in a tabular form., creates view for given class..

Example prompt: Call GET `/browser/csv` to searches for data (ie. customer, task, etc) and returns it in a csv form.

### Automated Browser Management

Automate browser operations by combining multiple XTRF Home Portal API endpoints. Agents can searches for data (ie. customer, task, etc) and returns it in a tabular form. and then creates view for given class. in a single workflow.

Example prompt: Call GET /browser to searches for data (ie. customer, task, etc) and returns it in a tabular form., then verify the result

### AI Agent Integration via Jentic

AI agents discover and call XTRF Home Portal 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 'searches for data (ie. customer, task, etc) and returns it in a csv form.', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/browser/csv` | Searches for data (ie. customer, task, etc) and returns it in a CSV form. |
| GET | `/browser` | Searches for data (ie. customer, task, etc) and returns it in a tabular form. |
| POST | `/browser/views/for/{className}` | Creates view for given class. |
| GET | `/browser/views/for/{className}` | Returns views' brief. |
| GET | `/browser/views/{viewId}` | Returns all view's information. |
| PUT | `/browser/views/{viewId}` | Updates all view's information. |
| DELETE | `/browser/views/{viewId}` | Removes a view. |
| DELETE | `/browser/views/{viewId}/columns/{columnName}` | Deletes a single column from view. |

## Key resources

- **Browser** — To change the description use `/examples/TagsDescriptions.json`
- **Client Invoices** — To change the description use `/examples/TagsDescriptions.json`
- **Clients** — To change the description use `/examples/TagsDescriptions.json`
- **Files** — To change the description use `/examples/TagsDescriptions.json`
- **License** — To change the description use `/examples/TagsDescriptions.json`

## Why Jentic

- **Setup:** Wiring XTRF Home Portal by hand means sending the X-AUTH-ACCESS-TOKEN header on presentation.s.xtrf.eu, working through its large browser and views surface, and handling retries yourself. Through Jentic you install once, import XTRF Home Portal from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** XTRF Home Portal puts the view id in the URL path (`/browser/views/{viewId}`), so a rule can pin your agent to one view: it can read and update that view and nothing else. You choose the operations it may call, so destructive ones like deleting a view or dropping a column are not included unless you add them.
- **Credential handling:** Your XTRF Home Portal 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 'export browser data to CSV' or 'read a saved view', and Jentic returns the matching XTRF Home Portal 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 XTRF Home Portal API use?

The XTRF Home Portal API uses an API key passed in the `X-AUTH-ACCESS-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 searches for data (ie. customer, task, etc) and returns it in a csv form. with the XTRF Home Portal API?

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

### What are the rate limits for the XTRF Home Portal 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 searches for data (ie. customer, task, etc) and returns it in a csv form. through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'searches for data (ie. customer, task, etc) and returns it in a csv form.'. Jentic returns the matching XTRF Home Portal API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the XTRF Home Portal API have?

The XTRF Home Portal API exposes 326 endpoints covering browser, client invoices, clients operations.

### Can I limit what my agent is allowed to do with the XTRF Home Portal API?

Yes. Because Jentic One is self-hosted, you write the rules that decide which XTRF Home Portal operations and credentials your agent may use. Since the view id sits in the URL path (`/browser/views/{viewId}`), you can pin the agent to a single view so it only reads and updates that view and nothing else. You also choose the exact operations it can call, so destructive ones like deleting a view or dropping a column stay out of reach unless you explicitly grant them.