Settings

Gets a setting by its object identifier.

get

Retrieves a setting using its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The object identifier of the setting.

Responses

200

OK

text/plainapplication/jsontext/json

namestring · nullableRequired

descriptionstring · nullableRequired

dataTypestring · nullableOptional

resourceTypeIdentifierstring · uuid · nullableOptional

isYesboolean · nullableOptional

decimalValuenumber · double · nullableOptional

textstring · nullableOptional

objectIdentifierstring · uuidOptional

dateAddedstring · date-timeOptional

isDirectorybooleanOptional

orderNumberinteger · int32Optional

singleCategoryIdentifierstring · uuid · nullableOptional

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

get/settings/{objectIdentifier}

HTTPcURLJavaScriptPython

GET /settings/{objectIdentifier} HTTP/1.1
Host: settings.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "text",
  "description": "text",
  "dataType": "text",
  "resourceTypeIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "isYes": true,
  "decimalValue": 1,
  "text": "text",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2026-07-10T06:42:59.540Z",
  "isDirectory": true,
  "orderNumber": 1,
  "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "singleCategory": {
    "label": "text",
    "value": "text"
  },
  "options": [
    {
      "label": "text",
      "value": "text"
    }
  ],
  "categories": [
    {
      "label": "text",
      "value": "text"
    }
  ]
}

Gets all settings for the current organization.

get

Retrieves a paginated list of all settings for the current organization.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Query parameters

pageNumberinteger · int32Optional

The page number for paginated results.

pageSizeinteger · int32Optional

The number of items per page.

parentObjectIdentifierstring · uuidOptional

Optional parent object identifier.

Responses

200

OK

text/plainapplication/jsontext/json

namestring · nullableRequired

descriptionstring · nullableRequired

dataTypestring · nullableOptional

resourceTypeIdentifierstring · uuid · nullableOptional

isYesboolean · nullableOptional

decimalValuenumber · double · nullableOptional

textstring · nullableOptional

objectIdentifierstring · uuidOptional

dateAddedstring · date-timeOptional

isDirectorybooleanOptional

orderNumberinteger · int32Optional

singleCategoryIdentifierstring · uuid · nullableOptional

403

Forbidden

text/plainapplication/jsontext/json

get/settings

HTTPcURLJavaScriptPython

GET /settings HTTP/1.1
Host: settings.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "text",
    "description": "text",
    "dataType": "text",
    "resourceTypeIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "isYes": true,
    "decimalValue": 1,
    "text": "text",
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "dateAdded": "2026-07-10T06:42:59.540Z",
    "isDirectory": true,
    "orderNumber": 1,
    "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "singleCategory": {
      "label": "text",
      "value": "text"
    },
    "options": [
      {
        "label": "text",
        "value": "text"
      }
    ],
    "categories": [
      {
        "label": "text",
        "value": "text"
      }
    ]
  }
]

Gets settings by a list of object identifiers.

get

Retrieves settings by a list of object identifiers.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Query parameters

settingIdentifiersstring · uuid[]Optional

The collection of setting object identifiers.

Responses

200

OK

text/plainapplication/jsontext/json

namestring · nullableRequired

descriptionstring · nullableRequired

dataTypestring · nullableOptional

resourceTypeIdentifierstring · uuid · nullableOptional

isYesboolean · nullableOptional

decimalValuenumber · double · nullableOptional

textstring · nullableOptional

objectIdentifierstring · uuidOptional

dateAddedstring · date-timeOptional

isDirectorybooleanOptional

orderNumberinteger · int32Optional

singleCategoryIdentifierstring · uuid · nullableOptional

403

Forbidden

text/plainapplication/jsontext/json

get/settings/setting-identifiers

HTTPcURLJavaScriptPython

GET /settings/setting-identifiers HTTP/1.1
Host: settings.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "text",
    "description": "text",
    "dataType": "text",
    "resourceTypeIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "isYes": true,
    "decimalValue": 1,
    "text": "text",
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "dateAdded": "2026-07-10T06:42:59.540Z",
    "isDirectory": true,
    "orderNumber": 1,
    "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "singleCategory": {
      "label": "text",
      "value": "text"
    },
    "options": [
      {
        "label": "text",
        "value": "text"
      }
    ],
    "categories": [
      {
        "label": "text",
        "value": "text"
      }
    ]
  }
]

Updates a setting by its object identifier.

patch

Updates a setting by its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

settingObjectIdentifierstring · uuidRequired

The object identifier of the setting to update.

Body

application/jsontext/jsonapplication/*+json

isYesboolean · nullableOptional

decimalValuenumber · double · nullableOptional

textstring · nullableOptional

datestring · date-time · nullableOptional

singleCategoryIdentifierstring · uuid · nullableOptional

categoriesstring · uuid[] · nullableOptional

organizationMetadataIdentifierstring · uuidOptional

Responses

200

OK

text/plainapplication/jsontext/json

namestring · nullableRequired

descriptionstring · nullableRequired

dataTypestring · nullableOptional

resourceTypeIdentifierstring · uuid · nullableOptional

isYesboolean · nullableOptional

decimalValuenumber · double · nullableOptional

textstring · nullableOptional

objectIdentifierstring · uuidOptional

dateAddedstring · date-timeOptional

isDirectorybooleanOptional

orderNumberinteger · int32Optional

singleCategoryIdentifierstring · uuid · nullableOptional

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

patch/settings/{settingObjectIdentifier}

HTTPcURLJavaScriptPython

PATCH /settings/{settingObjectIdentifier} HTTP/1.1
Host: settings.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 271

{
  "isYes": true,
  "decimalValue": 1,
  "text": "text",
  "date": "2026-07-10T06:42:59.540Z",
  "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "categories": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "organizationMetadataIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

application/jsontext/jsonapplication/*+json

{
  "name": "text",
  "description": "text",
  "dataType": "text",
  "resourceTypeIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "isYes": true,
  "decimalValue": 1,
  "text": "text",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2026-07-10T06:42:59.540Z",
  "isDirectory": true,
  "orderNumber": 1,
  "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "singleCategory": {
    "label": "text",
    "value": "text"
  },
  "options": [
    {
      "label": "text",
      "value": "text"
    }
  ],
  "categories": [
    {
      "label": "text",
      "value": "text"
    }
  ]
}