folders

Get Folder

Retrieve a specific doc folder by id.

get/folders/{folder_id}

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/folders/{folder_id}
  • Auth: API key in header x-api-key

Path parameters

folder_idinteger required

Folder identifier

Query parameters

include_archivedboolean

Whether to include archived (inactive) records in the response. By default only active records are returned.

Response

Successful response

idinteger required

Folder identifier

namestring required

Folder name

companyIdinteger

Owning company identifier

projectIdinteger required

Project (or opportunity/account, under the hood) this folder belongs to

parentIdinteger nullable

Parent folder id, if this folder is nested under another folder. Mutually exclusive with phaseInstanceId. Folders nest at most 2 levels deep.

phaseInstanceIdinteger nullable

Phase instance id, if this folder sits at the root of a phase. Mutually exclusive with parentId.

isActiveboolean required

Whether the folder is active (false if archived)

createdByinteger nullable

User who created the folder

createdAtstring date-time required

Creation timestamp

updatedAtstring date-time required

Last update timestamp

Changes

No recorded changes to this operation across all 1 revision of this API.