Get Opportunity Files | Coperniq

curl https://api.coperniq.io/v1/opportunities/opportunityId/files \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json"

[
  {
    "id": 1024,
    "name": "Project_Specifications.pdf",
    "downloadUrl": "https://cdn.coperniq.io/files/1024/download",
    "type": "application/pdf",
    "updatedAt": "2024-04-20T14:45:00Z",
    "createdAt": "2024-04-18T10:15:00Z",
    "metaData": {
      "acl": "private",
      "size": 254000,
      "userId": 57,
      "mimeType": "application/pdf",
      "extention": "pdf",
      "originalName": "Project_Specifications_Initial.pdf",
      "generatedName": "proj_spec_1024_20240418.pdf",
      "gps": {
        "latitude": 40.712776,
        "longitude": -74.005974
      },
      "thumbnailUrl": "https://cdn.coperniq.io/files/1024/thumbnail.jpg",
      "thumbnailName": "proj_spec_1024_thumb.jpg",
      "requestFileName": "Project_Specifications.pdf"
    },
    "source": "INTERNAL",
    "createdByUser": {
      "id": 57,
      "firstName": "Alice",
      "lastName": "Johnson"
    },
    "isArchived": false
  }
]

Retrieve all files 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.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

opportunityIdstringRequired

Opportunity identifier

Response

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 or null

Whether the file is archived

Authentication

Path parameters

Response

Errors