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

CareAcademy Organizations API

The Organizations API from CareAcademy — 1 operation(s) for organizations.

CareAcademy Organizations API is one of 5 APIs that CareAcademy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Organizations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 2 operations across 1 path, and defines 1 schema. It is described by OpenAPI 3.0.0, at version 1.0.10.

Requests are made against a single base URL, https://staging.careacademy.com/api/v1.

2 operations 1 paths 1 schemas 1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.10
Base URL
https://go.careacademy.com/api/v1
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

CareAcademy Organizations API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

Paths & Operations 2

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

Organizations 2
POST
/organizations/{organizationIntegrationId}
Create an organization.
1 param body → 200201202400401
PUT
/organizations/{organizationIntegrationId}
Flags an existing organization for review in order to associate the organization with a set of locations.
1 param body → 202400401

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is OrganizationsRequest (7 properties). Each schema is shown below with its type and property counts.

OrganizationsRequest
object
7 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

careacademy-organizations-api-openapi.yml Raw ↑

Other APIs CareAcademy publishes across the network.

CareAcademy Compliance Report API
CareAcademy Locations API
CareAcademy Practitioners API
CareAcademy Sign In Url API