Home

November 16, 2026

List the Files on a Contact, Organization or Client Group

GET /v3/Contacts/{ContactKey}/Files, GET /v3/Organizations/{OrganizationKey}/Files and GET /v3/ClientGroups/{ClientGroupKey}/Files list a client’s files, ready to download, straight from the client’s key. They’re a convenient alternative to GET /v3/FileList/{EntityType} and provide the same functionality:

GET https://api.karbonhq.com/v3/Contacts/4jgPTtcXxwC2/Files?$filter=IsArchived eq false&$top=100
{
  "@odata.count": 132,
  "@odata.nextLink": "https://api.karbonhq.com/v3/Contacts/4jgPTtcXxwC2/Files?$filter=IsArchived eq false&$top=100&$skip=100",
  "value": [
    {
      "FileContextKey": "9pLwR3nVt6Ks",
      "FileName": "Engagement letter 2026.pdf",
      "FileSize": 184320,
      "MimeType": "application/pdf",
      "DateCreated": "2026-11-09T21:14:05Z",
      "IsArchived": false,
      "IsShared": true,
      "DownloadUrl": "/v3/Files?token=...",
      "FolderPath": null
    },
    ...
  ]
}

Each file comes with its DownloadUrl, so you can download it without looking it up first. Files are returned newest first; follow @odata.nextLink for the next page.

Option Supported
$filter eq on IsArchived, IsShared, Source and MimeType, combined with and
$orderby DateCreated
$top / $skip Up to 500 per page

FolderPath is always null, because only work item files are kept in folders. A private or hidden client that your application can’t see returns a 404.

Refer to the API documentation for more information on listing a client’s files.

User Title on GET /v3/Users/{UserId}

GET /v3/Users/{UserId} now returns the user’s Title, as set on their Karbon profile:

GET https://api.karbonhq.com/v3/Users/7mKdP2xWqR5n
{
  "Id": "7mKdP2xWqR5n",
  "Name": "Jessica Tse",
  "EmailAddress": "jessica.tse@samplecompany.com",
  "Title": "Senior Accountant",
  "BillableRate": 220.0,
  "CapacityMinutesPerWeek": 2400,
  ...
}

Title is an empty string when the user hasn’t set one.

Refer to the API documentation for more information on getting a user.