# InPlan docs

InPlan answers one question for your product: does this plan's network directory list this provider? These pages show how to ask it and how to read the answer.

Source: https://inplan.io/docs · Updated 2026-10-30

## Start here

- [Quickstart](https://inplan.io/docs/quickstart): Get a key, make your first call and read the answer.
- [Answers and evidence](https://inplan.io/docs/answers-and-evidence): What `listed` and `not_found` mean, and how to show them.
- [API reference](https://inplan.io/docs/api): Every endpoint, parameter and response.

## The basics

Every request goes to `https://api.inplan.io` over HTTPS, with your key in the `Authorization` header. Every response is JSON with the same envelope: `request_id`, `data_as_of`, `data`, `sources` and, on most endpoints, `notes`.

curl:

```bash
curl https://api.inplan.io/v1/check \
  -H "Authorization: Bearer $INPLAN_KEY" \
  -G -d npi=1184617268 -d plan_id=29276OH0970001
```

JavaScript:

```javascript
const url = new URL("https://api.inplan.io/v1/check");
url.search = new URLSearchParams({ npi: "1184617268", plan_id: "29276OH0970001" });

const res = await fetch(url, {
  headers: { Authorization: `Bearer ${process.env.INPLAN_KEY}` },
});
const body = await res.json();
console.log(body.data.answer, body.data.evidence);
```

Python:

```python
import os, requests

res = requests.get(
    "https://api.inplan.io/v1/check",
    params={"npi": "1184617268", "plan_id": "29276OH0970001"},
    headers={"Authorization": f"Bearer {os.environ['INPLAN_KEY']}"},
    timeout=10,
)
body = res.json()
print(body["data"]["answer"], body["data"]["evidence"])
```

The answer is `listed` when the plan's network directory lists the provider, with evidence that names the plan year, the source type and the date we read it. It is `not_found` when we find no listing. That is never a statement that the provider is out of network. Read [Answers and evidence](https://inplan.io/docs/answers-and-evidence) before you show answers to users.

## Endpoints

| Endpoint | What it answers |
| --- | --- |
| [`GET /v1/providers/{npi}`](https://inplan.io/docs/api/providers) | Who the provider is, and how many plans list them. |
| [`GET /v1/providers/{npi}/plans`](https://inplan.io/docs/api/provider-plans) | Every plan that lists the provider. |
| [`GET /v1/check`](https://inplan.io/docs/api/check) | Does this plan list this provider? |
| [`POST /v1/check/batch`](https://inplan.io/docs/api/check-batch) | The same question for up to 100 pairs in one call. |
| [`GET /v1/plans/{plan_id}`](https://inplan.io/docs/api/plans) | Plan details and plan years. |
| [`GET /v1/plans/{plan_id}/providers`](https://inplan.io/docs/api/plan-providers) | Providers a marketplace plan lists, with filters. |
| [`GET /v1/coverage`](https://inplan.io/docs/api/coverage) | Markets, states, insurers and plans with listings. |
| [`GET /v1/status`](https://inplan.io/docs/api/status) | Health and data dates. No key needed. |

## Concepts and guides

- [Plans and plan years](https://inplan.io/docs/plans-and-plan-years): Plan id formats and how `year` works.
- [Providers and NPIs](https://inplan.io/docs/providers-and-npis): NPI checks, names and practice locations.
- [Data freshness](https://inplan.io/docs/data-freshness): The dates on every answer.

- [Benefits and ICHRA](https://inplan.io/docs/guides/benefits): Check every employee's doctors against the plans on offer.
- [Telehealth and navigation](https://inplan.io/docs/guides/telehealth): Confirm the plan lists the clinician before you book.
- [Brokers and agents](https://inplan.io/docs/guides/brokers): Quote the plans that keep a client's doctors.

## For tools and agents

Every docs page is also plain Markdown: add `.md` to its address, or use **Copy page**. These files describe the whole API:

- [`/openapi.json`](https://inplan.io/openapi.json): the OpenAPI 3.1 description, with real response examples.
- [Postman collection](https://inplan.io/docs/inplan.postman_collection.json): every endpoint with sample values. Set `INPLAN_KEY` in the collection variables.
- [`/llms.txt`](https://inplan.io/llms.txt): an index of these docs for language models. [`/llms-full.txt`](https://inplan.io/llms-full.txt) holds every page in one file.
- [`/pricing.md`](https://inplan.io/pricing.md): plans, limits and prices as Markdown.
- The [changelog](https://inplan.io/changelog) lists every change to the API.