Get Intake by ID

Retrieves a single Intake by its unique identifier. Intakes configure how documents are ingested from external sources.

GET /api/intakes/{id}

Get Intake by ID

cURL

curl --request GET \
  --url https://platform.kodexa.ai/api/intakes/{id} \
  --header 'x-api-key: <api-key>'

200

{
  "active": true,
  "activityPlanId": "<string>",
  "allowMultipleFiles": true,
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "id": "<string>",
  "knowledgeFeatureIds": null,
  "metadata": {},
  "name": "<string>",
  "organization": {
    "authGroupLink": {
      "authGroup": "<string>"
    },
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "defaultToPrivateTemplates": true,
    "description": "Document processing organization for Acme Corp.",
    "enterpriseOrganization": true,
    "features": {},
    "hasImage": true,
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "memory": {
      "orderedDashboards": [
        "<string>"
      ]
    },
    "name": "Acme Corp",
    "organizationStatus": "ACTIVE",
    "properties": {},
    "publicAccess": true,
    "searchText": "<string>",
    "slug": "acme-corp",
    "stripeCustomerId": "<string>",
    "supportAccess": true,
    "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "550e8400e29b41d4a716446655440000",
    "archived": true
  },
  "organizationId": "<string>",
  "script": "<string>",
  "scriptEnabled": true,
  "slug": "<string>",
  "sourceType": "<string>",
  "store": {
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "deleted": true,
    "deprecated": true,
    "eventAware": true,
    "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,
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>",
    "deleteUserEmail": "<string>",
    "deleteUserId": "<string>",
    "deletedDate": "2023-11-07T05:31:56Z",
    "extensionPackRef": "<string>",
    "orgSlug": "<string>",
    "organization": {
      "id": "<string>"
    },
    "ref": "<string>",
    "type": "<string>",
    "uri": "<string>",
    "yamlSource": "<string>"
  },
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "largeUploadEnabled": true,
  "sourceConfig": null,
  "sourceScript": "<string>"
}

Authorizations

x-api-keybearerAuth

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

200

application/json

The Intake

An intake configures how documents are ingested from external sources.

active · boolean · required

activityPlanId · string | null · required

allowMultipleFiles · boolean · required

changeSequence · integer<int32> · required

createdOn · string<date-time> · required

description · string · required

id · string · required

knowledgeFeatureIds · unknown · required

metadata · object | null · required

Show child attributes

name · string · required

organization · object | null · required

An organization is the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.

Show child attributes

organizationId · string | null · required

script · string | null · required

scriptEnabled · boolean · required

slug · string · required

sourceType · string · required

store · object | null · required

Show child attributes

updatedOn · string<date-time> · required

uuid · string · required

largeUploadEnabled · boolean | null

sourceConfig · unknown

sourceScript · string | null