Playbook Document Types

Gets all document types for the specified playbook.

get

Retrieves a paginated list of all document types for the specified playbook, with optional search and sorting.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstringRequired

Query parameters

pageNumberinteger · int32Optional

The page number for paginated results.

pageSizeinteger · int32Optional

The number of items per page.

searchTextstringOptional

Optional search text to filter results.

sortinginteger · enumOptional

The sorting option for the results.

Possible values:

descbooleanOptional

Whether to sort in descending order.

Default: true

Responses

200

OK

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

get

/playbooks/{playbookIdentifier}/document-types

HTTPcURLJavaScriptPython

GET /playbooks/{playbookIdentifier}/document-types HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "text",
    "description": "text",
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "dateAdded": "2026-01-27T20:35:22.391Z"
  }
]

Creates a new document type for the specified playbook.

post

Creates a new document type for the specified playbook.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

namestring · nullableRequired

descriptionstring · nullableOptional

Responses

201

Created

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

post

/playbooks/{playbookIdentifier}/document-types

HTTPcURLJavaScriptPython

POST /playbooks/{playbookIdentifier}/document-types HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "name": "text",
  "description": "text"
}

application/jsontext/jsonapplication/*+json

{
  "name": "text",
  "description": "text",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2026-01-27T20:35:22.391Z"
}

Gets a specific document type by its object identifier.

get

Retrieves the details of a document type for the specified playbook using its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The object identifier of the document type.

playbookIdentifierstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

get

/playbooks/{playbookIdentifier}/document-types/{objectIdentifier}

HTTPcURLJavaScriptPython

GET /playbooks/{playbookIdentifier}/document-types/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "text",
  "description": "text",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2026-01-27T20:35:22.391Z"
}

Updates an existing document type for the specified playbook.

put

Updates the details of an existing document type for the specified playbook using its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The object identifier of the document type to update.

playbookIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

namestring · nullableRequired

descriptionstring · nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

put

/playbooks/{playbookIdentifier}/document-types/{objectIdentifier}

HTTPcURLJavaScriptPython

PUT /playbooks/{playbookIdentifier}/document-types/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "name": "text",
  "description": "text"
}

application/jsontext/jsonapplication/*+json

{
  "name": "text",
  "description": "text",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2026-01-27T20:35:22.391Z"
}

Deletes a document type from the specified playbook.

delete

Deletes a document type from the specified playbook using its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The object identifier of the document type to delete.

playbookIdentifierstringRequired

Responses

204

No Content

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

delete

/playbooks/{playbookIdentifier}/document-types/{objectIdentifier}

HTTPcURLJavaScriptPython

DELETE /playbooks/{playbookIdentifier}/document-types/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content