Skip to main content
GET
/
api
/
intakes
/
{id}
Get Intake by ID
curl --request GET \
  --url https://platform.kodexa.ai/api/intakes/{id} \
  --header 'x-api-key: <api-key>'
{
  "active": true,
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "id": "<string>",
  "name": "<string>",
  "organization": {
    "authGroupLink": {
      "authGroup": "<string>"
    },
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "defaultToPrivateTemplates": true,
    "description": "<string>",
    "enterpriseOrganization": true,
    "features": {},
    "hasImage": true,
    "id": "<string>",
    "memory": {
      "orderedDashboards": [
        "<string>"
      ]
    },
    "name": "<string>",
    "organizationStatus": "<string>",
    "properties": {},
    "publicAccess": true,
    "searchText": "<string>",
    "slug": "<string>",
    "stripeCustomerId": "<string>",
    "supportAccess": true,
    "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "organizationId": "<string>",
  "slug": "<string>",
  "store": "aSDinaTvuI8gbWludGxpZnk=",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}

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 Intake

An intake configures how documents are ingested from external sources.

active
boolean
changeSequence
integer<int32>
createdOn
string<date-time>
description
string
id
string
name
string
organization
object
organizationId
string | null
slug
string
store
string<byte>
updatedOn
string<date-time>
uuid
string