API Reference

project.create

post
https://api.ashbyhq.com/project.create

Creates a project.
The effective actor becomes the author, including authorized on-behalf-of requests.
Confidential projects are available on Plus, Legacy Plus, and Enterprise plans. Authors retain access to projects they create.
Supply initial customFields for every active required Project custom field definition. Hidden, inaccessible, or unsupported required fields prevent creation. Boolean false and Number zero satisfy requiredness. Custom field values require Project custom fields availability; private and API-only field permissions apply.
Author assignment is not supported. Omitted optional custom fields remain unset, and the project starts active with no candidates; use separate candidate endpoints to manage membership.

Requires the projectsWrite permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≥ 1

The project's title.

ProjectDescriptionInput | null

The project's description. Omission, null, or empty content leaves it unset.

customFields
array of objects

Initial values. Supply every required field. Supports String, LongText, Boolean, Number, Date, ValueSelect, MultiValueSelect, Url and User fields. Requires Project custom fields availability. Discover definitions using customField.list with hiringProcessMetadata:read; User discovery retains organization:read.

customFields
boolean

Whether the project is confidential. Defaults to false. Requires confidential project availability.

Response

Updated 21 days ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 21 days ago