Skip to main content
Workable logo
  • Category: human resources
  • Auth: OAUTH2, API_KEY
  • Composio-managed OAuth available? No
  • Tools: 37
  • Triggers: 0
  • Slug: WORKABLE
  • Version: 20261101_00

Tools

Slug: WORKABLE_CREATE_EMPLOYEETool to create an employee in your Workable account. Use when adding a new hire to employee management system. Employee can be created in draft state (unpublished) or published state (active). Requires w_employees scope.

Input Parameters

string ("draft" | "published")
required
Employee state - ‘draft’ for unpublished, ‘published’ for active employees
object
required
Employee details object containing all employee information
string
required
Member ID from GET /members endpoint - the account member creating this employee record

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_DELETE_DEPARTMENTTool to delete a department. Use when removing an obsolete or restructured department after confirming dependent resources.

Input Parameters

string
required
Unique identifier of the department to delete.
string
Set to ‘DELETE’ to force deletion regardless of associated resources.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_DELETE_SUBSCRIPTIONTool to unsubscribe from an event by deleting a webhook subscription. Use when you need to stop receiving notifications for a specific event.

Input Parameters

string
required
The unique identifier of the webhook subscription to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_GET_ACCOUNTTool to return the specified account. Use when you need account metadata by subdomain after listing available accounts.

Input Parameters

string
required
The subdomain of the account to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_GET_ACCOUNTSRetrieves all Workable accounts (organizations) accessible to the authenticated user. Returns account details including ID, name, subdomain, description, summary, and website URL. Use this action to discover which Workable accounts you have access to, or to obtain account identifiers needed for other API operations. Requires ‘r_jobs’ scope.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_GET_BACKGROUND_CHECK_PACKAGESRetrieve background check packages for a specified provider. An HTTP 404 is returned as an empty package list, so an empty result does not necessarily establish that no packages are available.

Input Parameters

string
required
Identifier (slug) of the background check provider (e.g., ‘checkr’, ‘sterling’, ‘goodhire’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_GET_BACKGROUND_CHECK_PROVIDERSRetrieve background check providers for your Workable account, including their IDs, names, integration types, connection statuses, and logo URLs. An HTTP 404 is returned as an empty list and does not necessarily mean no providers are configured.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_GET_CANDIDATERetrieve the complete recruiting profile for one Workable candidate.

Input Parameters

string
required
Unique Workable candidate identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_GET_CANDIDATESRetrieve candidates across jobs, with optional job, stage, email, and creation or update date filters. Results include candidate details and may include a next-page URL; the limit sets page size up to 100, but this action does not accept a page cursor.

Input Parameters

string
Filter candidates by email address. Returns candidates matching the specified email.
integer
Number of candidates per page. Default is 50; maximum is 100.
string
Filter candidates by stage slug. Returns only candidates currently in the specified hiring stage.
string
Filter candidates created after the specified timestamp (ISO 8601 format, e.g., ‘2024-01-01T00:00:00Z’).
string
Filter candidates by job shortcode. Returns only candidates who applied to the specified job.
string
Filter candidates updated after the specified timestamp (ISO 8601 format, e.g., ‘2024-01-01T00:00:00Z’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_GET_EMPLOYEETool to retrieve detailed information for a specific employee by ID. Use when you need complete employee data including personal details, contact info, employment history, and more. Requires r_employees scope and may need member_id parameter for account-level tokens.

Input Parameters

string
required
The employee ID to retrieve
string
Optional member ID for user tokens. Required when using account-level tokens. Obtain from GET /members endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_GET_EVENTSRetrieve a collection of scheduled events (calls, interviews, meetings) from the Workable account. Supports filtering by event type, date range, candidate, job, or team member. Use pagination parameters (limit, since_id, max_id) for large result sets. By default, cancelled events are excluded unless explicitly included.

Input Parameters

string ("call" | "interview" | "meeting")
Filter events by type (call, interview, or meeting).
integer
Maximum number of events to return per request. Used for pagination.
string
Return events with ID less than or equal to this value. Used for pagination.
string
Additional context filter for events.
string
Filter events ending on or before this date (ISO 8601 format).
string
Return events with ID greater than or equal to this value. Used for pagination.
string
Filter events where a specific member is participating.
string
Filter events associated with a specific job shortcode.
string
Filter events starting on or after this date (ISO 8601 format).
string
Filter events associated with a specific candidate ID.
boolean
Include cancelled events in the results (default: false).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_GET_JOBRetrieve the complete details of one Workable job by shortcode.

Input Parameters

string
required
Workable’s system-generated job shortcode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_GET_JOB_ACTIVITIESRetrieve a Workable job’s recruiting activity timeline by job shortcode.

Input Parameters

integer
Maximum activities to return on this page. Defaults to 50.
string
Return activities with IDs less than or equal to this value.
string
Return activities with IDs greater than or equal to this value.
string
required
Workable’s system-generated job shortcode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_GET_JOBSRetrieve a paginated list of Workable account jobs, with details such as title, state, department, location, and salary. Filter by state or creation and update dates.

Input Parameters

integer
Number of jobs to retrieve per page. Default is 50; maximum is 100.
string ("draft" | "published" | "closed" | "archived")
Filter jobs by state. One of ‘draft’, ‘published’, ‘archived’, or ‘closed’.
string
Return results with an ID less than or equal to this value.
string
Return results with an ID greater than or equal to this value.
string
Return results created after this ISO 8601 timestamp.
string
Return results updated after this ISO 8601 timestamp.
string
Comma-separated list of extra fields to include in each job (e.g., ‘description,full_description,requirements,benefits’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_GET_MEMBERSRetrieve a paginated list of Workable account members with their roles and permissions. This action fetches team members from your Workable account, including admins, standard users, reviewers, and inactive members. You can filter by role, email, name, or status, and paginate through results. Use this to list collaborators, verify member access levels, or find specific team members by email or name.

Input Parameters

string
Filter members by exact full name match
string ("admin" | "simple" | "reviewer" | "no_access")
Filter members by recruiting role (admin=All Access, simple=Standard Access, reviewer=Limited Access, no_access=No Access)
string
Filter members by exact email address match
integer
Max number of members to retrieve per page (default: 50)
string
Pagination cursor: return only members with ID less than or equal to this value
string ("active" | "inactive" | "all")
Filter by member status (default: ‘active’). Use ‘all’ to retrieve both active and inactive members
string
Pagination cursor: return only members with ID greater than or equal to this value
string
Filter by job shortcode to return only collaborators on that specific job

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_GET_RECRUITERSRetrieves external recruiters from your Workable account. Returns all external recruiters by default, or filter by job shortcode to get recruiters collaborating on a specific job. Requires r_jobs scope.

Input Parameters

string
Optional job shortcode to filter results. When provided, returns only external recruiters collaborating on the specified job. Omit to get all external recruiters in the account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_GET_REQUISITIONSTool to retrieve a collection of requisitions in the account. Use after authentication succeeds.

Input Parameters

integer
Number of results per page. Default is 50; maximum is 100.
string
Filter requisitions created after this timestamp (ISO8601 or Unix time).
string
Filter requisitions updated after this timestamp (ISO8601 or Unix time).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_GET_STAGESTool to retrieve a collection of your recruitment pipeline stages. Use when you need to list all available stages before managing candidates or pipelines.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_GET_SUBSCRIPTIONSRetrieves all webhook subscriptions configured in your Workable account. Use this tool to: - List all active webhook subscriptions that receive event notifications - Verify which events your webhooks are listening to - Check the target URLs and filters configured for each subscription - Audit your webhook configuration Requires ‘r_candidates’ or ‘r_employees’ scope. No parameters needed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_LIST_CANDIDATE_ACTIVITIESRetrieve a candidate’s recruiting activity timeline and optional page filters.

Input Parameters

integer
Maximum number of activities to retrieve. Defaults to 50.
string
Return activities with IDs less than or equal to this cursor.
string
Comma-delimited activity action types to include.
string
Return activities with IDs greater than or equal to this cursor.
string
required
Unique Workable candidate identifier.
string
Return activities updated at or after this ISO 8601 timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_LIST_CUSTOM_ATTRIBUTESTool to retrieve all custom attributes configured in the Workable account. Returns attribute configuration including ID, type, enabled status, labels, and hints. Use this action to discover available custom attributes before creating or updating candidates, jobs, or other entities that support custom fields. Requires ‘r_jobs’ scope.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_LIST_DEPARTMENTSTool to retrieve all departments from your Workable account. Use when you need to view the organizational structure or get department identifiers. Requires r_account scope.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_LIST_DISQUALIFICATION_REASONSTool to retrieve a collection of account’s disqualification reasons. Use when you need to list all available disqualification reasons before disqualifying candidates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_LIST_EMPLOYEE_FIELDSTool to retrieve a collection of your account’s employee field definitions. Use when you need to understand available employee data fields before creating or updating employee records.

Input Parameters

string
Optional member id that can be derived from GET /members endpoint. When provided, returns employee fields specific to that member

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_LIST_EMPLOYEESRetrieve a collection of account employees, with search by name or email, ordering by division or department, and pagination via limit and offset. Requires the r_employees scope.

Input Parameters

integer
Limits the number of the returned results. Default is 10.
string
Query the list using firstname, lastname and email
integer
Skips the first n entries. Using limit and offset one can navigate through the entire employee database. Default is 0.
string ("division" | "department")
Enum for order_by parameter values.
string
Optional member_id that can be retrieved by GET /members. Needed to see information with elevated access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_LIST_JOB_QUESTIONSList the application questions configured for one Workable job.

Input Parameters

string
required
System-generated shortcode of the Workable job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_LIST_PERMISSION_SETSTool to retrieve a collection of your account permission sets. Use when you need to list available permission sets before assigning permissions to members. Requires r_account scope.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_LIST_PUBLIC_JOBSRetrieve public job listings for an account by subdomain using a configured Workable connection.

Input Parameters

boolean
If true, includes description field for each job. Default is false.
string
required
The subdomain of the account to retrieve public jobs from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_LIST_PUBLIC_LOCATIONSTool to retrieve a collection of locations where a Workable account has public job postings. Use when you need to discover which geographic locations have available positions for a specific account. No authentication required.

Input Parameters

string
required
The subdomain of the Workable account (e.g., ‘composio-1’ for composio-1.workable.com). This identifies which account’s public job locations to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_LIST_TIMEOFF_BALANCESRetrieves all time off balances for an employee across all time off categories. Returns detailed balance information including available units, used units, carry-over amounts, and tracking units (days/hours). Use this to check remaining vacation days, sick leave, or other time off allowances for an employee. When using account-level token, employee_id must be provided; employee-level tokens automatically use the authenticated employee’s balances.

Input Parameters

string
The employee_id to get time off balances for. Required when using account-level token; optional when using employee-level token

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_LIST_TIMEOFF_CATEGORIESTool to retrieve all time off categories configured for your account. Use when you need to view available time off types before managing employee time off requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_LIST_WORK_SCHEDULESTool to retrieve a collection of work schedules configured in your Workable account. Use when you need to list all available work schedules, including their weekly hours, work days, and configurations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_POST_BACKGROUND_CHECKUpdates the status and results of an existing background check in a candidate’s timeline. This tool is designed for background check providers to push status updates (pending, consented, completed, declined, expired) and results back to Workable after initiating a background check. Use this action when: - A candidate has consented to or declined a background check request - Background check results are complete and need to be injected into the candidate’s timeline - The status of an ongoing background check has changed - Attaching final reports and structured results to a completed check Prerequisites: Requires a valid background_check_id from an existing background check request that was previously created through Workable’s background check provider integration. Note: Uses PUT request to /checks/{background_check_id} endpoint (despite the ‘Post’ naming).

Input Parameters

object
Structured results for a completed background check.
string ("pending" | "consented" | "completed" | "declined" | "expired")
required
New status of the background check. Options: ‘pending’ (initial status), ‘consented’ (candidate agreed to the check), ‘completed’ (check finished with results), ‘declined’ (candidate rejected the check), ‘expired’ (request timed out). When status is ‘completed’, both results_url and check fields are required.
array
Optional list of additional attachments (typically PDF reports) related to the background check results. Each attachment includes a description and publicly accessible URL.
string
Public URL link to the full background check report on the provider’s website. REQUIRED when status is ‘completed’, optional otherwise.
string
required
The unique identifier of an existing background check request in Workable. This ID is provided when the background check was initially created through the background check provider integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_POST_DEPARTMENT_MERGEMerge a department into another using their IDs. The force flag defaults to true and is sent with the merge request unless explicitly set to null.

Input Parameters

string
required
The ID of the department to be merged (source department).
boolean
Whether to force the merge. When True (default), executes the merge immediately. When False, the API validates for affected resources (e.g., collaboration_rules) and returns 409 if any exist, allowing you to assess impact before proceeding.
string
required
The ID of the target department to merge into.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_POST_DEPARTMENTSTool to create a department in your account. Use when you need to add a new department for organizing teams under your Workable account.

Input Parameters

string
required
The name of the department.
string
Identifier of the parent department, or null for top-level departments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_POST_MEMBER_ENABLEEnable a deactivated Workable account member, restoring their access to the account. Requires the w_members scope and returns an empty result on success.

Input Parameters

string
required
The unique identifier of the member to enable (restore to active status).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_POST_MEMBERS_INVITETool to invite a member to your Workable account. Use when sending an invitation email.

Input Parameters

string
required
Email address to send the invitation to.
array
required
Array of roles to assign to the invited member. Acceptable values include: ats.admin, ats.simple, ats.reviewer, hris.admin, hris.employee, hris.limited, workable.superadmin, or any custom permission sets.
string
Identifier of the existing member sending the invitation. Mandatory when using an account-wide access token.
array
Array of collaboration rules to apply to the invited member. Defines access restrictions by role, departments, and locations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_PUT_DEPARTMENTSTool to update an existing department in your account. Use when renaming a department or changing its parent after confirming its ID.

Input Parameters

string
required
Identifier of the department to update.
string
required
Department name (required by API, use current name if not changing).
string
Identifier of the parent department, or null for top-level.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_PUT_MEMBERSUpdates a Workable account member’s details including roles, name, headline, email, and collaboration rules. Requires member ID and roles array. Use this to modify existing member information such as changing permissions, updating contact details, or adjusting collaboration settings.

Input Parameters

string
required
The unique identifier of the member to be updated.
string
The full name of the member.
string
The email address of the member.
array
required
Array of roles assigned to the member. Possible values include: ‘ats.admin’, ‘ats.simple’, ‘ats.reviewer’, ‘hris.admin’, ‘hris.employee’, ‘hris.limited’, ‘workable.superadmin’. Multiple roles can be assigned to grant different permissions across recruiting and HRIS modules.
string
The headline or job title of the member.
array
An array of collaboration rules assigned to the member.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_UPDATE_EMPLOYEETool to update an existing employee in Workable. Use when you need to modify employee details such as job title, contact information, department, or other employee attributes. Requires employee ID and member ID.

Input Parameters

string
required
The unique identifier of the employee to update.
object
required
Required. Object containing employee fields to update.
string
required
Required. Member ID retrieved from GET /members endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WORKABLE_UPLOAD_EMPLOYEE_DOCUMENTSTool to upload a list of documents for a specific employee. Use when you need to attach documents (contracts, forms, etc.) to an employee’s record. Required scope: w_employees.

Input Parameters

string
required
The employee ID to upload documents for.
array
required
Array of documents to upload for the employee. Each document must have a URL and name.
string
required
Required member_id for authorization and access control.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not