Languages Endpoint

Description: This endpoint allows you to search through provider languages that exist in the Ribbon API.

Endpoints:
Standard Index: /v1/languages/

Status: Live

Methods:
Standard Index: GET

Example use case:
You want your users to be able to select from a drop down list of languages spoken by providers, which you power through GET requests to this endpoint.

Diving In - Viewing all Languages

To retrieve all languages spoken by providers, you can use GET requests to the standard index:

curl -X GET \
  'https://api.ribbonhealth.com/v1/languages' \
  -H 'authorization: Token <your_token>'

And we'll see all the languages spoken by providers:

{
    "count": 333,
    "data": [
        {
            "uuid": "fc0999e7-d447-4c32-8e0c-56165a0846f3",
            "display_name": "abenaki"
        },
        {
            "uuid": "f16303d3-eff0-43ab-b9ff-27ef0bf68e01",
            "display_name": "abkhazian"
        },
        {
            "uuid": "e6c11fca-8299-4761-ba12-e67de23372da",
            "display_name": "acehnese"
        },
        ... 
    ]
}

By adding the "search" parameter, you can also use GET requests to find a specific language within this endpoint or verify that a language you would like to add to a provider is supported.

curl -X GET \
  'https://api.ribbonhealth.com/v1/language?search=chinese' \
  -H 'authorization: Token <your_token>'

Now, we can see that our response gives the results of a 'fuzzy' search, containing languages that are most relevant to our search term chinese:

{
    "count": 49,
    "data": [
        {
            "uuid": "2f6b4e64-6156-4df6-a44b-ce715bf63a00",
            "display_name": "chinese"
        },
        {
            "uuid": "ca2df47d-f735-4fd1-a08e-e2682ded6440",
            "display_name": "chinese (wenzhounese)"
        },
        {
            "uuid": "3de1a442-3b25-4862-8fed-7b0928f95faf",
            "display_name": "mandarin (chinese)"
        },
        ...
    ]
 }

❗️

Provider languages must be within Ribbon's languages reference list

When you modify the languages within a provider record, any language that you add must be in the list of languages shown in the reference endpoint above.

To check whether a language you want to add is supported, feel free to utilize our languages reference endpoint.