Sign in
Files

Get File

Changed on

Read File metadata objects.

get/api/v1/files/{id}

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Response

Successful Response

idstring uuid required

Unique identifier

created_atstring date-time nullable

Creation datetime

updated_atstring date-time nullable

Update datetime

namestring required
external_file_idstring nullable

The ID of the file in the external system

file_sizeinteger nullable

Size of the file in bytes

file_typestring nullable

File type (e.g. pdf, docx, etc.)

project_idstring uuid required

The ID of the project that the file belongs to

last_modified_atstring date-time nullable

The last modified time of the file

resource_infoobject nullable

Resource information for the file

permission_infoobject nullable

Permission information for the file

data_source_idstring uuid nullable

The ID of the data source that the file belongs to

Changes

  • 07b7155e4e0eRevision changes
    • ▲

      the response property became optional for the status

    • ▲

      response property external_file_id list-of-types was widened by adding types null to media type application/json of response 200