Helloretriever Retriever API

Name: Retriever API
Brand: Retriever API
Availability: InStock

✓ Official Vendor SpecHR recruitingEmployee Managementbearer9 EndpointsREST

For Agents

Submit device return orders for offboarding employees, check return status, and look up prepaid balances so an agent can run end-to-end equipment retrieval workflows.

Install Jentic One Beta

Connect the Retriever API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Retriever API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Retriever API.

Create a device return order for a departing employee via /api/v2/device_returns/

Retrieve the status of a specific device return by order ID

List warehouse destinations the device can be shipped back to

GET STARTED

Start building with Retriever API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use Retriever API for, with concrete tasks.

★ Automated Offboarding Device Return

Trigger a device return order automatically when HRIS marks an employee as offboarding. The orchestration calls POST /api/v2/device_returns/ with the employee shipping address and device type, then polls GET /api/v2/device_returns/{id}/ until the order ships. Returns are limited to laptops, cell phones, and monitors for US employees and laptops and cell phones for Canada employees, with the return destination required to be a US address.

Read offboarding event from HRIS, call POST /api/v2/device_returns/ with the employee's home address and device_type=laptop, then confirm by polling GET /api/v2/device_returns/{id}/ for tracking number

Prepaid Balance Monitoring

Avoid order failures by checking prepaid balance before initiating bulk returns at quarter-end or during a layoff event. GET /api/v2/prepaid_balances/ returns current credit, allowing finance to top up the account before submitting dozens of orders that would otherwise be rate-limited or rejected for insufficient funds.

Call GET /api/v2/prepaid_balances/ before any batch return submission and alert finance if balance is below the projected cost of pending returns

Return Status Reporting

Build a status dashboard for IT asset managers showing every active device return, its courier tracking, and expected receipt date. The agent walks /api/v2/device_returns/ with pagination, joins each entry with /api/v2/warehouse/ to resolve the destination, and produces a single view across all open returns.

List all active device returns via GET /api/v2/device_returns/, enrich each with warehouse name from GET /api/v2/warehouse/{id}/, and output a CSV grouped by status

Agent-Initiated Equipment Recovery

Let an internal IT helpdesk agent submit a Retriever return order in response to a Slack or ticket request. The agent searches Jentic for 'submit a device return', loads the operation schema, and executes with the employee's address and device type — without the agent ever holding the bearer token.

Search Jentic for 'submit a device return', load the schema, and call POST /api/v2/device_returns/ with the address and device type from the helpdesk ticket

Key Endpoints

9 endpoints — the retriever api lets hr and it teams submit and track device return orders for laptops, cell phones, and monitors from us and canada-based employees.

METHOD

PATH

DESCRIPTION

POST

/api/v2/device_returns/

Submit a device return order

GET

/api/v2/device_returns/{id}/

Get status of a specific device return

GET

/api/v2/deployments/

List deployments for returning employees

GET

/api/v2/deployments/{id}/

Get a specific deployment

GET

/api/v2/prepaid_balances/

Check prepaid account balance

GET

/api/v2/warehouse/

List warehouse destinations

POST

/api/v2/device_returns/

Submit a device return order

GET

/api/v2/device_returns/{id}/

Get status of a specific device return

GET

/api/v2/deployments/

List deployments for returning employees

GET

/api/v2/deployments/{id}/

Get a specific deployment

GET

/api/v2/prepaid_balances/

Check prepaid account balance

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Retriever bearer tokens are stored encrypted in the Jentic vault (MAXsystem). Agents receive scoped access tokens — the raw Retriever portal token never enters the agent's context, which matters because submitted orders are billable.

Intent-based discovery

Agents search by intent (e.g. 'submit a device return' or 'check return status') and Jentic returns the matching device_returns operations with input schemas, so the agent calls the right endpoint without reading Retriever docs.

Time to first call

Direct Retriever integration: 1-2 days for auth, address validation, and status polling. Through Jentic: under 1 hour — search, load schema, execute.

FAQs

Specific to using Retriever API through Jentic.

What authentication does the Retriever API use?

Bearer token authentication. Tokens are issued from the Retriever portal and passed in the Authorization header. Through Jentic the bearer token is stored encrypted in the vault (MAXsystem) and never enters agent context.

Can I submit a device return order without using the portal UI?

Yes. POST /api/v2/device_returns/ creates an order programmatically. Note that submitted orders are real and billable — to test, submit and then cancel via the portal dashboard within 30 minutes, after which orders are final.

What are the rate limits for the Retriever API?

Read requests are limited to 60 per minute and 500 per day. Write requests (submitting returns) are limited to 600 per minute and 5000 per day. A 429 response is returned when limits are exceeded — contact Retriever support for higher limits.

How do I trigger a device return through Jentic?

Run pip install jentic, then search 'submit a device return order'. Jentic returns POST /api/v2/device_returns/ with its input schema — load the schema, populate the employee address and device type, and execute. The agent never sees the bearer token.

Which countries and devices are supported?

Returns are supported for laptops, cell phones, and monitors from US-based employees, and laptops and cell phones from Canada-based employees. For Canada-based returns the destination warehouse must be a US address.

Can I cancel a return after submitting?

Yes, but only within 30 minutes of submission and only via the Retriever portal dashboard. The API does not expose a programmatic cancel endpoint — orders are final after the 30-minute window.