Workable

Learn how to use Workable with Composio

Overview

SLUG

WORKABLE

Description

Workable is an all-in-one HR software platform that streamlines hiring, employee data management, time tracking, and payroll.

Authentication Details

subdomain
stringRequired
generic_api_key
stringRequired

Tools

SLUG: WORKABLE_GET_CANDIDATES

Tool to retrieve a list of all candidates across jobs. use when you need to aggregate candidate data across your organization.

Action Parameters

limit
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: WORKABLE_DELETE_DEPARTMENT

Tool to delete a department. use when removing an obsolete or restructured department after confirming dependent resources.

Action Parameters

force
string
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: WORKABLE_GET_ACCOUNT

Tool to return the specified account. use when you need account metadata by subdomain after listing available accounts.

Action Parameters

subdomain
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: WORKABLE_GET_ACCOUNTS

Tool to retrieve a collection of all accounts you have access to. use when you need to list your workable accounts after authentication.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: WORKABLE_GET_BACKGROUND_CHECK_PACKAGES

Tool to retrieve a list of available background check packages from a specified provider. use after identifying the provider to view available package options.

Action Parameters

provider
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: WORKABLE_GET_BACKGROUND_CHECK_PROVIDERS

Tool to retrieve a list of available background check providers. use after confirming valid authentication to list integrated background check services.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: WORKABLE_GET_EVENTS

Tool to retrieve a collection of events scheduled in the account. use when you need to list all upcoming or past calls, interviews, or meetings.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: WORKABLE_GET_JOBS

Tool to retrieve a list of jobs from your workable account. use after validating account authentication before managing job postings.

Action Parameters

created_after
string
include_fields
string
limit
integer
max_id
string
since_id
string
state
string
updated_after
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: WORKABLE_GET_MEMBERS

Tool to retrieve a list of your workable account members. use after confirming valid authentication to fetch collaborators, admins, or reviewers.

Action Parameters

limit
integer
max_id
string
role
string
shortcode
string
since_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: WORKABLE_GET_RECRUITERS

Tool to retrieve external recruiters. use when you need to fetch all external recruiters for your account after confirming the r jobs scope.

Action Parameters

shortcode
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: WORKABLE_GET_REQUISITIONS

Tool to retrieve a collection of requisitions in the account. use after authentication succeeds.

Action Parameters

created_after
string
limit
integer
updated_after
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: WORKABLE_GET_STAGES

Tool to retrieve a collection of your recruitment pipeline stages. use when you need to list all available stages before managing candidates or pipelines.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: WORKABLE_GET_SUBSCRIPTIONS

Tool to list all active subscriptions. use after verifying webhooks configuration to ensure subscriptions are active.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: WORKABLE_POST_BACKGROUND_CHECK

Tool to inject background check results directly into the candidate's timeline. use after a background check status changes to push results and attachments into workable.

Action Parameters

attachments
array
background_check_id
stringRequired
check
object
results_url
string
status
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: WORKABLE_POST_DEPARTMENTS

Tool to create a department in your account. use when you need to add a new department for organizing teams under your workable account.

Action Parameters

name
stringRequired
parent_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: WORKABLE_POST_DEPARTMENT_MERGE

Tool to merge a department into another. use after confirming both department ids and optional force flag.

Action Parameters

force
boolean
id
stringRequired
target_department_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: WORKABLE_POST_MEMBERS_INVITE

Tool to invite a member to your workable account. use when sending an invitation email.

Action Parameters

collaboration_rules
array
email
stringRequired
hris_role
string
member_id
string
role
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: WORKABLE_POST_MEMBER_ENABLE

Tool to restore a deactivated member. use after confirming the member is currently deactivated.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: WORKABLE_PUT_DEPARTMENTS

Tool to update an existing department in your account. use when renaming a department or changing its parent after confirming its id.

Action Parameters

id
stringRequired
name
string
parent_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: WORKABLE_PUT_MEMBERS

Tool to update a member's details. use when you need to modify information of an existing member after confirming the id.

Action Parameters

collaboration_rules
array
email
string
headline
string
hris_role
string
id
stringRequired
name
string
role
string

Action Response

data
objectRequired
error
string
successful
booleanRequired