New Introducing the Light partner portalPartner portal Join the movement

API/Reference/Attachments

List attachments

GET 
https://api.light.inc/v1/attachments

Returns the attachments of a specific resource with the given status. Without status, only active attachments are returned; pass status=ARCHIVED for archived ones, or both values for all. Attachments and their files are kept indefinitely: a replaced file stays listed as a separate, archived attachment next to the one that replaced it.

Authorization

Send one of these on every request. See Authentication for how to get credentials.

  • API key

    Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.

  • Bearer token

Query parameters

  • resourceId string · uuid

  • status array

    Statuses to return, repeatable. Defaults to ACTIVE.

Response

  • id string · uuid

  • companyId string · uuid

  • resourceId string · uuid

  • documentKey string

  • fileName string

  • contentType string

  • createdBy string · uuid

  • metadata object

    • type string

      ⚠️ This enum is not exhaustive; new values may be added in the future.

      One of AR

  • createdAt string · date-time

  • updatedAt string · date-time

  • status string

    ARCHIVED once the attachment was archived. Who archived it and when is on the record's activity log.

    ⚠️ This enum is not exhaustive; new values may be added in the future.

    One of ACTIVE ARCHIVED