Welcome to the Colleague API
If you are new to the API Sign up below
With access to the Colleague API and a subscription key to a client system, a Developer can use multiple API calls to search, add, edit, remove and download record data and document info.
Further support is also available from our API Field Directory via the Colleague Helpfile.
For more assistance please contact our Support Team
Email : support@colleaguesoftware.com
Telephone : 01603 735930
Our API calls support mulitple integrations, seamlessly passing data to and from third party solutions.
Example API Call - Create New Candidate
A successful response will provide a Candidate ID.
This can then be used with accompanying API calls such as Upload Document and Create History.
PUT /api/Candidate/Insert
{
"userId": "APIUSER_1",
"forenames": "Example",
"surname": "Candidate",
"knownAs": "Sample",
"title": "Mr",
"directNumber": "01603735930"
}
Powered by Azure API Management.