Breezy HR is an applicant tracking system (ATS) used by small to medium-sized businesses. It helps companies manage their recruitment process, from posting jobs to hiring candidates.
Official docs: https://breezy.hr/api/
Use action names and parameters as needed.
This skill uses the Membrane CLI to interact with Breezy HR. Membrane handles authentication and credentials refresh automatically — so you can focus on the integration logic rather than auth plumbing.
Install the Membrane CLI so you can run membrane from the terminal:
npm install -g @membranehq/cli@latest
membrane login --tenant --clientName=<agentType>
This will either open a browser for authentication or print an authorization URL to the console, depending on whether interactive mode is available.
Headless environments: The command will print an authorization URL. Ask the user to open it in a browser. When they see a code after completing login, finish with:
membrane login complete <code>
Add --json to any command for machine-readable JSON output.
Agent Types : claude, openclaw, codex, warp, windsurf, etc. Those will be used to adjust tooling to be used best with your harness
Use connection connect to create a new connection:
membrane connect --connectorKey breezy
The user completes authentication in the browser. The output contains the new connection id.
membrane connection list --json
Search using a natural language description of what you want to do:
membrane action list --connectionId=CONNECTION_ID --intent "QUERY" --limit 10 --json
You should always search for actions in the context of a specific connection.
Each result includes id, name, description, inputSchema (what parameters the action accepts), and outputSchema (what it returns).
| Name | Key | Description |
|---|---|---|
| --- | --- | --- |
| Add Candidate Note | add-candidate-note | Add a note to a candidate's activity stream (conversation) |
| Get Position Team | get-position-team | Retrieve the team members assigned to a position |
| Update Position State | update-position-state | Update the state (status) of a position (draft, published, closed, etc.) |
| List Pipelines | list-pipelines | Retrieve all hiring pipelines for a company |
| Search Candidates | search-candidates | Search for candidates by email address across all positions in a company |
| Update Candidate Stage | update-candidate-stage | Move a candidate to a different stage in the hiring pipeline |
| Update Candidate | update-candidate | Update an existing candidate's details |
| Create Candidate | create-candidate | Add a new candidate to a position |
| Get Candidate | get-candidate | Retrieve details for a specific candidate |
| List Candidates | list-candidates | Retrieve all candidates for a specific position |
| Update Position | update-position | Update an existing position (job) |
| Create Position | create-position | Create a new position (job) in a company |
| Get Position | get-position | Retrieve details for a specific position (job) |
| List Positions | list-positions | Retrieve all positions (jobs) for a given company |
| Get Company | get-company | Retrieve details for a specific company |
| List Companies | list-companies | Retrieve all companies associated with the authenticated user |
| Get Current User | get-current-user | Retrieve the authenticated user's information |
If no suitable action exists, describe what you want — Membrane will build it automatically:
membrane action create "DESCRIPTION" --connectionId=CONNECTION_ID --json
The action starts in BUILDING state. Poll until it's ready:
membrane action get <id> --wait --json
The --wait flag long-polls (up to --timeout seconds, default 30) until the state changes. Keep polling until state is no longer BUILDING.
READY — action is fully built. Proceed to running it.CONFIGURATION_ERROR or SETUP_FAILED — something went wrong. Check the error field for details.membrane action run <actionId> --connectionId=CONNECTION_ID --json
To pass JSON parameters:
membrane action run <actionId> --connectionId=CONNECTION_ID --input '{"key": "value"}' --json
The result is in the output field of the response.
membrane action list --intent=QUERY (replace QUERY with your intent) to find existing actions before writing custom API calls. Pre-built actions handle pagination, field mapping, and edge cases that raw API calls miss.共 2 个版本