Open Referral
This is a developer area for the Open Referral API, providing access to the raw data as part of an Open Referral demo. The purpose of this API is to allow anyone to develop web, mobile, or other types of applications that serve the mission of any Open 211 organization. This portal is just a demo, meant to demonstrate what is possible, if you'd like to launach an Open 211 API, feel free to reach out via one of the support channels.
On-boarding
Getting Started
Authentication
FAQ
Integration
Documentation
Code
Postman Collection
Updates
Roadmap
Issues
Change Log
Status
Terms of Service
Privacy Policy

API Paths

(Docs) OpenAPI: (YAML) (JSON)
  • Contacts
    • Get Contacts (GET) /contacts/
    • Create Contact (POST) /contacts/
    • Get Contact (GET) /contacts/{contact_id}/
    • Update Contact (PUT) /contacts/{contact_id}/
    • Delete Contact (DELETE) /contacts/{contact_id}/
  • Contact - Phones
    • Get Phones (GET) /contacts/{contact_id}/phones/
    • Add Phone (POST) /contacts/{contact_id}/phones/
    • Get Phone (GET) /contacts/{contact_id}/phones/{phone_id}/
    • Update Phone (PUT) /contacts/{contact_id}/phones/{phone_id}/
    • Delete Phone (DELETE) /contacts/{contact_id}/phones/{phone_id}/
  • Locations
    • Get Locations (GET) /locations/
    • Add Location (POST) /locations/
    • Get Location (GET) /locations/{location_id}/
    • Update Location (UPDATE) /locations/{location_id}/
    • Delete Location (DELETE) /locations/{location_id}/
  • Location - Holiday Schedule
    • Get Holiday Schedule (GET) /locations/{location_id}/holiday_schedule/
    • Add Holiday Schedule (POST) /locations/{location_id}/holiday_schedule/
    • Get Holiday Schedule (GET) /locations/{location_id}/holiday_schedule/{holiday_schedule_id}/
    • Update Holiday Schedule (PUT) /locations/{location_id}/holiday_schedule/{holiday_schedule_id}/
    • Delete Holiday Schedule (DELETE) /locations/{location_id}/holiday_schedule/{holiday_schedule_id}/
  • Location - Language
    • Get Languages (GET) /locations/{location_id}/languages/
    • Add Languages (POST) /locations/{location_id}/languages/
    • Get Languages (GET) /locations/{location_id}/languages/{language_id}/
    • Update Languages (PUT) /locations/{location_id}/languages/{language_id}/
    • Delete Languages (DELETE) /locations/{location_id}/languages/{language_id}/
  • Location - Postal Address
    • Get Postal Address (GET) /locations/{location_id}/postal_address/
    • Add New Postal Adress (POST) /locations/{location_id}/postal_address/
    • Get Postal Address (GET) /locations/{location_id}/postal_address/{postal_address_id}/
    • Update Postal Address (PUT) /locations/{location_id}/postal_address/{postal_address_id}/
    • Delete Postal Address (DELETE) /locations/{location_id}/postal_address/{postal_address_id}/
  • Location - Physical Address
    • Get Physical Address (GET) /locations/{location_id}/physical_address/
    • Add New Physical Adress (POST) /locations/{location_id}/physical_address/
    • Get Physical Address (GET) /locations/{location_id}/physical_address/{postal_address_id}/
    • Update Physical Address (PUT) /locations/{location_id}/physical_address/{postal_address_id}/
    • Delete Physical Address (DELETE) /locations/{location_id}/physical_address/{postal_address_id}/
  • Location - Phones
    • Get Phones (GET) /locations/{location_id}/phones/
    • Add Phone (POST) /locations/{location_id}/phones/
    • Get Phone (GET) /locations/{location_id}/phones/{phone_id}/
    • Update Phone (PUT) /locations/{location_id}/phones/{phone_id}/
    • Delete Phone (DELETE) /locations/{location_id}/phones/{phone_id}/
  • Location - Regular Schedule
    • Get Regular Schedule (GET) /locations/{location_id}/regular_schedule/
    • Add Regular Schedule (POST) /locations/{location_id}/regular_schedule/
    • Get Regular Schedule (GET) /locations/{location_id}/regular_schedule/{regular_schedule_id}/
    • Update Regular Schedule (PUT) /locations/{location_id}/regular_schedule/{regular_schedule_id}/
    • Delete Regular Schedule (DELETE) /locations/{location_id}/regular_schedule/{regular_schedule_id}/
  • Location - Services
    • Get Service (GET) /locations/{location_id}/services/
    • Add Service (POST) /locations/{location_id}/services/
    • Get Service (GET) /locations/{location_id}/services/{service_id}/
    • Update Service (PUT) /locations/{location_id}/services/{service_id}/
    • Delete Service (DELETE) /locations/{location_id}/services/{service_id}/
  • Location - Accessibility For Disabilities
    • Get Accessibility For Disabilities (GET) /locations/{location_id}/accessibility_for_disabilities/
    • Add Accessibility For Disabilities (POST) /locations/{location_id}/accessibility_for_disabilities/
    • Get Accessibility For Disabilities (GET) /locations/{location_id}/accessibility_for_disabilities/{accessibility_for_disabilities_id}/
    • Update Accessibility For Disabilities (PUT) /locations/{location_id}/accessibility_for_disabilities/{accessibility_for_disabilities_id}/
    • Delete Accessibility For Disabilities (DELETE) /locations/{location_id}/accessibility_for_disabilities/{accessibility_for_disabilities_id}/
  • Metadata
    • Get Metadata (GET) /metadata/
    • Add New Metadata (POST) /metadata/
    • Get Service (GET) /metadata/{metadata_id}/
    • Delete Metadata (DELETE) /metadata/{metadata_id}/
  • Organizations
    • Get Locations (GET) /organizations/
    • Create a new organization (POST) /organizations/
    • Get Organization (GET) /organizations/{organization_id}/
    • Update Existing Organization (PUT) /organizations/{organization_id}/
    • Delete Organization (DELETE) /organizations/{organization_id}/
  • Organization - Contacts
    • Get Contacts (GET) /organizations/{organization_id}/contacts/
    • Add Contact (POST) /organizations/{organization_id}/contacts/
    • Get Contact (GET) /organizations/{organization_id}/contacts/{contact_id}/
    • Update Contact (PUT) /organizations/{organization_id}/contacts/{contact_id}/
    • Delete Contact (DELETE) /organizations/{organization_id}/contacts/{contact_id}/