Get letters for profile

Returns all letters (offer letters, acceptance letters, etc.) that have been generated for a profile. Each letter includes download URLs for both the PDF and DOCX versions, file sizes, and digital signature status.

Path Parameters
  • profile_id
    Type: string
    required

    Unique identifier of the profile.

Responses
  • application/json
  • application/json
  • application/json
Request Example for get/apis/profiles/profiles/{profile_id}/letters
curl https://school.fullfabric.cloud/apis/profiles/profiles/507f1f77bcf86cd799439011/letters \
  --header 'FF-Auth: YOUR_SECRET_TOKEN'
[
  {
    "id": "6977b4c7976a77f54fd8b458",
    "description": "Conditional Offer Letter",
    "profile_id": "6385bdd4976a7719120108e9",
    "require_digital_signature": true,
    "digitally_signed_at": null,
    "created_by_id": "670664ae9a52af0e7abbaddf",
    "created_at": 1769452743000,
    "pdf": {
      "id": "6977b4c7976a77f54fd8b459",
      "path": "files/profiles/profiles/6385bdd4976a7719120108e9/letters/sophie_martin_conditional_offer_letter.pdf",
      "url": "https://files.primrose.fullfabric.cloud/profiles/sophie_martin_conditional_offer_letter.pdf",
      "filename": "sophie_martin_conditional_offer_letter.pdf",
      "size": 71840
    },
    "docx": {
      "id": "6977b4c7976a77f54fd8b45a",
      "path": "files/profiles/profiles/6385bdd4976a7719120108e9/letters/sophie_martin_conditional_offer_letter.docx",
      "url": "https://files.primrose.fullfabric.cloud/profiles/sophie_martin_conditional_offer_letter.docx",
      "filename": "sophie_martin_conditional_offer_letter.docx",
      "size": 306753
    }
  }
]