Playbook Document Types
Retrieves a paginated list of all document types for the specified playbook, with optional search and sorting.
Bearer authentication with JWT
The page number for paginated results.
The number of items per page.
Optional search text to filter results.
The sorting option for the results.
Whether to sort in descending order.
trueOK
Forbidden
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": "2025-12-06T04:14:37.886Z"
}
]Creates a new document type for the specified playbook.
Bearer authentication with JWT
Created
Bad Request
Forbidden
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"
}{
"name": "text",
"description": "text",
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"dateAdded": "2025-12-06T04:14:37.886Z"
}Retrieves the details of a document type for the specified playbook using its object identifier.
Bearer authentication with JWT
The object identifier of the document type.
OK
Forbidden
Not Found
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": "2025-12-06T04:14:37.886Z"
}Updates the details of an existing document type for the specified playbook using its object identifier.
Bearer authentication with JWT
The object identifier of the document type to update.
OK
Bad Request
Forbidden
Not Found
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"
}{
"name": "text",
"description": "text",
"objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"dateAdded": "2025-12-06T04:14:37.886Z"
}Deletes a document type from the specified playbook using its object identifier.
Bearer authentication with JWT
The object identifier of the document type to delete.
No Content
Forbidden
Not Found
DELETE /playbooks/{playbookIdentifier}/document-types/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Last updated