Breezy Hr integration: operations for AI agents
Breezy Hr connects to Type.com as an integration. This page lists the 71 operations documented for Claude and Codex in Type.com: 37 read, 19 write, 15 destructive.
About Breezy Hr
Integrate Breezy HR to streamline your recruiting and applicant tracking processes.
Categories: HR & Recruiting
How to connect Breezy Hr to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
71 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
71 operations listed.
Auth
- Read
/signout
Invalidates the current access token, signing the user out; returns 204 with no body. Idempotent: the endpoint always returns 204, even if the Authorization header is missing or the token was already invalid/expired — there is no error response for this case.
- Write
/signin
Authenticate with an email and password and receive an accesstoken to send as the Authorization header on subsequent requests. If the user already holds a valid token it is returned as-is rather than a new one being issued; tokens are valid for 30 days from last use.
Health
- Read
/health
Returns 200 OK if the API service is running; the response body is the plain-text status message OK. Use this as a simple liveness check.
User
- Read
/user
Returns the profile of the currently authenticated user.
- Read
/user/details
Returns a snapshot of every company the authenticated user belongs to, keyed by each company's friendlyid.
Companies
- Read
/companies
Returns the companies the authenticated user belongs to, as an array of company summary objects (id, name, friendlyid, membercount, initial, creationdate, updateddate).
- Read
/company/{id}
Retrieves the company identified by companyId and returns its public profile: id, name, friendlyid, membercount, initial, creationdate, and updateddate.
- Read
/company/{id}/categories
Returns the list of position category definitions available to the company, each with an id and name. The response combines Breezy's standard built-in categories (e.g.
- Read
/company/{id}/departments
Returns the list of department definitions configured for the company, each with an id and name. A department's name is the value accepted for the department field when creating or updating a position.
- Read
/company/{id}/pipelines
Returns the company's configured hiring pipelines as a JSON object keyed by pipeline name (e.g. default, defaultpool), where each value is a Pipeline object.
- Read
/company/{id}/questionnaires
Returns the list of questionnaires configured for the company. Each item includes the questionnaire's id, name, sections, questions, messagetemplate, and options.
- Read
/company/{id}/templates
Returns the list of message templates configured for the company, each item including its id, name, and body. Returns all templates in a single response (no pagination).
- Read
/company/{id}/custom-attributes/{id}
Returns the custom attribute definitions configured for the company, filtered by entity type (candidate or position). Each item includes its id, name, and whether it is secure.
- Read
/company/{id}/custom-fields/{id}
Returns the company's custom field definitions for the given type (candidate or position) — the field metadata (name, data type, options, etc.) configured at the company level, not the values recorded on any specific candidate or position.
- Read
/company/{id}/pipeline/{id}
Returns the ordered list of stages that make up the specified pipeline, as an array of stage objects (e.g. id, name, icon) — not the full pipeline record (name, dates, etc.).
- Read
/company/{id}/questionnaire/{id}
Retrieves a single questionnaire belonging to the company by its ID, including its sections and questions (each with its text, type, required flag, and answer options), the associated message template, and questionnaire options such as the default "move to" pipeline stage/status.
- Read
/company/{id}/template/{id}
Retrieves a single saved message template for the company by its templateId, returning the template's id, name, and body.
Webhooks
- Read
/company/{id}/webhookendpoints
Lists the webhook endpoints configured for the company, along with quota usage.
- Read
/company/{id}/webhookendpoint/{id}
Retrieves a single webhook endpoint's configuration and delivery stats by its ID.
- Write
/company/{id}/webhookendpoints
Creates a new webhook endpoint for the company and subscribes it to the specified event types, so matching events are delivered to the given URL as they occur. Each company is limited to 10 webhook endpoints — exceeding this quota returns a 429.
- Write
/company/{id}/webhookendpoint/{id}/pause
Pauses a webhook endpoint, stopping event deliveries to it, and returns the updated webhook endpoint object. Sets the endpoint's status to paused and enabled to false; the endpoint and its configuration are preserved and can be re-enabled later via the resume endpoint.
- Write
/company/{id}/webhookendpoint/{id}/resume
Resumes a paused (or auto-disabled) webhook endpoint, setting it back to active and re-enabling event delivery.
- Destructive
/company/{id}/webhookendpoint/{id}
Updates an existing webhook endpoint and returns the updated resource. Only the fields included in the request body are changed — omitted fields keep their current value.
- Destructive
/company/{id}/webhookendpoint/{id}
Permanently deletes the specified webhook endpoint so it stops receiving any further event deliveries. Note: the response is a 200 JSON confirmation object (success, message, endpointid), not an empty body.
Positions
- Read
/company/{id}/positions
Returns the positions belonging to the specified company. - Filter by lifecycle state with the state query parameter (published, draft, archived, closed, pending); when state is omitted, archived positions are excluded from the results.
- Read
/company/{id}/position/{id}
Retrieves a single position by ID, returning its full details (name, type, state, location, department, description, application form configuration, salary range, custom attributes, and team/admin user lists).
- Read
/company/{id}/position/{id}/custom-fields
Returns the custom fields configured on the specified position as an array of field objects (id, name, type, datatype, value, requirement, and, where applicable, options). For fields with datatype: "attachment", value is an array of attachment objects.
- Read
/company/{id}/position/{id}/stream
Returns the position's activity stream: a list of state-change events recorded against the position (e.g. transitions between draft, published, closed, and archived).
- Read
/company/{id}/position/{id}/team
Returns the list of team members assigned to the specified position, including each member's user profile and the role(s) (e.g. recruiter, hiring manager, interviewer) they hold on that position.
- Write
/company/{id}/positions
Creates a new position (job requisition) for the company and returns the newly created position object. name, type, description, and location.country are required.
- Destructive
/company/{id}/position/{id}
Updates an existing position and returns the full updated position object. This is a partial update — include only the fields you want to change; any field not on the position's editable-fields list is silently dropped from the request.
- Destructive
/company/{id}/position/{id}/state
Updates the state (lifecycle status) of a position, moving it between published, draft, archived, and closed. Returns no content on success. Setting state to published can fail with a 400 error if the company has reached its active position limit.
- Destructive
/company/{id}/position/{id}/custom-fields/{id}
Sets the value of a single custom field on a position, identified by its custom field ID.
Candidates
- Read
/company/{id}/candidates/search
Finds candidates in the company whose email address matches emailaddress, searching company-wide across all positions rather than within a single job. Matching is exact on the normalized (lowercased, trimmed) email address — not a partial or fuzzy text search.
- Read
/company/{id}/position/{id}/candidates
Returns the candidates on a given position within a company, as an array of candidate summaries (id, name, contact info, stage, source, score, resume link, etc.). Pass stageid to restrict the result to one pipeline stage.
- Read
/company/{id}/position/{id}/candidate/{id}
Retrieves a single candidate by ID, scoped to the given company and position, and returns the full candidate profile (contact info, source, stage, resume, education, work history, tags, scoring, etc.).
- Read
/company/{id}/position/{id}/candidate/{id}/assessments
Returns the candidate's assessment results from integrated pre-employment testing providers (currently HackerRank, Criteria Corp, and Indeed Assessments), including status, score(s), test link, and report URL for each.
- Read
/company/{id}/position/{id}/candidate/{id}/background-checks
Returns the list of background check results requested for the candidate on this position. Each result includes serviceid (goodhire or checkr), id, status, reporturl, creationdate, updateddate, and completiondate.
- Read
/company/{id}/position/{id}/candidate/{id}/conversation
Returns the candidate's message and activity thread — messages sent to or from the candidate (including messages posted by external users) and interview/meeting-time proposal events — ordered newest first.
- Read
/company/{id}/position/{id}/candidate/{id}/custom-fields
Returns the custom field values recorded for a candidate on the specified position, as an array of custom field objects. Each object includes the field's id, name, type, datatype, value, secure flag, options, and the parent companycustomfieldid.
- Read
/company/{id}/position/{id}/candidate/{id}/documents
Returns the files stored for the candidate on this position — resumes and other documents uploaded by the candidate or added by recruiters — ordered most recently uploaded first. Each document's fileurl is a secured download URL rather than a direct file link.
- Read
/company/{id}/position/{id}/candidate/{id}/meta
Returns a single aggregated bundle of activity and content for a candidate on a given position: tasks, notes (notepad and team notepad), documents, scorecards, questionnaires, interview schedule, stream (pipeline activity), conversation (messages), background checks, assessments…
- Read
/company/{id}/position/{id}/candidate/{id}/questionnaires
Returns the questionnaires sent to this candidate for the given position, including each questionnaire's sections and questions along with the candidate's submitted responses.
- Read
/company/{id}/position/{id}/candidate/{id}/resume
Downloads the candidate's resume file, streamed directly from storage as a binary response (not JSON), with a Content-Disposition: attachment header whose filename is derived from the stored resume URL.
- Read
/company/{id}/position/{id}/candidate/{id}/stream
Returns the candidate's activity stream on the position — a chronological array of StreamActivity events (e.g. stage moves, notes, interviews, questionnaire activity), each with a type, timestamp, firstofday flag, and an object payload whose shape varies by event type.
- Write
/company/{id}/candidates/search
Free-text search across every candidate in the company, served by the same search index that powers in-app candidate search. This verb always returns the paginated envelope below - one request contract, one response contract. emailaddress is not accepted here and returns 400.
- Write
/company/{id}/position/{id}/candidates
Creates a candidate on the specified position and returns the created candidate record. - origin: sourced (the default) adds the candidate directly into the position's "Applied" stage, as if manually sourced.
- Write
/company/{id}/position/{id}/candidates/resume
Uploads a resume file, parses it, and creates a new candidate on the given position from the extracted data (name, contact info, work history, education, etc.), returning the created candidate. Send the resume as multipart/form-data with a required resume field.
- Write
Create or update a candidate assessment result
Upserts an assessment keyed on (providertype, externalid) for the candidate-position. When authenticated with a partner API key, providertype is set from the partner registry and providername in the body is ignored.
- Write
/company/{id}/position/{id}/candidate/{id}/conversation
Sends a message to the candidate within their conversation for this position, delivering it directly to the candidate (e.g. by email), and returns the resulting conversation activity record.
- Write
/company/{id}/position/{id}/candidate/{id}/documents
Uploads a file and attaches it to the candidate as a document, returning the created document record. Send the file as multipart/form-data with the field name document.
- Write
/company/{id}/position/{id}/candidate/{id}/move
Moves a candidate to a target position and pipeline stage, and returns the updated candidate. targetpositionid and targetstageid are required. Set stageactionsenabled to true to run the target stage's configured automated actions (e.g.
- Write
/company/{id}/position/{id}/candidate/{id}/resume
Uploads a resume file and attaches it to the specified candidate, replacing any resume currently on file. Send the file as multipart/form-data with the field name resume. Accepted formats are PDF, DOC, DOCX, TXT, RTF, Pages, HTML/HTM, and CFB/AI.
- Write
/company/{id}/position/{id}/candidate/{id}/send-questionnaire
Sends an existing questionnaire template to the candidate, attaching it to the candidate's record on the given position and returning the resulting candidate questionnaire (sections, questions, status, etc.).
- Write
/company/{id}/position/{id}/candidate/{id}/stream
Adds an internal note to the candidate's activity stream and returns the created stream activity, including the note body and the position/candidate/acting-user context. Notes are internal to your team — they are not sent to or visible by the candidate.
- Write
/company/{id}/position/{id}/candidate/{id}/questionnaire/{id}
Submits a candidate's answers to a questionnaire that was sent to them, validates them against the questionnaire's questions, and marks the questionnaire completed.
- Destructive
/company/{id}/position/{id}/candidate/{id}
Updates editable profile fields on an existing candidate within a position, and returns the full updated candidate object. This is a partial update — include only the fields you want to change.
- Destructive
Delete a candidate assessment result
Deletes an assessment by Breezy id. When authenticated with a partner API key, only assessments owned by that partner's providertype may be deleted.
- Destructive
/company/{id}/position/{id}/candidate/{id}/custom-attribute
Sets a custom attribute on a candidate and returns the updated candidate object. Requires name and a string value; if a custom attribute with the same name (and secure flag) already exists on the candidate, its value is updated, otherwise a new attribute is added.
- Destructive
/company/{id}/position/{id}/candidate/{id}/education
Adds a new education entry to the candidate's profile and returns the updated Candidate object. The new entry is appended to the candidate's existing education history rather than replacing it.
- Destructive
/company/{id}/position/{id}/candidate/{id}/scorecard
Records a scorecard rating for the candidate on the specified position, attributed to the authenticated API user. Requires score, one of verygood, good, neutral, poor, or verypoor; only score and note are persisted, and all other request body properties are silently discarded.
- Destructive
/company/{id}/position/{id}/candidate/{id}/stage
Moves the candidate to a different stage in the position's pipeline, identified by stageid. stageid must match a stage in that position's pipeline (falling back to the company's default pipeline); an unknown stage id fails the request.
- Destructive
/company/{id}/position/{id}/candidate/{id}/work-history
Appends a new entry to the candidate's work history and returns the full updated Candidate object. companyname is required.
- Destructive
/company/{id}/position/{id}/candidate/{id}/custom-fields/{id}
Updates the value of one custom field on a candidate, identified by the company-level custom field ID, and returns the candidate's complete list of custom fields reflecting the change.
Company
- Read
./webhookendpoints
List all webhook endpoints for the company
- Read
./webhookendpoint/:id
Get a single webhook endpoint by ID
- Write
./webhookendpoints
Create a new webhook endpoint
- Write
./webhookendpoint/:id/pause
Pause webhook delivery to an endpoint
- Write
./webhookendpoint/:id/resume
Resume webhook delivery to a paused endpoint
- Destructive
./webhookendpoint/:id
Update an existing webhook endpoint
- Destructive
./webhookendpoint/:id
Delete a webhook endpoint
No operations match.
See How connections work for access and permissions, or browse all integrations.