Skip to content
Acriva

ListDocumentTypes

GET
/api/v1/t/{tenant}/document-types
curl --request GET \
  --url 'https://example.com/api/v1/t/example/document-types?includeInactive=false'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
tenant
required
string

Tenant slug

Query Parameters

Section titled “Query Parameters”
includeInactive
boolean

Responses

Section titled “ Responses ”

200

Section titled “200”

OK

Media typeapplication/json
Array<object>
object
id
required
string format: uuid
key
required
string
nameDe
required
string
nameEn
required
string
fields
required
Array<object>
object
key
required
string
type
required
Allowed values: Text Number Date Money Enumeration Reference
required
required
boolean
labelDe
required
string
labelEn
required
string
options
Array<object> | null
object
key
required
string
labelDe
required
string
labelEn
required
string
referenceTarget
One of:
null
isRemoved
boolean
isActive
required
boolean
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
[
  {
    "fields": [
      {
        "type": "Text",
        "referenceTarget": "File",
        "isRemoved": false
      }
    ]
  }
]

403

Section titled “403”

Forbidden

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Section titled “429”

Too Many Requests

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}