Skip to main content

HSDA API Documentation

Endpoints and use-cases for our HSDA product.

Skyler Young avatar
Written by Skyler Young
Updated over a month ago

Base Endpoint

https://c211.io/api/v1/

All endpoints are documented here: https://c211.io/api/swagger-ui/#/crate/organizations

Authentication for our Swagger page is clumsy; it was originally designed for a different use-case. While that's being updated, we recommend using Swagger for reference, but making direct calls via CURL, Postman, or your tool of choice, for testing.

Authorization

Header:

Authorization: Bearer {api_key}

Common Uses of HSDA

We develop and support HSDA endpoints on an "as-needed" basis for specific use-cases.

Data Replication

https://c211.io/api/v1/organizations?full=true

Return all resources from a source in bulk. Services and Locations will be efficiently nested under their parent Organizations, with all available data nested under those primary structures. Be sure to use the setting full = true for data replication.

Specifications for /organizations

To see the specifications please refer to the Open Referral site:

As and extension, we have added fields to further clarify the data. For example, labeling phone numbers, organization schedules, contact emails, etc.

Payload Examples for /organizations

GitHub also has examples of the JSON payload you can expect:

Additional Notes:

When viewing the JSON examples above, note that our payloads follow this spec rigorously, but also includes additional information designed to clarify intended use. For example, given a list of phone number related to a service, we will communicate in what order those numbers should be prioritized from the perspective of help seekers.

Resource Details

https://c211.io/api/v1/service_at_locations?full=true

Return all details, or related data, for a specific service_at_location object. In the context of the Connect 211 resource directory, this is all possible information that would be displayed as "Details" for a "Search Record".

Clean vs Raw Data

Our APIs return data that has been cleaned and augmented to some degree before being published. If you need raw data, please let us know ahead of time. This is not currently available, but is on our roadmap.

Did this answer your question?