Skip to main content
GET
/
api
/
document-stores
/
{id}
Get DocumentStores by ID
curl --request GET \
  --url https://platform.kodexa.ai/api/document-stores/{id} \
  --header 'x-api-key: <api-key>'
{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "deleteUserEmail": "<string>",
  "deleteUserId": "<string>",
  "deleted": true,
  "deletedDate": "2023-11-07T05:31:56Z",
  "deprecated": true,
  "eventAware": true,
  "extensionPackRef": "<string>",
  "id": "<string>",
  "metadata": {
    "deleteProtection": true,
    "metadata": {
      "documentProperties": "<unknown>",
      "indexed": true,
      "labelExpressions": "<unknown>",
      "type": "<string>"
    },
    "storePurpose": "<string>",
    "storeType": "<string>"
  },
  "name": "<string>",
  "organizationId": "<string>",
  "publicAccess": true,
  "slug": "<string>",
  "supportsScheduling": true,
  "template": true,
  "type": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "yamlSource": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://developer.kodexa.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

​
id
string<uuid>
required

Unique identifier (UUID) of the resource.

Response

The DocumentStores

​
changeSequence
integer<int32>
​
createdOn
string<date-time>
​
deleteUserEmail
string | null
​
deleteUserId
string | null
​
deleted
boolean
​
deletedDate
string<date-time> | null
​
deprecated
boolean
​
eventAware
boolean | null
​
extensionPackRef
string
​
id
string
​
metadata
object
​
name
string
​
organizationId
string
​
publicAccess
boolean
​
slug
string
​
supportsScheduling
boolean | null
​
template
boolean
​
type
string
​
updatedOn
string<date-time>
​
uuid
string
​
yamlSource
string | null