Clarify API
Record Attachments

Get an attachment download URL

Returns a short-lived signed URL for downloading the attachment contents.

GET
/workspaces/{workspace}/objects/{object}/records/{id}/attachments/{attachmentId}

Authorization

apiKey
Authorization<token>

API key authentication. Send your key in the Authorization header as: api-key <your-api-key>.

In: header

Path Parameters

workspace*string

The workspace slug — the {slug} segment of your Clarify workspace URL.

object*string

The object type: a built-in entity (person, company, deal, …) or a custom object (c_*).

id*string

The unique ID of the record.

attachmentId*string

The unique ID of the attachment.

Response Body

application/json

curl -X GET "https://example.com/workspaces/string/objects/string/records/string/attachments/string"
{
  "data": {
    "url": "https://storage.clarify.ai/attachments/acme/person/3b9f5c7d-6e2a-4f8b-9d1c-0a7e5b3f9d24/proposal.pdf?signature=..."
  }
}

Delete a record attachment

Removes an attachment from the record and returns the updated record. This cannot be undone.

Request an attachment upload URL

Returns a pre-signed URL for uploading a file. Upload the file contents to `signedUrl` via HTTP PUT, then attach it to the record by POSTing the returned `key` and `attachmentId` to the attachments endpoint.