Ashby full reference

This connector is optimized for AI agents. For the data replication connector, see Ashby.

This is the full reference documentation for the Ashby agent connector.

Supported entities and actions

The Ashby connector supports the following entities and actions.

Entity	Actions
Candidates	List, Get, Context Store Search
Applications	List, Get, Context Store Search
Jobs	List, Get, Context Store Search
Departments	List, Get
Locations	List, Get
Users	List, Get, Context Store Search
Job Postings	List, Get, Context Store Search
Sources	List
Archive Reasons	List
Candidate Tags	List
Custom Fields	List
Feedback Form Definitions	List

Candidates

Candidates List

Lists all candidates in the organization

Python SDK

await ashby.candidates.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "candidates",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
`cursor`	`string`	No	Pagination cursor for next page
`limit`	`integer`	No	Maximum number of records to return per page

Response Schema

Records

Field Name	Type	Description
`id`	`string`
`createdAt`	`string \| null`
`updatedAt`	`string \| null`
`name`	`string \| null`
`emailAddresses`	`array \| null`
`phoneNumbers`	`array \| null`
`socialLinks`	`array \| null`
`tags`	`array \| null`
`applicationIds`	`array \| null`
`fileHandles`	`array \| null`
`customFields`	`array \| null`
`profileUrl`	`string \| null`
`source`	`object \| any`
`creditedToUser`	`object \| any`
`timezone`	`string \| null`

Meta

Field Name	Type	Description
`cursor`	`string \| null`
`has_more`	`boolean`

Candidates Get

Get a single candidate by ID

Python SDK

await ashby.candidates.get(
    id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "candidates",
    "action": "get",
    "params": {
        "id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`id`	`string`	Yes	Candidate ID

Candidates Context Store Search

Search and filter candidates records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK

await ashby.candidates.context_store_search(
    query={"filter": {"eq": {"id": "<str>"}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "candidates",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": "<str>"}}}
    }
}'

Parameters

Parameter Name	Type	Required	Description
`query`	`object`	Yes	Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
`query.filter`	`object`	No	Filter conditions
`query.sort`	`array`	No	Sort conditions
`limit`	`integer`	No	Maximum results to return (default 1000)
`cursor`	`string`	No	Pagination cursor from previous response's `meta.cursor`
`fields`	`array`	No	Field paths to include in results

Searchable Fields

Field Name	Type	Description
`id`	`string`	Unique identifier for the candidate
`name`	`string`	Full name of the candidate
`company`	`string`	Candidate's current company
`position`	`string`	Candidate's current position or title
`school`	`string`	School associated with the candidate's education

Response Schema

Field Name	Type	Description
`data`	`array`	List of matching records
`meta`	`object`	Pagination metadata
`meta.has_more`	`boolean`	Whether additional pages are available
`meta.cursor`	`string \| null`	Cursor for next page of results
`meta.took_ms`	`number \| null`	Query execution time in milliseconds
`data[].id`	`string`	Unique identifier for the candidate
`data[].name`	`string`	Full name of the candidate
`data[].company`	`string`	Candidate's current company
`data[].position`	`string`	Candidate's current position or title
`data[].school`	`string`	School associated with the candidate's education

Applications

Applications List

Gets all applications in the organization

Python SDK

await ashby.applications.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "applications",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
`cursor`	`string`	No	Pagination cursor for next page
`limit`	`integer`	No	Maximum number of records to return per page

Response Schema

Records

Field Name	Type	Description
`id`	`string`
`createdAt`	`string \| null`
`updatedAt`	`string \| null`
`archivedAt`	`string \| null`
`candidate`	`object \| any`
`status`	`string \| null`
`customFields`	`array \| null`
`currentInterviewStage`	`object \| any`
`source`	`object \| any`
`creditedToUser`	`object \| any`
`archiveReason`	`object \| any`
`job`	`object \| any`
`hiringTeam`	`array \| null`
`appliedViaJobPostingId`	`string \| null`
`submitterClientIp`	`string \| null`
`submitterUserAgent`	`string \| null`

Meta

Field Name	Type	Description
`cursor`	`string \| null`
`has_more`	`boolean`

Applications Get

Get a single application by ID

Python SDK

await ashby.applications.get(
    application_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "applications",
    "action": "get",
    "params": {
        "applicationId": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`applicationId`	`string`	Yes	Application ID

Applications Context Store Search

Search and filter applications records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK

await ashby.applications.context_store_search(
    query={"filter": {"eq": {"id": "<str>"}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "applications",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": "<str>"}}}
    }
}'

Parameters

Parameter Name	Type	Required	Description
`query`	`object`	Yes	Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
`query.filter`	`object`	No	Filter conditions
`query.sort`	`array`	No	Sort conditions
`limit`	`integer`	No	Maximum results to return (default 1000)
`cursor`	`string`	No	Pagination cursor from previous response's `meta.cursor`
`fields`	`array`	No	Field paths to include in results

Searchable Fields

Field Name	Type	Description
`id`	`string`	Unique identifier for the application
`status`	`string`	Current application status (e.g. active, archived, hired)
`archiveReason`	`string`	Reason the application was archived, if applicable
`createdAt`	`string`	Timestamp when the application was created, in ISO 8601 format
`updatedAt`	`string`	Timestamp when the application was last updated, in ISO 8601 format

Response Schema

Field Name	Type	Description
`data`	`array`	List of matching records
`meta`	`object`	Pagination metadata
`meta.has_more`	`boolean`	Whether additional pages are available
`meta.cursor`	`string \| null`	Cursor for next page of results
`meta.took_ms`	`number \| null`	Query execution time in milliseconds
`data[].id`	`string`	Unique identifier for the application
`data[].status`	`string`	Current application status (e.g. active, archived, hired)
`data[].archiveReason`	`string`	Reason the application was archived, if applicable
`data[].createdAt`	`string`	Timestamp when the application was created, in ISO 8601 format
`data[].updatedAt`	`string`	Timestamp when the application was last updated, in ISO 8601 format

Jobs

Jobs List

List all open, closed, and archived jobs

Python SDK

await ashby.jobs.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "jobs",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
`cursor`	`string`	No	Pagination cursor for next page
`limit`	`integer`	No	Maximum number of records to return per page

Response Schema

Records

Field Name	Type	Description
`id`	`string`
`title`	`string \| null`
`confidential`	`boolean \| null`
`status`	`string \| null`
`employmentType`	`string \| null`
`locationId`	`string \| null`
`departmentId`	`string \| null`
`defaultInterviewPlanId`	`string \| null`
`interviewPlanIds`	`array \| null`
`jobPostingIds`	`array \| null`
`customFields`	`array \| null`
`hiringTeam`	`array \| null`
`customRequisitionId`	`string \| null`
`brandId`	`string \| null`
`author`	`object \| any`
`createdAt`	`string \| null`
`updatedAt`	`string \| null`
`openedAt`	`string \| null`
`closedAt`	`string \| null`

Meta

Field Name	Type	Description
`cursor`	`string \| null`
`has_more`	`boolean`

Jobs Get

Get a single job by ID

Python SDK

await ashby.jobs.get(
    id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "jobs",
    "action": "get",
    "params": {
        "id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`id`	`string`	Yes	Job ID

Jobs Context Store Search

Search and filter jobs records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK

await ashby.jobs.context_store_search(
    query={"filter": {"eq": {"id": "<str>"}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "jobs",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": "<str>"}}}
    }
}'

Parameters

Parameter Name	Type	Required	Description
`query`	`object`	Yes	Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
`query.filter`	`object`	No	Filter conditions
`query.sort`	`array`	No	Sort conditions
`limit`	`integer`	No	Maximum results to return (default 1000)
`cursor`	`string`	No	Pagination cursor from previous response's `meta.cursor`
`fields`	`array`	No	Field paths to include in results

Searchable Fields

Field Name	Type	Description
`id`	`string`	Unique identifier for the job
`title`	`string`	Title of the job
`status`	`string`	Current status of the job (e.g. open, closed, draft)
`departmentId`	`string`	Identifier of the department the job belongs to
`locationId`	`string`	Identifier of the primary location of the job

Response Schema

Field Name	Type	Description
`data`	`array`	List of matching records
`meta`	`object`	Pagination metadata
`meta.has_more`	`boolean`	Whether additional pages are available
`meta.cursor`	`string \| null`	Cursor for next page of results
`meta.took_ms`	`number \| null`	Query execution time in milliseconds
`data[].id`	`string`	Unique identifier for the job
`data[].title`	`string`	Title of the job
`data[].status`	`string`	Current status of the job (e.g. open, closed, draft)
`data[].departmentId`	`string`	Identifier of the department the job belongs to
`data[].locationId`	`string`	Identifier of the primary location of the job

Departments

Departments List

List all departments

Python SDK

await ashby.departments.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "departments",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
`cursor`	`string`	No	Pagination cursor for next page
`limit`	`integer`	No	Maximum number of records to return per page

Response Schema

Records

Field Name	Type	Description
`id`	`string`
`name`	`string \| null`
`externalName`	`string \| null`
`isArchived`	`boolean \| null`
`parentId`	`string \| null`
`createdAt`	`string \| null`
`updatedAt`	`string \| null`
`extraData`	`object \| any`

Meta

Field Name	Type	Description
`cursor`	`string \| null`
`has_more`	`boolean`

Departments Get

Get a single department by ID

Python SDK

await ashby.departments.get(
    department_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "departments",
    "action": "get",
    "params": {
        "departmentId": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`departmentId`	`string`	Yes	Department ID

Locations

Locations List

List all locations

Python SDK

await ashby.locations.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "locations",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
`cursor`	`string`	No	Pagination cursor for next page
`limit`	`integer`	No	Maximum number of records to return per page

Response Schema

Records

Field Name	Type	Description
`id`	`string`
`name`	`string \| null`
`externalName`	`string \| null`
`isArchived`	`boolean \| null`
`address`	`object \| any`
`isRemote`	`boolean \| null`
`workplaceType`	`string \| null`
`parentLocationId`	`string \| null`
`type`	`string \| null`
`extraData`	`object \| any`

Meta

Field Name	Type	Description
`cursor`	`string \| null`
`has_more`	`boolean`

Locations Get

Get a single location by ID

Python SDK

await ashby.locations.get(
    location_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "locations",
    "action": "get",
    "params": {
        "locationId": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`locationId`	`string`	Yes	Location ID

Users

Users List

List all users in the organization

Python SDK

await ashby.users.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "users",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
`cursor`	`string`	No	Pagination cursor for next page
`limit`	`integer`	No	Maximum number of records to return per page

Response Schema

Records

Field Name	Type	Description
`id`	`string`
`firstName`	`string \| null`
`lastName`	`string \| null`
`email`	`string \| null`
`globalRole`	`string \| null`
`isEnabled`	`boolean \| null`
`updatedAt`	`string \| null`

Meta

Field Name	Type	Description
`cursor`	`string \| null`
`has_more`	`boolean`

Users Get

Get a single user by ID

Python SDK

await ashby.users.get(
    user_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "users",
    "action": "get",
    "params": {
        "userId": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`userId`	`string`	Yes	User ID

Users Context Store Search

Search and filter users records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK

await ashby.users.context_store_search(
    query={"filter": {"eq": {"id": "<str>"}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "users",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": "<str>"}}}
    }
}'

Parameters

Parameter Name	Type	Required	Description
`query`	`object`	Yes	Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
`query.filter`	`object`	No	Filter conditions
`query.sort`	`array`	No	Sort conditions
`limit`	`integer`	No	Maximum results to return (default 1000)
`cursor`	`string`	No	Pagination cursor from previous response's `meta.cursor`
`fields`	`array`	No	Field paths to include in results

Searchable Fields

Field Name	Type	Description
`id`	`string`	Unique identifier for the user
`firstName`	`string`	First name of the user
`lastName`	`string`	Last name of the user
`email`	`string`	Primary email address of the user

Response Schema

Field Name	Type	Description
`data`	`array`	List of matching records
`meta`	`object`	Pagination metadata
`meta.has_more`	`boolean`	Whether additional pages are available
`meta.cursor`	`string \| null`	Cursor for next page of results
`meta.took_ms`	`number \| null`	Query execution time in milliseconds
`data[].id`	`string`	Unique identifier for the user
`data[].firstName`	`string`	First name of the user
`data[].lastName`	`string`	Last name of the user
`data[].email`	`string`	Primary email address of the user

Job Postings

Job Postings List

List all job postings

Python SDK

await ashby.job_postings.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "job_postings",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
`cursor`	`string`	No	Pagination cursor for next page
`limit`	`integer`	No	Maximum number of records to return per page

Response Schema

Records

Field Name	Type	Description
`id`	`string`
`title`	`string \| null`
`jobId`	`string \| null`
`departmentName`	`string \| null`
`teamName`	`string \| null`
`locationName`	`string \| null`
`locationExternalName`	`string \| null`
`workplaceType`	`string \| null`
`employmentType`	`string \| null`
`isListed`	`boolean \| null`
`publishedDate`	`string \| null`
`applicationDeadline`	`string \| null`
`externalLink`	`string \| null`
`applyLink`	`string \| null`
`locationIds`	`object \| any`
`compensationTierSummary`	`string \| null`
`shouldDisplayCompensationOnJobBoard`	`boolean \| null`
`updatedAt`	`string \| null`

Meta

Field Name	Type	Description
`cursor`	`string \| null`
`has_more`	`boolean`

Job Postings Get

Get a single job posting by ID

Python SDK

await ashby.job_postings.get(
    job_posting_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "job_postings",
    "action": "get",
    "params": {
        "jobPostingId": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`jobPostingId`	`string`	Yes	Job posting ID

Job Postings Context Store Search

Search and filter job postings records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK

await ashby.job_postings.context_store_search(
    query={"filter": {"eq": {"id": "<str>"}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "job_postings",
    "action": "context_store_search",
    "params": {
        "query": {"filter": {"eq": {"id": "<str>"}}}
    }
}'

Parameters

Parameter Name	Type	Required	Description
`query`	`object`	Yes	Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
`query.filter`	`object`	No	Filter conditions
`query.sort`	`array`	No	Sort conditions
`limit`	`integer`	No	Maximum results to return (default 1000)
`cursor`	`string`	No	Pagination cursor from previous response's `meta.cursor`
`fields`	`array`	No	Field paths to include in results

Searchable Fields

Field Name	Type	Description
`id`	`string`	Unique identifier for the job posting
`title`	`string`	Title of the job posting
`isListed`	`boolean`	Whether the job posting is currently published/listed
`jobId`	`string`	Identifier of the job this posting belongs to
`locationName`	`string`	Name of the location associated with the posting

Response Schema

Field Name	Type	Description
`data`	`array`	List of matching records
`meta`	`object`	Pagination metadata
`meta.has_more`	`boolean`	Whether additional pages are available
`meta.cursor`	`string \| null`	Cursor for next page of results
`meta.took_ms`	`number \| null`	Query execution time in milliseconds
`data[].id`	`string`	Unique identifier for the job posting
`data[].title`	`string`	Title of the job posting
`data[].isListed`	`boolean`	Whether the job posting is currently published/listed
`data[].jobId`	`string`	Identifier of the job this posting belongs to
`data[].locationName`	`string`	Name of the location associated with the posting

Sources

Sources List

List all candidate sources

Python SDK

await ashby.sources.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "sources",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
`cursor`	`string`	No	Pagination cursor for next page
`limit`	`integer`	No	Maximum number of records to return per page

Response Schema

Records

Field Name	Type	Description
`id`	`string`
`title`	`string \| null`
`isArchived`	`boolean \| null`
`sourceType`	`object \| any`

Meta

Field Name	Type	Description
`cursor`	`string \| null`
`has_more`	`boolean`

Archive Reasons

Archive Reasons List

List all archive reasons

Python SDK

await ashby.archive_reasons.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "archive_reasons",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
`cursor`	`string`	No	Pagination cursor for next page
`limit`	`integer`	No	Maximum number of records to return per page

Response Schema

Records

Field Name	Type	Description
`id`	`string`
`text`	`string \| null`
`reasonType`	`string \| null`
`isArchived`	`boolean \| null`

Meta

Field Name	Type	Description
`cursor`	`string \| null`
`has_more`	`boolean`

Candidate Tags

Candidate Tags List

List all candidate tags

Python SDK

await ashby.candidate_tags.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "candidate_tags",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
`cursor`	`string`	No	Pagination cursor for next page
`limit`	`integer`	No	Maximum number of records to return per page

Response Schema

Records

Field Name	Type	Description
`id`	`string`
`title`	`string \| null`
`isArchived`	`boolean \| null`

Meta

Field Name	Type	Description
`cursor`	`string \| null`
`has_more`	`boolean`

Custom Fields

Custom Fields List

List all custom fields

Python SDK

await ashby.custom_fields.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "custom_fields",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
`cursor`	`string`	No	Pagination cursor for next page
`limit`	`integer`	No	Maximum number of records to return per page

Response Schema

Records

Field Name	Type	Description
`id`	`string`
`title`	`string \| null`
`objectType`	`string \| null`
`isArchived`	`boolean \| null`
`isPrivate`	`boolean \| null`
`fieldType`	`string \| null`

Meta

Field Name	Type	Description
`cursor`	`string \| null`
`has_more`	`boolean`

Feedback Form Definitions

Feedback Form Definitions List

List all feedback form definitions

Python SDK

await ashby.feedback_form_definitions.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "feedback_form_definitions",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
`cursor`	`string`	No	Pagination cursor for next page
`limit`	`integer`	No	Maximum number of records to return per page

Response Schema

Records

Field Name	Type	Description
`id`	`string`
`organizationId`	`string \| null`
`title`	`string \| null`
`isArchived`	`boolean \| null`
`isDefaultForm`	`boolean \| null`
`formDefinition`	`object \| any`
`interviewId`	`string \| null`

Meta

Field Name	Type	Description
`cursor`	`string \| null`
`has_more`	`boolean`

Supported entities and actions​

Candidates​

Candidates List​

Python SDK​

API​

Parameters​

Records​

Meta​

Candidates Get​

Python SDK​

API​

Parameters​

Candidates Context Store Search​

Python SDK​

API​

Parameters​

Searchable Fields​

Applications​

Applications List​

Python SDK​

API​

Parameters​

Records​

Meta​

Applications Get​

Python SDK​

API​

Parameters​

Applications Context Store Search​

Python SDK​

API​

Parameters​

Searchable Fields​

Jobs​

Jobs List​

Python SDK​

API​

Parameters​

Records​

Meta​

Jobs Get​

Python SDK​

API​

Parameters​

Jobs Context Store Search​

Python SDK​

API​

Parameters​

Searchable Fields​

Departments​

Departments List​

Python SDK​

API​

Parameters​

Records​

Meta​

Departments Get​

Python SDK​

API​

Parameters​

Locations​

Locations List​

Python SDK​

API​

Parameters​

Records​

Meta​

Locations Get​

Python SDK​

API​

Parameters​

Users​

Users List​

Python SDK​

API​

Parameters​

Records​

Meta​

Users Get​

Python SDK​

Supported entities and actions

Candidates

Candidates List

Python SDK

API

Parameters

Records

Meta

Candidates Get

Python SDK

API

Parameters

Candidates Context Store Search

Python SDK

API

Parameters

Searchable Fields

Applications

Applications List

Python SDK

API

Parameters

Records

Meta

Applications Get

Python SDK

API

Parameters

Applications Context Store Search

Python SDK

API

Parameters

Searchable Fields

Jobs

Jobs List

Python SDK

API

Parameters

Records

Meta

Jobs Get

Python SDK

API

Parameters

Jobs Context Store Search

Python SDK

API

Parameters

Searchable Fields

Departments

Departments List

Python SDK

API

Parameters

Records

Meta

Departments Get

Python SDK

API

Parameters

Locations

Locations List

Python SDK

API

Parameters

Records

Meta

Locations Get

Python SDK

API

Parameters

Users

Users List

Python SDK

API

Parameters

Records

Meta

Users Get

Python SDK