> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Crelate

> How to set up the Crelate connector, plus the actions that are available.

![Crelate](https://stackone-logos.com/api/crelate/filled/svg)

Betav1.1.2[See changelog](https://docs.stackone.com/connectors/crelate/changelog.md)

[61 actions](#actions) · 1 auth method

ATS
CRM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/crelate/guides/connector-profile/api-key.md)
>
> An API key generated from your Crelate account is required. API access must be enabled for your organization by an admin...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/crelate/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

61 actions

ActionDescription

List Activities`crelate_list_activities`

Returns a paged list of activity records. Filter by parent record, verb type, date range, or other criteria.

Get Activity`crelate_get_activity`

Returns a single Activities record by its unique identifier. Returns a 404 if the record does not exist.

Get Activity Info`crelate_get_activity_info`

Retrieves attribute information specific to the Activities type. This data changes rarely and Crelate recommends caching...

Create Activity`crelate_create_activity`

Creates a new Activities record and returns its generated ID.

Update Activity`crelate_update_activity`

Partially updates an existing Activities record. Only fields included in the request body are modified; omitted fields a...

Delete Activity`crelate_delete_activity`

Permanently deletes an Activity record by its unique identifier.

Create Activity With Attachment`crelate_create_activity_with_attachment`

Creates a new Activity record and simultaneously uploads and links one or more files as Artifacts via a multipart form....

List Applications`crelate_list_applications`

Records must match all filters provided unless the OR filter operator is specified. \<br> If no sort\_by is provided, the...

Get Application`crelate_get_application`

Returns a single Applications record by its unique identifier. Returns a 404 if the record does not exist.

Get Application Info`crelate_get_application_info`

Retrieves attribute information specific to the Applications type. This data changes rarely and Crelate recommends cachi...

Approve Application`crelate_approve_application`

Approved applicants will be moved to the next workflow stage, typically with a meaning of "in progress".

Block Application`crelate_block_application`

When an applicant is blocked, they are no longer visible and any future applications from that applicant will be discard...

Reject Application`crelate_reject_application`

Rejected applicants will be moved to a closed negative workflow stage.

Apply To Job`crelate_apply_to_job`

Submits an application to a Job and returns the created application ID. Depending on settings, applicants either route t...

List Companies`crelate_list_companies`

Records must match all filters provided unless the OR filter operator is specified.\<br /> If no sort\_by is provided, the...

Get Company`crelate_get_company`

Returns a single Companies record by its unique identifier. Returns a 404 if the record does not exist.

Get Company Info`crelate_get_company_info`

Retrieves attribute information specific to the Companies type. This data changes rarely and Crelate recommends caching...

Create Company`crelate_create_company`

Creates a new Companies record and returns its generated ID.

Update Company`crelate_update_company`

Partially updates an existing Companies record. Only fields included in the request body are modified; omitted fields ar...

Delete Company`crelate_delete_company`

Permanently deletes a Company record by its unique identifier.

Change Company Status`crelate_change_company_status`

Available statuses can be retrieved by inspecting the results of the Companies metadata endpoint under the \`EntityStatus...

List Companies By List`crelate_list_companies_by_list`

Returns Companies records that belong to the specified saved list.

Search Companies`crelate_search_companies`

Performs a keyword search against all Company records (name, phone, address, website, or other keyword). Returned data i...

List Contacts`crelate_list_contacts`

Records must match all filters provided unless the OR filter operator is specified. \<br> If no sort\_by is provided, the...

Get Contact`crelate_get_contact`

Returns a single Contacts record by its unique identifier. Returns a 404 if the record does not exist.

Get Contact Info`crelate_get_contact_info`

Retrieves attribute information specific to the Contacts type. This data changes rarely and Crelate recommends caching i...

Create Contact`crelate_create_contact`

Creates a new Contacts record and returns its generated ID.

Update Contact`crelate_update_contact`

Partially updates an existing Contacts record. Only fields included in the request body are modified; omitted fields are...

Delete Contact`crelate_delete_contact`

Permanently deletes a Contact record by its unique identifier.

Change Contact Status`crelate_change_contact_status`

Available statuses can be retrieved by inspecting the results of the Contacts metadata endpoint under the `EntityStatus`...

List Contacts By List`crelate_list_contacts_by_list`

Returns Contacts records that belong to the specified saved list.

Search Contacts`crelate_search_contacts`

Performs a keyword search against all Contact records (name, contact number, phone, address, website, or other keyword)....

List Jobs`crelate_list_jobs`

Returns a paged, filterable list of job records. Supports filtering by stage, company, tags, candidates, and more.

Get Job`crelate_get_job`

Returns a single Jobs record by its unique identifier. Returns a 404 if the record does not exist.

Get Job Info`crelate_get_job_info`

Retrieves attribute information specific to the Jobs type. This data changes rarely and Crelate recommends caching it.

Create Job`crelate_create_job`

Creates a new Jobs record and returns its generated ID.

Update Job`crelate_update_job`

Partially updates an existing Jobs record. Only fields included in the request body are modified; omitted fields are lef...

Delete Job`crelate_delete_job`

Permanently deletes a Job record by its unique identifier.

Add Contact To Job`crelate_add_contact_to_job`

Adds a single contact to the specified job's recruiting pipeline at the given workflow stage.

Add Contacts To Job`crelate_add_contacts_to_job`

Adds one or more contacts to the specified job's recruiting pipeline at the given workflow stage.

Update Job Contact Workflow Status`crelate_update_job_contact_status`

This endpoint does not support handling workflow rules. Consider migrating to the [Workflow Stage](#tag/Workflow-Stages)...

Remove Contact From Job`crelate_remove_contact_from_job`

Removes a contact from the specified job's recruiting pipeline.

Update Job Posting`crelate_update_job_posting`

Updates the public-facing portal posting details for a job, such as title, description, location, and compensation. Only...

Disable Job Posting`crelate_disable_job_posting`

Disables the job's portal posting and removes it from any free job boards it was published to. The job record itself is...

List Jobs By List`crelate_list_jobs_by_list`

Returns Jobs records that belong to the specified saved list.

Search Job Postings`crelate_search_job_postings`

Search Job postings for open Jobs that are not hidden against the Job's title, description, compensation, city, state, z...

Search Jobs`crelate_search_jobs`

Performs a keyword search against all Job records (name, job number, location, website, or other keyword). Returned data...

List Notes`crelate_list_notes`

Returns a paged list of note activities. Filter by parent record, date range, or other criteria.

Get Note`crelate_get_note`

Returns a single note activity by its unique identifier.

Create Note`crelate_create_note`

Creates a new note activity on a parent record. A `ParentId` is required.

Update Note`crelate_update_note`

Partially updates a note activity. Only fields included in the request body are modified.

Delete Note`crelate_delete_note`

Permanently deletes a note activity by its unique identifier.

List Placements`crelate_list_placements`

Records must match all filters provided unless the OR filter operator is specified. \<br> If no sort\_by is provided, the...

Get Placement`crelate_get_placement`

Returns a single Placements record by its unique identifier. Returns a 404 if the record does not exist.

Get Placement Info`crelate_get_placement_info`

Retrieves attribute information specific to the Placements type. This data changes rarely and Crelate recommends caching...

Change Placement Status`crelate_change_placement_status`

Available statuses can be retrieved by inspecting the results of the Placements metadata endpoint under the \`EntityStatu...

List Tasks`crelate_list_tasks`

Returns a paged list of task activities. Filter by parent record, completion state, date range, or other criteria.

Get Task`crelate_get_task`

Returns a single task activity by its unique identifier.

Create Task`crelate_create_task`

Tasks will default to being incomplete (Completed = false) unless a value is provided.

Update Task`crelate_update_task`

Partially updates a task activity. Only fields included in the request body are modified.

Delete Task`crelate_delete_task`

Permanently deletes a task activity by its unique identifier.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.