Skip to content

Chapter Provider API (1.6.1)

The Chapter Provider API gives you access to:

  • Coverage information for provider-plan combinations
  • Location-based provider search
  • Specific provider location lookups

All endpoints require a valid bearer token. Contact support@getchapter.com to request credentials.

Download OpenAPI description
Overview
Chapter Support

support@getchapter.com

Languages
Servers
Mock server

https://providers.docs.askchapter.org/_mock/apis/

Production server

https://api2.askchapter.org/v2/

Staging server

https://api2.staging.askchapter.org/v2/

Providers

Locate providers based on geographic and semantic search inputs

Operations

Get metadata for a specific provider

Request

Use this endpoint to retrieve metadata for a provider by NPI.

Security
bearerAuth
Path
npistringrequired
Example: 1234567890
curl -i -X GET \
  https://providers.docs.askchapter.org/_mock/apis/providers/1234567890 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Provider metadata

Bodyapplication/json
idstring
Example: "070851a5-9501-4801-9074-d84b88b8a804"
npisArray of strings
Example: ["1234567890"]
doingBusinessAsstring or null
firstNamestring or null
Example: "Jane"
lastNamestring or null
Example: "Smith"
middleNamestring or null
Example: "Marie"
prefixstring or null
Example: "Dr."
suffixstring or null
Example: "Jr"
genderstring
Enum"F""M""X"
Example: "F"
credentialsArray of strings
Example: ["MD"]
languagesArray of strings
Example: ["English"]
groupAffiliationsArray of strings
Example: ["Vision Medical Group"]
hospitalAffiliationsArray of strings
Example: ["Rogue County Medical"]
Response
application/json
{ "id": "070851a5-9501-4801-9074-d84b88b8a804", "npis": [ "1234567890" ], "doingBusinessAs": "string", "firstName": "Jane", "lastName": "Smith", "middleName": "Marie", "prefix": "Dr.", "suffix": "Jr", "gender": "F", "credentials": [ "MD" ], "languages": [ "English" ], "groupAffiliations": [ "Vision Medical Group" ], "hospitalAffiliations": [ "Rogue County Medical" ] }

Get all known locations for a specific provider

Request

Use this endpoint to retrieve every known practice location for a provider by NPI.

Security
bearerAuth
Path
npistringrequired
Example: 1234567890
curl -i -X GET \
  https://providers.docs.askchapter.org/_mock/apis/providers/1234567890/locations \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of provider locations

Bodyapplication/jsonArray [
idstring

Provider location identifier

Example: "loc_001"
addressobject(Address)
phoneNumbersArray of strings
Example: ["+14155552671"]
faxNumbersArray of strings
Example: ["+14155552671"]
websitestring or null
Example: "https://www.example.com"
emailstring or null
Example: "contact@example.com"
groupAffiliationsArray of strings

Groups affiliated with this location

Example: ["Community Health Center"]
hospitalAffiliationsArray of strings

Hospitals affiliated with this location

Example: ["Rogue County Medical"]
pcpEligibleboolean

Whether the provider may be eligible for PCP designation at this location

]
Response
application/json
[ { "id": "loc_001", "address": {}, "phoneNumbers": [], "faxNumbers": [], "website": "https://www.example.com", "email": "contact@example.com", "groupAffiliations": [], "hospitalAffiliations": [], "pcpEligible": true } ]

Coverage

Query provider coverage by plan and NPI

Operations