Digitoo.ai
Digitoo API rev. 2.0.0

Workspaces

Endpoint:https://api.digitoo.ai

Creates a new workspace

POST
https://api.digitoo.ai
/api/v2/workspaces

Creates a new workspace › Request Body

  • namestring · required
  • regionrequired
  • organization_idstring · uuid · required
  • accounting_systemobject · required
  • queue_optionsobject[] · required
  • company_id_numberstring

    A valid company ID number

  • tax_idstring
  • vat_idstring
  • integration_idstring | null · uuid

Creates a new workspace › Responses

  • dataobject · required

Get workspace metadata

GET
https://api.digitoo.ai
/api/v2/workspaces/{workspace_id}

Get workspace metadata › path Parameters

  • workspace_idrequired

    A unique UUID or humanized id identifier

Get workspace metadata › query Parameters

  • includestring[]

    Comma separated list of additional data which can be returned for each workspace

    Enum values:
    access-actions
    documents-to-process-count
    queues
    queue-extraction-evaluation
    inbox
  • excludestring[]

    Comma separated list of data to be excluded

    Enum values:
    annotation-schema

Get workspace metadata › Responses

  • dataobject · required

Remove workspace and its queues and associated documents

DELETE
https://api.digitoo.ai
/api/v2/workspaces/{workspace_id}

Remove workspace and its queues and associated documents › path Parameters

  • workspace_idrequired

    A unique UUID or humanized id identifier

Remove workspace and its queues and associated documents › Responses

No data returned

Patch workspace metadata

PATCH
https://api.digitoo.ai
/api/v2/workspaces/{workspace_id}

Patch workspace metadata › path Parameters

  • workspace_idrequired

    A unique UUID or humanized id identifier

Patch workspace metadata › Request Body

  • namestring | null · minLength: 1

    A name of the workspace

  • register_idstring | null
  • tax_idstring | null
  • vat_idstring | null
  • icon_colorstring | null · pattern: ^#?([0-9A-F]{3}|[0-9…

Patch workspace metadata › Responses

  • dataobject · required

Patch workspace integration connection status

PATCH
https://api.digitoo.ai
/api/v2/workspaces/{workspace_id}/connection-status

Patch workspace integration connection status › path Parameters

  • workspace_idrequired

    A unique UUID or humanized id identifier

Patch workspace integration connection status › Request Body

  • integration_connection_statusrequired

    Connection status of workspace

  • global_errorstring

    Global error of workspace eg. connection issues

  • global_error_descriptionstring | null

    Global error description of workspace eg. connection issues

Patch workspace integration connection status › Responses

  • dataobject · required

Get workspace documents

GET
https://api.digitoo.ai
/api/v2/workspaces/{workspace_id}/documents

Get workspace documents › path Parameters

  • workspace_idrequired

    A unique UUID or humanized id identifier

Get workspace documents › query Parameters

  • sortobject · style: deepObject · explode: true
  • excludestring[]

    Comma separated list of additional data which can be excluded for each document.

    Enum values:
    tax-details
    line-items
  • includestring[]
    Enum values:
    queue-metadata
    workspace-metadata
    locked-by
    lock-status
    approval-data
    document-url
    document-duplicities
    workspace-subject-mismatch
  • formattingstring · enum

    Enum: regular | simplified

    Enum values:
    regular
    simplified
  • pageobject · style: deepObject · explode: true
  • searchstring
  • filtersobject · style: deepObject · explode: true

    Filter documents by fields

Get workspace documents › Responses

  • dataobject[] · required

    array of response data

  • paginationrequired

    pagination

Patch workspace integration credentials

PATCH
https://api.digitoo.ai
/api/v2/workspaces/{workspace_id}/integration-credentials

Patch workspace integration credentials › path Parameters

  • workspace_idrequired

    A unique UUID or humanized id identifier

Patch workspace integration credentials › Request Body

string

Patch workspace integration credentials › Responses

No data returned

Post workspace integration log

POST
https://api.digitoo.ai
/api/v2/workspaces/{workspace_id}/integration-log

Post workspace integration log › path Parameters

  • workspace_idrequired

    A unique UUID or humanized id identifier

Post workspace integration log › Request Body

  • typerequired

    Event type

  • messagestring · required

    Human-readable message for user

  • document_idstring · uuid

    Document ID reference in case an event is directly associated to the document

  • detailsobject

    An object used for storing miscellaneous data related to the event and used for debugging

Post workspace integration log › Responses

No data returned

Get workspace queues user has access to

GET
https://api.digitoo.ai
/api/v2/workspaces/{workspace_id}/queues

Get workspace queues user has access to › path Parameters

  • workspace_idrequired

    A unique UUID or humanized id identifier

Get workspace queues user has access to › query Parameters

  • includestring[]

    Comma separated list of additional data which can be returned for each queue

    Enum values:
    access-actions
    documents-to-process-count
    settings
    documents-count
    features
    workspace-metadata
    extraction-evaluation
    inbox
  • excludestring[]

    Comma separated list of data to be excluded

    Enum values:
    annotation-schema
  • pageobject · style: deepObject · explode: true

Get workspace queues user has access to › Responses

  • dataobject[] · required

    A list of queues

  • paginationobject · required

Creates a new queue in specified workspace

POST
https://api.digitoo.ai
/api/v2/workspaces/{workspace_id}/queues

Creates a new queue in specified workspace › path Parameters

  • workspace_idrequired

    A unique UUID or humanized id identifier

Creates a new queue in specified workspace › Request Body

  • typerequired
  • namestring | null · minLength: 1 · required

    A name of a queue

  • localerequired
  • currencystring · minLength: 1 · required

    Currency assigned to the queue (ISO code)

  • approvalboolean | null

    Whether to use approval flow

    Default: false
  • extractionboolean | null

    Whether to allow extraction of documents

    Default: true

Creates a new queue in specified workspace › Responses

  • dataobject · required

Get workspace service account token for V2

GET
https://api.digitoo.ai
/api/v2/workspaces/{workspace_id}/service-account-token

Get workspace service account token for V2 › path Parameters

  • workspace_idrequired

    A unique UUID or humanized id identifier

Get workspace service account token for V2 › Responses

  • dataobject · required

Create workspace service account token for V2

POST
https://api.digitoo.ai
/api/v2/workspaces/{workspace_id}/service-account-token

Create workspace service account token for V2 › path Parameters

  • workspace_idrequired

    A unique UUID or humanized id identifier

Create workspace service account token for V2 › Responses

  • dataobject · required
OrganizationsQueues