Skip to main content

​
create

create(request: CreateProjectRequest): Promise<CreateProjectResponse>
Create a project Create a project in a workspace. The parent workspace is identified by the workspace_id path parameter alone; the x-hh-workspace-id header does not participate. The optional project_creator field names the user (by email) who receives the project-creator membership on the new project. The named user must already be a member of the workspace. When omitted, the project is created without any membership. The field is only accepted on API-key-initiated requests — user-initiated creation always makes the calling user the creator and rejects the field with a 400.

​
delete

delete(request: DeleteProjectRequest): Promise<DeleteProjectResponse>
Delete a project Delete a project. The project is soft-deleted (archived) and no longer appears in reads; the response returns the archived project. The project is identified by the project_id path parameter alone; the x-hh-project-id header does not participate.

​
get

get(request: GetProjectRequest): Promise<GetProjectResponse>
Get a project Retrieve a single project by id. The project is identified by the project_id path parameter alone; the x-hh-project-id header does not participate.

​
update

update(request: UpdateProjectRequest): Promise<UpdateProjectResponse>
Update a project Update a project’s display name and/or description. The project is identified by the project_id path parameter alone; the x-hh-project-id header does not participate. Only fields included in the request body are modified.