Documents

Retrieve document metadata and base64-encoded content

Returns document metadata and base64-encoded original file bytes in a data object. Use attachment IDs from request history. Access requires permission to the parent request or predefined response. Documents without either parent return 403. history_id and response_id are nullable integer references; unset metadata is null. content_base64 is an empty string for an empty file. Decode it as binary, not UTF-8 text. Storage paths and internal flags are not returned. XML uses <response><data>…</data></response>; null and empty strings use empty elements.

get/documents/{document}

Request

  • Base URL: https://helpspot.example.com/api/v2
  • URL: https://helpspot.example.com/api/v2/documents/{document}
  • Auth: one of:
    • HTTP bearer
    • HTTP basic

Path parameters

documentinteger required

Response

Document metadata and base64-encoded content.

Example response

{
  "data": {
    "id": 42,
    "history_id": 123,
    "response_id": null,
    "filename": "hello.txt",
    "mime_type": "text/plain",
    "content_id": null,
    "content_base64": "SGVsbG8K"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.