ListFileDocuments

GET

/api/v1/t/{tenant}/files/{fileId}/documents

curl --request GET \
  --url https://example.com/api/v1/t/example/files/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/documents

Parameters

Path Parameters

tenant

required

string

Tenant slug

fileId

required

string format: uuid

Query Parameters

cursor

string

limit

integer format: int32

Responses

200

OK

Media typeapplication/json

object

items

required

Array<object>

object

documentId

required

string format: uuid

title

required

string

documentTypeId

required

null | string format: uuid

status

required

Allowed values: Processing Active Archived Deleted

filedAt

required

string format: date-time

nextCursor

required

null | string

Example

{
  "items": [
    {
      "status": "Processing"
    }
  ]
}

400

Bad Request

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

errors

object

key

additional properties

Array<string>

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

403

Forbidden

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

429

Too Many Requests

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}