Skip to content
PalomPalomAtlas

Search

GET
/api/v1/documents
curl --request GET \
  --url https://example.com/api/v1/documents

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
workspace
Any of:
string
state
Any of:
DocumentState
string
Allowed values: NORMAL PROCESSING SUCCESS ERROR
q
Any of:
string
properties
Any of:
string
orphan
Any of:
boolean
stale
Any of:
boolean
cursor
Any of:
string
limit
Any of:
integer
>= 1 <= 200

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
SearchDocumentsResult
object
items
required
Items
Array<object>
DocumentListItem
object
id
required
Id
string format: uuid
bucket
required
Bucket
string
key
required
Key
string
name
required
Name
string
state
required
DocumentState
string
Allowed values: NORMAL PROCESSING SUCCESS ERROR
properties
required
Properties
object
key
additional properties
any
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
orphan
required
Orphan
boolean
stale
required
Stale
boolean
next_cursor
required
Any of:
string
Example
{
  "items": [
    {
      "state": "NORMAL"
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}