Get Opportunity File | Coperniq API

Retrieve a specific file associated with an opportunity

Note: The /requests path is an alias for /opportunities and will continue to work until users are individually notified and migrated.

x-api-keystring

API Key authentication via header

opportunityIdintegerRequired

Opportunity identifier

fileIdintegerRequired

File identifier

Successful response

idinteger

File identifier

namestring

File name

downloadUrlstring

URL to download the file

typestring

File type

updatedAtstringformat: "date-time"

Last update timestamp

createdAtstringformat: "date-time"

Creation timestamp

metaDataobject

sourcestring

File source (e.g., INTERNAL)

createdByUserobject

isArchivedboolean

Whether the file is archived

400

Bad Request Error

404

Not Found Error

1	const url = 'https://api.coperniq.io/v1/opportunities/1/files/3';
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	}

1	{
2	"id": 3,
3	"name": "proposal.pdf",
4	"downloadUrl": "https://cdn.coperniq.io/files/proposal.pdf",
5	"metaData": {
6	"acl": "private",
7	"size": 102400,
8	"userId": 42,
9	"mimeType": "application/pdf",
10	"extention": "pdf",
11	"originalName": "proposal.pdf",
12	"generatedName": "qrs456tuv789.pdf"
13	}
14	}