← Back to Help Centre

 

API API Details API Field Directory Support Team

 

A developer can register to access Colleague’s API at coll7openapi.developer.azure-api.net.

Once registered, the developer can subscribe to access a client’s system by going to ‘Products’ and then ‘Colleague 7 - Live’:

Within this area, the developer adds a subscription and advises the company they are attempting to gain a subscription key to access:

Enter ‘Demo Environment’ if you are not acting on behalf of a specific client.

Colleague Software will then seek authorisation from the client. When authorisation is granted, Colleague applies the subscription key to the developer’s account and provides the connection details.

With access to the API and a subscription key to a client’s database, a developer can use the various methods of searching, adding, editing, removing and downloading that are available. To date, these options include:

• Search for existing Candidates with the supplied criteria, returning the requested columns
• Search for existing Companies with the supplied criteria, returning the requested columns
• Search for existing Contacts with the supplied criteria, returning the requested columns
• Search for existing Requirements with the supplied criteria, returning the requested columns
• Search for existing Placements with the supplied criteria, returning the requested columns
• Get a list of searchable fields from an entity type

• Create a Candidate record
• Get an existing Candidate record
• Update an existing Candidate record
• Create a Candidate Experience record
• Update an existing Candidate Experience record
• Get all Experiences related to a Candidate record
• Download the latest Document for the specified Candidate
• Download a specified Document from the Colleague system
• Get all available documents associated with a Candidate record
• Retrieve the latest Document info for the specified Candidate
• Upload a Document to a Candidate record

• Create a Company record
• Create a Contact record
• Get an existing Company record
• Get an existing Contact record
• Update an existing Company record
• Update an existing Contact record

• Add a list to a specified user
• Add a record to a specified list
• Get lists owned by a user
• Get all lists belonging to multiple users
• Delete a record from a user list
• Delete a user list
• Get all records within a specified list

• Add a Candidate to a Requirement using a Candidate and Requirement ID
• Retrieve a list of Candidates associated with the selected Requirement

• Add a History to one or multiple participants
• Get recent history items for the specified entity

• Add a Report User as an owner of an entity
• Add a User as an owner of an entity

• Add a social media link to a specified entity
• Find any existing entities with a specified social media link URL
• Update an existing social media link with a modified URL
• Delete a requested social media link from an entity record

• Get all skills in the Colleague system
• Get the lookups in use on Candidate records
• Get the lookups underneath a specified parent (top-level lookups returned if none specified)
• Retrieve a user’s Report Team IDs based on the supplied Report User ID
• Retrieve a list of users

• Fetch all skills belonging to the specified entities
• Get Notes via Entity Type/ID
• Get Notes via ID (specified on entity if notes aren’t default)
• Update or insert Notes via Entity Type/ID/Sequence

Example code is provided with each API call, and the Colleague Support Team will support authorised developers with any queries.

Further support is available from Colleague’s API Field Directory via the Helpfile: API Field Directory.

There is also an API status page to test whether your User ID / subscription key is working and whether the API is responsive: API Status Test.