Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kareo Administrative API

Vendor registration, throttles, and configuration

Kareo Administrative API is one of 8 APIs that Kareo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Administrative. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 4 operations across 4 paths, and defines 11 schemas. It is described by OpenAPI 3.0.3, at version 2.1.

Requests are made against a single base URL, https://webservice.kareo.com/services/soap/2.1.

4 operations 4 paths 11 schemas 4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.1
Base URL
https://webservice.kareo.com/services/soap/2.1/KareoServices.svc
Terms of Service
Resource Areas
1

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 POST. Each is listed below with its method, path, parameters, and response codes.

Administrative 4

Vendor registration, throttles, and configuration

POST
/KareoServices.svc/RegisterExternalVendor
Register an external vendor integration
registerExternalVendor body → 200401
POST
/KareoServices.svc/GetExternalVendors
Retrieve registered external vendors
getExternalVendors body → 200401
POST
/KareoServices.svc/GetThrottles
Retrieve API throttle limits
getThrottles body → 200401
POST
/KareoServices.svc/GetCustomerIdFromKey
Resolve customer identifier from CustomerKey
getCustomerIdFromKey body → 200401

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are ExternalVendor (4 properties), RegisterExternalVendorResponse (4 properties), RequestHeader (3 properties), GetCustomerIdFromKeyResponse (3 properties). Each schema is shown below with its type and property counts.

GetThrottlesRequest
object
1 property
RegisterExternalVendorResponse
object
4 properties
GetCustomerIdFromKeyResponse
object
3 properties
GetExternalVendorsResponse
object
3 properties
ThrottleLimit
object
3 properties
GetExternalVendorsRequest
object
1 property
RegisterExternalVendorRequest
object
3 properties
GetThrottlesResponse
object
3 properties
GetCustomerIdFromKeyRequest
object
2 properties
RequestHeader
object
3 properties 3 required
ExternalVendor
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kareo-administrative-api-openapi.yml Raw ↑

Other APIs Kareo publishes across the network.

Kareo Integration SOAP API
Kareo Clinical Open API
Kareo Appointments API
Kareo Billing API
Kareo Encounters API
Kareo Patients API
Kareo Providers API