Digitoo.ai
Digitoo API rev. 2.0.0

​Organizations

Endpoint:https://api.digitoo.ai

​Get organizations user has access to

GET
https://api.digitoo.ai
/api/v2/organizations

​Get organizations user has access to › query Parameters

  • includestring[]

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

    Enum values:
    access-actions
    approval-metadata
    settings
    first-queue-id
    user-settings
    inbox-queue
  • excludestring[]

    Comma separated list of data to be excluded

    Enum values:
    annotation-schema

​Get organizations user has access to › Responses

    • dataobject[] · required

​Get organization metadata by id or humanized id

GET
https://api.digitoo.ai
/api/v2/organizations/{organization_id}

​Get organization metadata by id or humanized id › path Parameters

  • organization_idrequired

    A unique UUID or humanized id identifier

​Get organization metadata by id or humanized id › query Parameters

  • includestring[]

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

    Enum values:
    access-actions
    approval-metadata
    settings
    first-queue-id
    user-settings
    inbox-queue
  • excludestring[]

    Comma separated list of data to be excluded

    Enum values:
    annotation-schema

​Get organization metadata by id or humanized id › Responses

    • dataobject · required

​Updates organization

PATCH
https://api.digitoo.ai
/api/v2/organizations/{organization_id}

​Updates organization › path Parameters

  • organization_idrequired

    A unique UUID or humanized id identifier

​Updates organization › Request Body

  • namestring
  • vat_idstring | null
  • tax_idstring | null
  • register_idstring | null
  • house_numberstring | null
  • streetstring | null
  • citystring | null
  • countrystring
  • inbox_status | null
  • zipstring

​Updates organization › Responses

    • dataobject · required

​Get documents from organization

GET
https://api.digitoo.ai
/api/v2/organizations/{organization_id}/documents

​Get documents from organization › path Parameters

  • organization_idrequired

    A unique UUID or humanized id identifier

​Get documents from organization › 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
    last-status-change
  • 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 documents from organization › Responses

    • dataobject[] · required

      array of response data

    • paginationrequired

      pagination

​Invite users

POST
https://api.digitoo.ai
/api/v2/organizations/{organization_id}/invite-users

​Invite users › path Parameters

  • organization_idrequired

    A unique UUID or humanized id identifier

​Invite users › Request Body

  • email_with_roles_in_workspace_queuesobject[] · required

​Invite users › Responses

    • datastring[] · required
    • successfully_invited_user_emailsstring[] · required
    • unsuccessfully_invited_user_emailsstring[] · required

​Get queues user has access to within specific organization

GET
https://api.digitoo.ai
/api/v2/organizations/{organization_id}/queues

​Get queues user has access to within specific organization › path Parameters

  • organization_idrequired

    A unique UUID or humanized id identifier

​Get queues user has access to within specific organization › 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 queues user has access to within specific organization › Responses

    • dataobject[] · required

      A list of queues

    • paginationobject · required

​Change organization's workspaces sort order for future requests

PATCH
https://api.digitoo.ai
/api/v2/organizations/{organization_id}/workspace-ordering

​Change organization's workspaces sort order for future requests › path Parameters

  • organization_idrequired

    A unique UUID or humanized id identifier

​Change organization's workspaces sort order for future requests › Request Body

  • fieldrequired
  • dirrequired

​Change organization's workspaces sort order for future requests › Responses

    No schema specified

​Get workspaces user has access to within specific organization

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

​Get workspaces user has access to within specific organization › path Parameters

  • organization_idrequired

    A unique UUID or humanized id identifier

​Get workspaces user has access to within specific organization › 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
  • pageobject · style: deepObject · explode: true

​Get workspaces user has access to within specific organization › Responses

    • dataobject[] · required

      array of response data

    • paginationrequired

      pagination

AuthorizationWorkspaces