To access the endpoints of this API, you need to obtain an API key. Please follow the steps below to acquire your API key:
Request API Key
https://karani.co/account/services
.Include API Key in Requests
https://karani.co/api/v1/contacts?key=MYKEY
In case of any errors while acquiring the API key, you will receive an error response with the appropriate status code and message. Please refer to the error handling section for more details.
All errors are reported with the same data shapes.
Error Responses:
{
"success": false,
"message": "Unauthorized",
"data": []
]
Response Body: {
"success": false,
"message": "Unauthorized",
"data": []
]
Status Code: 404 (Not Found)
{
"success": false,
"message": "Not Found",
"data": []
]
https://karani.co/api/v1/contacts
{
"success": true,
"message": "",
"data": [
{
"id": 1,
"name": "John Doe",
"email": "john.doe@karani.co"
// Additional contact properties
},
// Additional contacts
]
]
https://karani.co/api/v1/contacts
{
"name": "Jane Smith",
"email": "jane.smith@karani.co"
// Additional contact properties
}
{
"id": 2,
"name": "Jane Smith",
"email": "jane.smith@karani.co"
// Additional contact properties
}
https://karani.co/api/v1/contacts/{id}
https://karani.co/api/v1/contacts/{id}
{
"name": "Jane Smith",
"email": "jane.smith@karani.co"
}
{
"id": 2,
"name": "Jane Smith",
"email": "jane.smith@karani.co"
// Additional contact properties
}
https://karani.co/api/v1/gifts
{
"success": true,
"message": "",
"data": [
{
"id": 1,
"name": "John Doe",
"email": "john.doe@karani.co"
// Additional gift properties
},
// Additional gifts
]
]
https://karani.co/api/v1/gifts
{
"name": "Jane Smith",
"email": "jane.smith@karani.co"
// Additional gift properties
}
{
"id": 2,
"name": "Jane Smith",
"email": "jane.smith@karani.co"
// Additional gift properties
}
https://karani.co/api/v1/gifts/{id}
https://karani.co/api/v1/gifts/{id}
{
"name": "Jane Smith",
"email": "jane.smith@karani.co"
}
{
"id": 2,
"name": "Jane Smith",
"email": "jane.smith@karani.co"
// Additional gift properties
}
https://karani.co/api/v1/pledges
{
"success": true,
"message": "",
"data": [
{
"id": 1,
"name": "John Doe",
"email": "john.doe@karani.co"
// Additional pledge properties
},
// Additional pledges
]
]
https://karani.co/api/v1/pledges
{
"name": "Jane Smith",
"email": "jane.smith@karani.co"
// Additional pledge properties
}
{
"id": 2,
"name": "Jane Smith",
"email": "jane.smith@karani.co"
// Additional pledge properties
}
https://karani.co/api/v1/pledges/{id}
https://karani.co/api/v1/pledges/{id}
{
"name": "Jane Smith",
"email": "jane.smith@karani.co"
}
{
"id": 2,
"name": "Jane Smith",
"email": "jane.smith@karani.co"
// Additional pledge properties
}
https://karani.co/api/v1/tasks
{
"success": true,
"message": "",
"data": [
{
"id": 1,
"name": "John Doe",
"email": "john.doe@karani.co"
// Additional task properties
},
// Additional tasks
]
]
https://karani.co/api/v1/tasks
{
"name": "Jane Smith",
"email": "jane.smith@karani.co"
// Additional task properties
}
{
"id": 2,
"name": "Jane Smith",
"email": "jane.smith@karani.co"
// Additional task properties
}
https://karani.co/api/v1/tasks/{id}
https://karani.co/api/v1/tasks/{id}
{
"name": "Jane Smith",
"email": "jane.smith@karani.co"
}
{
"id": 2,
"name": "Jane Smith",
"email": "jane.smith@karani.co"
// Additional task properties
}