PurrOSDocs

Attachments

Uploading, listing, downloading and deleting files.

Files a person can't see answer 404, as if they didn't exist. See Attachments for upload formats, accepted file types and the access rules.

Webhook events: attachment.uploaded, attachment.deleted.

All paths are relative to /api/v1. Key is the scope an integration key needs, People the permission a signed-in person or personal key needs, and Feature the feature switch the endpoint belongs to. See how to read this reference.

  • GET/attachments

    List attachments

    Keyattachments:read
    Peopleattachments.read
  • POST/attachments

    Upload a file

    Keyattachments:write
    Peopleanyone
  • GET/attachments/{id}

    Get an attachment's details

    Keyattachments:read
    Peopleuploader, the employee concerned, or attachments.read
  • DELETE/attachments/{id}

    Delete an attachment

    Keyattachments:write
    Peopleuploader, or attachments.manage
  • GET/attachments/{id}/content

    Download an attachment

    Keyattachments:read
    Peopleuploader, the employee concerned, or attachments.read
  • GET/me/attachments

    Files you uploaded or that concern you

    Keynot allowed
    Peopleself