Colleague API Field Directory

This documentation will list the fields available via the API and the required formatting of the fields.

You can access the API Portal here: https://coll7openapi.developer.azure-api.net/

<< Back to Main API Directory

Documents

	Field Name	Format	Example	Description
	UserId *	String	"USER_10"	The Colleague 7 User ID (* Mandatory)
	OwnerId *	int64 (Integer)	"1000156"	The ID of the Candidate Record (* Mandatory)
	DefaultDocument *	int32 (Integer)	"1"	Default Document Flag (0 = Do not set as default document, 1 = Set as default document) (* Mandatory)
	Description *	String	"John Smith's CV"	Description of Document (* Mandatory)
	DocumentType	String/Lookup	"Original CV"	Document Type Lookup Description or Code (Optional)