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

# Inpaas Hike Sales API

The Hike Sales API reads and writes the sales records of Hike Sales, a CRM built on the InPaaS platform: leads, opportunities, accounts, contacts, and tasks. Each record type can be listed, created, fetched by id, and updated, and the account and task finders accept filters such as param.title, param.cpfcnpj for a Brazilian CPF or CNPJ tax number, and param.duedate. A separate operation returns the signed-in user's pending items, filterable by status (due today, pending, or overdue) and by workflow type. The spec's documentation is written in Portuguese.

## For AI agents

List, create, fetch, and update Hike Sales leads, opportunities, accounts, contacts, and tasks, and read a user's pending follow-ups by due status.

## Scope

Does not handle invoicing, payments, email sending, or deleting records. Use for reading and updating Hike Sales leads, opportunities, accounts, contacts, and tasks only.

## Capabilities

- Log new leads and opportunities in Hike Sales and update them by id as they move through the sales process
- Find customer accounts by name with param.title or by Brazilian tax number with param.cpfcnpj
- Register new accounts and contacts and keep their records up to date with PUT by id
- List sales tasks filtered by param.title, param.description, or param.duedate, and create new ones
- Read a user's pending follow-ups filtered by status such as duetoday or latedue and by workflow type

## Use cases

### Sales follow-up assistant through Jentic

An AI agent connected through Jentic starts the day by reading a salesperson's pending items in Hike Sales, filtered to status duetoday or latedue, and turns them into a short call list. It then opens the related opportunity or account by id to add context. The Basic credentials stay in your own Jentic One instance, not in the agent's context.

Example prompt: Call GET `/api/bpm-exec-issuedata/v1/pending-issues/data.json` with status 'latedue', assigned_user 'Y', order 'ASC', limit 20, and page 1, then list each overdue item

### Lead capture from inbound forms

When a prospect fills in a form on your site, create the lead in Hike Sales so it lands in the sales team's queue without retyping. Later, update the same lead by id as it is qualified, and open an opportunity when it is ready to quote.

Example prompt: Call POST /leads with the lead's name, company, and email from the form, then confirm the new lead appears in GET /leads

### Account lookup by CPF or CNPJ

Brazilian sales teams identify customers by tax number. The account finder accepts param.cpfcnpj, so an agent can check whether a company already exists before creating a duplicate, and fall back to param.title to search by name.

Example prompt: Call GET `/api/data-sources/e/HSFA_CONTA/finders/759826dc-3306-4177-ab86-27819c599f2b/results` with param.cpfcnpj '12345678000190' and limit 5, and report whether a matching account exists

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/oportunidades` | List opportunities |
| POST | `/oportunidades` | Create an opportunity |
| PUT | `/oportunidades/{id}` | Update an opportunity |
| POST | `/leads` | Create a lead |
| GET | `/contas/{id}` | Get an account by id |
| POST | `/contatos` | Create a contact |
| GET | `/api/bpm-exec-issuedata/v1/pending-issues/data.json` | Get the user's pending items |

## Key resources

- **Leads** — List, create, fetch by id, and update leads
- **Opportunities** — List, create, fetch by id, and update sales opportunities
- **Accounts** — Search accounts by name or CPF/CNPJ, create, fetch by id, and update
- **Contacts** — List, create, fetch by id, and update contacts
- **Tasks** — Search tasks by title, description, or due date, create, fetch by id, and update
- **Pending items** — A user's pending follow-ups by status and workflow type

## 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:** 40 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 99 / 100
  - Developer Experience & Jentic Compatibility: 64 / 100
  - AI-Readiness & Agent Experience: 50 / 100
  - Agent Usability: 94 / 100
  - Security: 10 / 100
  - AI Discoverability: 68 / 100
- **View full report:** https://jentic.com/apis/inpaas.com/inpaas/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 Hike Sales by hand means sending HTTP Basic credentials, passing the user and pass query parameters to the pending items operation, and working with long finder paths for accounts and tasks. Through Jentic you install once, import Hike Sales from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** Hike Sales puts the record id in the URL path for leads, opportunities, accounts, contacts, and tasks (`/oportunidades/{id}`), so a rule can pin your agent to one record and the operations you pick. You choose the operations it may call, so writes like creating or updating opportunities are not included unless you add them.
- **Credential handling:** Your Hike Sales 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 'create a sales lead' or 'find an account by CNPJ', and Jentic returns the matching Hike Sales operation with its input schema so the agent calls the right endpoint without reading the Portuguese reference docs.

## Related APIs

- **Pipedrive API** — Deal pipeline CRM with deals, persons, organizations, and activities
- **Agendor API** — Brazilian sales CRM for deals, people, and organizations
- **HubSpot CRM Deals API** — Deal records and pipelines in HubSpot CRM
- **IndiePitcher API** — Transactional and mailing-list email sending

## FAQ

### Is there a Hike Sales MCP server?

You don't need an MCP server to give your agent Hike Sales. Jentic connects it directly from the API Directory: import it, store your credentials once, and your agent calls it. The agent finds the lead, opportunity, or task operation it needs on demand, so its context stays free of unused tool definitions.

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

Yes. For a reporting agent, write a rule that allows only GET /oportunidades, GET `/oportunidades/{id}`, and GET /leads. The agent can read the pipeline but cannot create or change records, and every call it makes is logged. Because the record id is in the URL path, you can also pin a rule to a single opportunity such as `/oportunidades/482.`

### What authentication does the Hike Sales API use?

Per its OpenAPI spec, the Hike Sales API uses HTTP Basic authentication on every operation. The pending items operation also requires the user's login and password as the user and pass query parameters. Through Jentic, these credentials are stored encrypted by your own Jentic One instance and injected when each call runs.

### Which server does the Hike Sales spec point to?

The spec's only server is https://hike-sales-dev.inpaas.com, which by its name is a development host. Confirm the correct host for your Hike Sales environment with your provider before pointing an agent at production data.

### What are the rate limits for the Hike Sales API?

The OpenAPI spec does not specify rate limits; check https://inpaas.com or your Hike Sales administrator for current limits.

### How do I find overdue follow-ups with the Hike Sales API through Jentic?

Install Jentic One with `curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh`, import Hike Sales from the API Directory, and store your credentials. Your agent searches for 'list overdue sales follow-ups', gets the pending items operation with its input schema, and calls it with status latedue plus the required order, limit, assigned_user, and page values. To run it on your own infrastructure, install Jentic One from its GitHub repo.