Getting Access
To access the WelcomeHome API, you will need an API Token.
- If you are an admin user in WelcomeHome, you can manage and generate API Tokens in the API Token setup.
- If you are a 3rd party integrating with WelcomeHome, our support team can provide you with access to a test account. Please contact emily@welcomehomesoftware.com - For production access, your client will need to provide you with an API token specific to their WelcomeHome account.
Authorization
When making requests, include your API Token in an Authorization request header like so:
Authorization: Token token={your_token_here}
You can test your API token using the "/api/ping" endpoint. For example:
curl https://crm.welcomehomesoftware.com/api/ping -H "Authorization: Token token={token_here}"
A successful authorization returns with response code 200 and a JSON body describing the account the token provides access to. E.g.,
{"account_id":2}
A failed authorization returns with response code 401 and the message:
{"error":"Bad credentials"}
API Endpoints Documentation
Once you have an API Token and are able to ping successfully, you can use this link to learn about the endpoints available to you via the API: https://crm.welcomehomesoftware.com/api-docs/index.html