Hello World API

Follow

Summary:
The Hello World API is the easiest method to test the CANDDi API
This API validates that your API token is correct and returns Hello [Name]


GET [host]/hello

URL: https://[slug].canddi.com/hello
Verb: GET
Parameters: (none)


Example
curl -i -H'CANDDi_API:[API_KEY]' -H'Accept:application/json' https://[slug].canddi.com/hello

Success Response

{"Name":"Tim Langley"}

 

Failure Response

If the API key is invalid - will return HTTP status: 401 (Authentication required)

If the User doesn't have access to this account then will return HTTP status: 401

Have more questions? Submit a request

Comments