Kantata Kantata OX Knowledge Base
Release Notes
Kantata OX Release Notes API Breaking Changes
Status Page
Kantata OX API Documentation

User File Associations

User File Associations in Kantata OX act as a join object between Users, Workspaces, and Attachments / Google Documents.

Fetching a list of User File Associations

This endpoint returns structured User File Association objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the user_file_associations top-level JSON key. Please see our Response Format section for more information.

Request
query Parameters
filename
string

Only includes file associations with matching filenames.

include
string

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • asset_object (polymorphic) - When included, the polymorphic asset_object_ref struct will reference the attachment or Google document for which the user file association belongs. This will be a a two-key JSON object with "ID" and "key", where the "key" will be "attachments" or "google_documents".
  • post (Post) - The post to which the user file association belongs.
  • workspace (Workspace) - References the project to which the user file association belongs.
only
string

Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like GET /api/v1/workspaces.json?only=5,6,7.

order
string
Default: "created_at:desc"

Supply order with the name of a valid sort field for the endpoint and a direction.

Valid values: created_at:asc and created_at:desc.

page
integer <int32>
Default: 1
per_page
integer <int32> <= 200
Default: 20
workspace_id
integer <int32>

Only includes file associations from the specified project.

Responses
200

A list of User File Associations have been retrieved.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
object
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/user_file_associations
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "user_file_associations": {
    },
  • "posts": {
    },
  • "workspaces": {
    }
}
➔ Next to Project Snapshots