Get Folder

GET

https://api.coperniq.io/v1/folders/:folder_id

Retrieve a specific doc folder by id.

x-api-keystring

API Key authentication via header

folder_idintegerRequired

Folder identifier

include_archivedbooleanOptionalDefaults to false

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

Successful response

idinteger

Folder identifier

namestring

Folder name

projectIdinteger

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

isActiveboolean

Whether the folder is active (false if archived)

createdAtstringformat: "date-time"

Creation timestamp

updatedAtstringformat: "date-time"

Last update timestamp

companyIdintegerOptional

Owning company identifier

parentIdinteger or nullOptional

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

phaseInstanceIdinteger or nullOptional

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

createdByinteger or nullOptional

User who created the folder

400

Bad Request Error

404

Not Found Error

500

Internal Server Error

1	const url = 'https://api.coperniq.io/v1/folders/1';
2	const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};
3
4	try {
5	const response = await fetch(url, options);
6	const data = await response.json();
7	console.log(data);
8	} catch (error) {
9	console.error(error);
10	}