API ReferenceAssets

Create Project

Beta

Create a new project with custom metadata. Projects can be typed (e.g., ‘candidate’, ‘user’, ‘company’) and include flexible custom metadata for storing additional information.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
titlestringRequired
The project title
custom_metadatamap from strings to any or nullOptional
A flexible dictionary for storing custom metadata
descriptionstring or nullOptional
Optional project description
parent_folder_idstring or nullOptional
Optional parent folder ID
project_typestring or nullOptional

User-defined project type (e.g., ‘candidate’, ‘user’, ‘company’)

share_with_emailslist of strings or nullOptional

Optional list of email addresses to share the project with (VIEW permission)

tagslist of strings or nullOptional
Optional list of tags for categorizing the project

Response

Project created successfully
asset_idstring
ID of the created project asset
titlestring
Title of the created project
custom_metadatamap from strings to any or null
Custom metadata associated with the project
descriptionstring or null
Description of the project
project_typestring or null
Type of the project
tagslist of strings or null
Tags associated with the project

Errors