ACL

Gets all team members (ACL entries) for the specified playbook.

get

Retrieves a paginated list of all ACL entries (team members) for the specified playbook, with optional search and sorting.

Authorizations
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

get
/playbooks/{playbookIdentifier}/team
GET /playbooks/{playbookIdentifier}/team HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "items": [
    {
      "resourceOwner": "text",
      "isAdmin": true,
      "dateAdded": "2025-12-06T04:16:05.373Z",
      "email": "text",
      "objectIdentifier": "text",
      "name": "text"
    }
  ],
  "totalCount": 1
}

Adds a new team member (ACL entry) to the playbook.

post

Creates a new ACL entry (team member) for the specified playbook.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
playbookIdentifierstringRequired
Body
resourceOwnerstring | nullableRequired
isAdminbooleanRequired
Responses
post
/playbooks/{playbookIdentifier}/team
POST /playbooks/{playbookIdentifier}/team HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "resourceOwner": "text",
  "isAdmin": true
}
{
  "resourceOwner": "text",
  "isAdmin": true,
  "dateAdded": "2025-12-06T04:16:05.373Z",
  "email": "text",
  "objectIdentifier": "text",
  "name": "text"
}

Adds multiple team members (ACL entries) to the playbook in bulk.

post

Creates multiple ACL entries (team members) for the specified playbook in bulk.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
playbookIdentifierstringRequired
Bodyobject[]
resourceOwnerstring | nullableRequired
isAdminbooleanRequired
Responses
post
/playbooks/{playbookIdentifier}/team/bulk
POST /playbooks/{playbookIdentifier}/team/bulk HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

[
  {
    "resourceOwner": "text",
    "isAdmin": true
  }
]
[
  {
    "resourceOwner": "text",
    "isAdmin": true,
    "dateAdded": "2025-12-06T04:16:05.373Z",
    "email": "text",
    "objectIdentifier": "text",
    "name": "text"
  }
]

Gets all available users that can be added to the playbook team.

get

Retrieves a paginated list of all available users that can be added to the playbook team.

Authorizations
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.

Responses
200

OK

get
/playbooks/{playbookIdentifier}/team/available
GET /playbooks/{playbookIdentifier}/team/available HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "items": [
    {
      "name": "text",
      "id": "text",
      "email": "text",
      "picture": "text",
      "roles": [
        {
          "id": "text",
          "name": "text"
        }
      ],
      "isAvailable": true
    }
  ],
  "totalCount": 1
}

Gets a specific team member (ACL entry) by its object identifier.

get

Retrieves the details of an ACL entry (team member) for the specified playbook using its object identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The object identifier of the ACL entry.

playbookIdentifierstringRequired
Responses
200

OK

get
/playbooks/{playbookIdentifier}/team/{objectIdentifier}
GET /playbooks/{playbookIdentifier}/team/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "resourceOwner": "text",
  "isAdmin": true,
  "dateAdded": "2025-12-06T04:16:05.373Z",
  "email": "text",
  "objectIdentifier": "text",
  "name": "text"
}

Updates an existing team member (ACL entry) for the playbook.

put

Updates the details of an existing ACL entry (team member) for the specified playbook using its object identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The object identifier of the ACL entry to update.

playbookIdentifierstringRequired
Body
isAdminbooleanRequired
Responses
200

OK

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

{
  "isAdmin": true
}
{
  "resourceOwner": "text",
  "isAdmin": true,
  "dateAdded": "2025-12-06T04:16:05.373Z",
  "email": "text",
  "objectIdentifier": "text",
  "name": "text"
}

Deletes a team member (ACL entry) from the playbook.

delete

Deletes an ACL entry (team member) from the specified playbook using its object identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The object identifier of the ACL entry to delete.

playbookIdentifierstringRequired
Responses
delete
/playbooks/{playbookIdentifier}/team/{objectIdentifier}
DELETE /playbooks/{playbookIdentifier}/team/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Checks if the current user has admin access to the playbook.

get

Checks if the current user has admin access to the specified playbook.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
playbookIdentifierstringRequired
Responses
200

OK

Responseboolean
get
/playbooks/{playbookIdentifier}/team/admin-access
GET /playbooks/{playbookIdentifier}/team/admin-access HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
true

Last updated