Skip to main content
All CollectionsAuthentication GuidesATS
Ashby - How do I link my account?
Ashby - How do I link my account?

How to link your Ashby account

Updated over 4 months ago

Overview

To authenticate Ashby, you will need to provide an API key. This guide will walk you through finding or creating the API key within Ashby.

Instructions

Step 1: Create a new API key

  1. Sign in to Ashby and click Admin in the top navigation bar

  2. Navigate to Integrations > API Keys

    In Ashby, click on Admin > Integrations > API Keys

  3. Click "+ New" in the upper right corner

    In Ashby, click on + New

  4. Add a name for the new API key, then click "Create API Key"

  5. Grant the following permissions to your API key (Write permissions are only required if you intend to send data to Ashby)

Permission

Required at minimum

Explanation

Jobs: Read

Y

Candidates: Read

Y

Candidates: Write

N

Needed if writing candidates

Interviews: Read

Y

Hiring Process Metadata: Read

Y

Hiring Process Metadata: Write

N

Needed if writing hiring process metadata

Organization: Read

Y

Offers: Read

Y

Permissions required by Ashby

Step 2: Copy and paste the API key into the linking flow

Did this answer your question?