Workspace object settings (read-only)

Returns all object types with nested statuses and per-type custom field definitions. Use this to build object forms and integrations without admin object-type permissions.

GET/workspace/object-settings

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Responses

200

objectTypesObjectTypeDetailResponseDto[]required

All non-deleted object types with nested statuses and per-type custom field definitions (read-only bundle for forms and integrations).

Show properties

Array of ObjectTypeDetailResponseDto

createdAtstringrequired

customFieldsObjectCustomFieldInTypeDto[]required

Show properties

Array of ObjectCustomFieldInTypeDto

descriptionstringrequired

idstringrequired

namestringrequired

objectTypeIdstringrequired

selectOptionsany[]required

showInHeaderbooleanrequired

showInListbooleanrequired

sortnumberrequired

translationsany[]required

typestringrequired

iconobject | nullrequired

idstringrequired

namestringrequired

slugstringrequired

sortnumberrequired

statusesObjectStatusDto[]required

Show properties

Array of ObjectStatusDto

colorstringrequired

createdAtstringrequired

idstringrequired

namestringrequired

sortnumberrequired

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Request

curl -X GET "https://leadtime.app/api/public/workspace/object-settings" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch("https://leadtime.app/api/public/workspace/object-settings", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

import requests

response = requests.get(
    "https://leadtime.app/api/public/workspace/object-settings",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    },
)

Response

{
  "objectTypes": [
    {
      "createdAt": "string",
      "customFields": [
        {
          "description": "string",
          "id": "string",
          "name": "string",
          "objectTypeId": "string",
          "selectOptions": [],
          "showInHeader": true,
          "showInList": true,
          "sort": 0,
          "translations": [],
          "type": "string"
        }
      ],
      "icon": {},
      "id": "string",
      "name": "string",
      "slug": "string",
      "sort": 0,
      "statuses": [
        {
          "color": "string",
          "createdAt": "string",
          "id": "string",
          "name": "string",
          "sort": 0
        }
      ]
    }
  ]
}