Find the API key you need for the carehome.co.uk APIs in your Portal.
Who can use it: the Reviews and Enquiry APIs need an Enhanced or Platinum subscription. Every setting and every group has an API key.
Find your API key
- Log in to your Portal.
- In the menu, open APIs & Integrations.
- Choose API Keys.
The page lists each setting with its location and its API key. If you log in as a group, the list also shows the group's own key, highlighted in yellow.
Which key to use
- A setting's key returns data for that setting only.
- A group's key returns data for the group and every setting in it. Each API's documentation explains how to tell the settings apart in its responses.
Pass the key as the api_key query parameter, for example:
https://api.carehome.co.uk/index.cfm/reviews?api_key=YOUR_API_KEYRelated articles
Support
Email integrations@carehome.co.uk or call 01488 684321.