Available Breezy HR APIs

Naga Sri Hari Gonaboyina

Updated November 26, 2024 16:33

When you configure an export, import, or other type of flow step using the prebuilt Breezy HR connector, you can select any of the API operations listed below*, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Breezy HR API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource	API endpoint	Export	Import
Candidate	Retrieve candidates for a given position with an abbreviated candidate object	X
	Retrieve all candidates with the entered email address	X
	Get candidate ID custom fields	X
	Retrieve all 3rd party background checks for candidate	X
	Add a new candidate to a position		X
	Update candidate custom field by ID		X
	Move the candidate to the specified stage		X
	Update a candidate on a position		X
	Retrieve all 3rd party assessments the candidate has taken	X
	Add a new conversation message for the candidate		X
	Add a custom attribute to a candidate		X
	Add a new document for the candidate		X
	Add an education entry to a candidate		X
	Retrieve candidate metadata by ID for a given position		X
	Move a candidate from one position to another		X
	Save candidate responses to a questionnaire		X
	Retrieve candidate questionnaires		X
	Update candidate scorecard for user		X
	Create a new questionnaire for a candidate		X
	Add a note to a candidate's discussion stream		X
	Add a work history entry to a candidate		X
Position	Retrieve all positions for a given company in a given state (status)	X
	Retrieve details for a given position ID	X
	Create a new position		X
	Update details for a given position		X
	Update details for a given position		X
	Retrieve the last 30 activity stream events for the given position		X
	Retrieve user objects of all position team members	X
	Get custom fields for a specific position	X
	Update the value of a custom field for a specific position		X
Company	Retrieve all of the company pipelines	X
	Retrieve pipeline stages by pipeline ID	X
	Retrieve the company information associated with the authenticated user and company ID		X
	Retrieve all of the candidate specific custom attributes		X
	Retrieve all of the position specific custom attributes		X
	Retrieve the questionnaire by ID		X
	Retrieve all of the company questionnaires		X
	Retrieve email template by ID	X
	Retrieve all of the company email templates	X
	Retrieve the companies associated with the authenticated user		X
Authorization endpoints	Retrieve an access token. Use the access token as part of the Authorization header		X
Authorization endpoints	Invalidate an access token		X
User endpoints	Retrieve the authenticated user or another user by ID		X
User endpoints	Retrieve the details for the configurations of each company the authenticated user belongs to	X