BIbigchange
Attachments

Get an attachment

Changed on

Retrieves a single attachment, including its download URL (required scope attachments:read)

get/v1/attachments/{attachmentId}

Request

  • Base URL
    https://api.bigchange.com
  • URL
    https://api.bigchange.com/v1/attachments/{attachmentId}
  • Auth
    HTTP bearer

Path parameters

attachmentIdinteger required
Example:123456

The unique identifier of the attachment

Headers

Customer-Idinteger required

The customer identifier

Response

OK

OR

Example response

{
  "id": 123456,
  "fileName": "invoice.pdf",
  "fileDescription": "Signed contract",
  "fileType": "application/pdf",
  "fileExtension": "pdf",
  "isNew": true,
  "isImage": true,
  "createdAt": "2024-01-15T09:30:00.0000000+00:00",
  "entityType": "job",
  "isResourceVisible": true
}

Changes

  • 6d14f46623c8Revision changes
    • breaking

      added to the response body oneOf list for the response status

    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      removed from the response body allOf list for the response status

  • 45b05fe73cc9Revision changes
    • info

      endpoint added