Read the library's content types, resolved

Embed
Preview of the card
<a href="https://forumulate.com/reference/forumulate-api-contentstudio-types"><img src="https://forumulate.com/reference/_api/public/orgs/046a9bc0-d530-43ae-9bae-af7945008cda/spaces/8042f004-e3d9-445f-b7a4-b6c1f86836e6/pages/f4d9b97f-a300-4186-9636-1d6427842a71/social-card.svg?v=3e7ae33eec8b" alt="Read the library's content types, resolved" width="600" height="315"></a>
GEThttps://forumulate.com/api/orgs/{orgId}/content/libraries/{libraryId}/types

Everything the console needs to draw a library: each content type resolved, which are globals and which are routable, how they are grouped, their fields, the locales and the block templates a new entry can start from.

Each content type with its presets and patches applied: label, whether it is a global (singleton) or routable, its studio group, its settings and every field declaration — what the console draws the Content tree and a collection table from. Also the locales, the block types, the library’s own block templates and what the caller may do here (can). PUT …/model is where the model is changed.

Requires token scope: read (the coarse method gate) for Atlas key (ak_), Personal Access Token (cft_) or OAuth (cfo_) auth — in addition to any catalog scope (GET /pats/scopes) the route’s capability needs. Session/cookie auth is governed by RBAC capabilities instead.

Parameters
orgIdstringpathrequired
libraryIdstringpathrequired
forumulate-versionstringheader
API version negotiation. Send forumulate-version: 2026-12-01 on every request from a new integration; it is optional only so that integrations written before versioning keep working. Each version includes everything before it:
Code samples
cURL
curl -X GET "https://forumulate.com/api/orgs/{orgId}/content/libraries/{libraryId}/types" \
  -H "forumulate-version: <value>"
TypeScript
const res = await fetch('https://forumulate.com/api/orgs/{orgId}/content/libraries/{libraryId}/types', {
  method: 'GET',
  headers: {
    'forumulate-version': '<value>',
  },
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://forumulate.com/api/orgs/{orgId}/content/libraries/{libraryId}/types",
    headers={
    "forumulate-version": "<value>",
    },
)
data = res.json()
Go
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://forumulate.com/api/orgs/{orgId}/content/libraries/{libraryId}/types", nil)
	req.Header.Set("forumulate-version", "<value>")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://forumulate.com/api/orgs/{orgId}/content/libraries/{libraryId}/types');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['forumulate-version: <value>']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://forumulate.com/api/orgs/{orgId}/content/libraries/{libraryId}/types')
req = Net::HTTP::Get.new(uri)
req['forumulate-version'] = '<value>'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://forumulate.com/api/orgs/{orgId}/content/libraries/{libraryId}/types"))
    .header("forumulate-version", "<value>")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 Success.
Example
{
  "blockTemplates": [
    {
      "description": "string",
      "id": "string",
      "label": "string",
      "rows": [
        {
          "blockType": null,
          "values": null,
          "variant": null
        }
      ],
      "source": "builtin"
    }
  ],
  "blockTypes": [
    {
      "description": "string",
      "fields": [
        {
          "accept": null,
          "admin": null,
          "allowed": null,
          "allowedBlocks": null,
          "allowedGroups": null,
          "column": null,
          "condition": null,
          "default": null,
          "expr": null,
          "facet": null,
          "fields": null,
          "from": null,
          "hasMany": null,
          "hint": null,
          "indexed": null,
          "internal": null,
          "key": null,
          "label": null,
          "language": null,
          "localized": null,
          "max": null,
          "maxLength": null,
          "meta": null,
          "min": null,
          "minLength": null,
          "options": null,
          "pattern": null,
          "placeholder": null,
          "relationSpaceId": null,
          "required": null,
          "rowLabelField": null,
          "schema": null,
          "schemaProperty": null,
          "sortable": null,
          "to": null,
          "type": null,
          "unique": null,
          "visibility": null
        }
      ],
      "group": "string",
      "icon": "string",
      "key": "string",
      "label": "string",
      "variants": [
        {
          "fields": null,
          "key": null,
          "label": null
        }
      ]
    }
  ],
  "can": {
    "members": true,
    "model": true,
    "publish": true,
    "scope": {
      "contentTypes": [
        null
      ],
      "denyContentTypes": [
        "string"
      ],
      "denyLocales": [
        "string"
      ],
      "locales": [
        null
      ]
    },
    "write": true
  },
  "libraryId": "string",
  "locales": [
    {
      "code": "string",
      "label": "string",
      "source": true
    }
  ],
  "sourceLocale": "string",
  "types": [
    {
      "description": "string",
      "entryCount": 0,
      "fields": [
        {
          "accept": null,
          "admin": null,
          "allowed": null,
          "allowedBlocks": null,
          "allowedGroups": null,
          "column": null,
          "condition": null,
          "default": null,
          "expr": null,
          "facet": null,
          "fields": null,
          "from": null,
          "hasMany": null,
          "hint": null,
          "indexed": null,
          "internal": null,
          "key": null,
          "label": null,
          "language": null,
          "localized": null,
          "max": null,
          "maxLength": null,
          "meta": null,
          "min": null,
          "minLength": null,
          "options": null,
          "pattern": null,
          "placeholder": null,
          "relationSpaceId": null,
          "required": null,
          "rowLabelField": null,
          "schema": null,
          "schemaProperty": null,
          "sortable": null,
          "to": null,
          "type": null,
          "unique": null,
          "visibility": null
        }
      ],
      "globalEntryId": "string",
      "group": "string",
      "icon": "string",
      "key": "string",
      "label": "string",
      "routable": true,
      "settings": {
        "blockLibrary": true,
        "defaultSort": "string",
        "defaultVisibility": "internal",
        "group": "string",
        "icon": "string",
        "listColumns": [
          null
        ],
        "orderable": true,
        "previewUrl": "string",
        "routable": true,
        "searchableFields": [
          null
        ],
        "singleton": true,
        "slugField": "string",
        "strict": true,
        "titleField": "string",
        "versions": {
          "max": null
        }
      },
      "singleton": true
    }
  ]
}
Schema
blockTemplatesContentBlockTemplate[]required
Show child parameters
descriptionstring
idstringrequired
labelstringrequired
rowsBlockTemplateRow[]required
Show child parameters
blockTypestringrequired
valuesobject
variantstring
sourcestringrequired
builtin | library
blockTypesBlockType[]required
Show child parameters
descriptionstring
fieldsSpaceTypeField[]required
Show child parameters
acceptstring[]
adminobject
allowedstring[]
allowedBlocksstring[]
allowedGroupsstring[]
columnboolean
conditionstring | number | boolean | string | number | boolean | object[] | object[] | object
defaultobject
exprstring | number | boolean | string | number | boolean | object[] | object[] | object
facetboolean
fieldsSpaceTypeField[]
fromstring
hasManyboolean
hintstring
indexedboolean
internalboolean
keystringrequired
labelstringrequired
languagestring
localizedboolean
maxnumber
maxLengthnumber
metaboolean
minnumber
minLengthnumber
optionsstring[]
patternstring
placeholderstring
relationSpaceIdstring
requiredboolean
rowLabelFieldstring
schemaobject
schemaPropertystring
sortableboolean
toReferenceTarget[]
typestringrequired
array | blocks | boolean | code | color | computed | date | datetime | email | file | form | group | hours | image | json | link | media | money | multiselect | number | place | reference | relation | richText | select | seo | slug | text | textarea | url
uniqueboolean
visibilitystring
internal | preview | public
groupstring
iconstring
keystringrequired
labelstringrequired
variantsBlockVariant[]
Show child parameters
fieldsobject
keystringrequired
labelstringrequired
canobjectrequired
Show child parameters
membersbooleanrequired
modelbooleanrequired
publishbooleanrequired
scopeobjectrequired
Show child parameters
contentTypesarrayrequired
denyContentTypesstring[]required
denyLocalesstring[]required
localesarrayrequired
writebooleanrequired
libraryIdstringrequired
localesStudioLocale[]required
Show child parameters
codestringrequired
labelstringrequired
sourcebooleanrequired
sourceLocalestringrequired
typesStudioContentType[]required
Show child parameters
descriptionstringrequired
entryCountnumberrequired
fieldsSpaceTypeField[]required
Show child parameters
acceptstring[]
adminobject
allowedstring[]
allowedBlocksstring[]
allowedGroupsstring[]
columnboolean
conditionstring | number | boolean | string | number | boolean | object[] | object[] | object
defaultobject
exprstring | number | boolean | string | number | boolean | object[] | object[] | object
facetboolean
fieldsSpaceTypeField[]
fromstring
hasManyboolean
hintstring
indexedboolean
internalboolean
keystringrequired
labelstringrequired
languagestring
localizedboolean
maxnumber
maxLengthnumber
metaboolean
minnumber
minLengthnumber
optionsstring[]
patternstring
placeholderstring
relationSpaceIdstring
requiredboolean
rowLabelFieldstring
schemaobject
schemaPropertystring
sortableboolean
toReferenceTarget[]
typestringrequired
array | blocks | boolean | code | color | computed | date | datetime | email | file | form | group | hours | image | json | link | media | money | multiselect | number | place | reference | relation | richText | select | seo | slug | text | textarea | url
uniqueboolean
visibilitystring
internal | preview | public
globalEntryIdstringrequired
groupstringrequired
iconstringrequired
keystringrequired
labelstringrequired
routablebooleanrequired
settingsobjectrequired
Show child parameters
blockLibraryboolean
defaultSortstring
defaultVisibilitystring
internal | preview | public
groupstring
iconstring
listColumnsstring[]
orderableboolean
previewUrlstring
routableboolean
searchableFieldsstring[]
singletonboolean
slugFieldstring
strictboolean
titleFieldstring
versionsobject
singletonbooleanrequired
400 The request could not be understood — a malformed header, path or query value (request.malformed). A value that was understood but is not acceptable is a 422 validation.failed.
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
Stable, machine-readable error code, e.g. rbac.forbidden.
messagestringrequired
Human-readable explanation.
detailsobject
Field-level validation problems, keyed by field path (422 only).
docsstring
Where the vocabulary or format this error is about is published — an absolute URL, or an API route such as GET /space-types/{type}/presets. Present on errors over a controlled list, so the answer to "what am I allowed to send?" is in the error itself.
reasonstring
Why a credential was refused, as one stable word, where one status has several causes — e.g. an external_jwt redeem answers iat_too_old, iat_in_future, bad_signature, bad_issuer, bad_audience, expired and more. Branch on this, not on message.
slugsstring[]
The exact slugs that collided, on a slug-conflict 409 — space.slug_taken, page.slug_taken, collection.slug_taken, site.slug_taken or badge.slug_taken.
conflictobject
On a 409 from a content entry field write (PATCH …/entries/{entryId}/fields) whose If-Match was stale.
Show child parameters
etagstringrequired
The entry's current fields etag.
opsarrayrequired
The field operations since your If-Match that touch a path your own operations touch. Empty: none did — retry the batch unchanged under etag. null: the history no longer reaches your tag — re-read the entry first.
requestIdstring
The id of this request — the same value as the x-request-id and x-forumulate-request-id response headers. Quote it in a bug report: it is the only thing that finds your exact request in our logs. It is in the body because that is the part that survives — an SDK that throws the parsed body, a serverless log that keeps the body and drops the headers, a ticket with the JSON pasted in.
401 No credential, or one that is expired or revoked (auth.required). Send a Bearer token or the session cookie.
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
Stable, machine-readable error code, e.g. rbac.forbidden.
messagestringrequired
Human-readable explanation.
detailsobject
Field-level validation problems, keyed by field path (422 only).
docsstring
Where the vocabulary or format this error is about is published — an absolute URL, or an API route such as GET /space-types/{type}/presets. Present on errors over a controlled list, so the answer to "what am I allowed to send?" is in the error itself.
reasonstring
Why a credential was refused, as one stable word, where one status has several causes — e.g. an external_jwt redeem answers iat_too_old, iat_in_future, bad_signature, bad_issuer, bad_audience, expired and more. Branch on this, not on message.
slugsstring[]
The exact slugs that collided, on a slug-conflict 409 — space.slug_taken, page.slug_taken, collection.slug_taken, site.slug_taken or badge.slug_taken.
conflictobject
On a 409 from a content entry field write (PATCH …/entries/{entryId}/fields) whose If-Match was stale.
Show child parameters
etagstringrequired
The entry's current fields etag.
opsarrayrequired
The field operations since your If-Match that touch a path your own operations touch. Empty: none did — retry the batch unchanged under etag. null: the history no longer reaches your tag — re-read the entry first.
requestIdstring
The id of this request — the same value as the x-request-id and x-forumulate-request-id response headers. Quote it in a bug report: it is the only thing that finds your exact request in our logs. It is in the body because that is the part that survives — an SDK that throws the parsed body, a serverless log that keeps the body and drops the headers, a ticket with the JSON pasted in.
403 Authenticated, and not allowed — always rbac.forbidden, whether what is missing is the capability, the token scope, or a resource the token is pinned away from. The message names the capability and, for a scope refusal, the scopes that would grant it. A refusal because of the PLAN is a 402 with quota.exceeded, not this.
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
Stable, machine-readable error code, e.g. rbac.forbidden.
messagestringrequired
Human-readable explanation.
detailsobject
Field-level validation problems, keyed by field path (422 only).
docsstring
Where the vocabulary or format this error is about is published — an absolute URL, or an API route such as GET /space-types/{type}/presets. Present on errors over a controlled list, so the answer to "what am I allowed to send?" is in the error itself.
reasonstring
Why a credential was refused, as one stable word, where one status has several causes — e.g. an external_jwt redeem answers iat_too_old, iat_in_future, bad_signature, bad_issuer, bad_audience, expired and more. Branch on this, not on message.
slugsstring[]
The exact slugs that collided, on a slug-conflict 409 — space.slug_taken, page.slug_taken, collection.slug_taken, site.slug_taken or badge.slug_taken.
conflictobject
On a 409 from a content entry field write (PATCH …/entries/{entryId}/fields) whose If-Match was stale.
Show child parameters
etagstringrequired
The entry's current fields etag.
opsarrayrequired
The field operations since your If-Match that touch a path your own operations touch. Empty: none did — retry the batch unchanged under etag. null: the history no longer reaches your tag — re-read the entry first.
requestIdstring
The id of this request — the same value as the x-request-id and x-forumulate-request-id response headers. Quote it in a bug report: it is the only thing that finds your exact request in our logs. It is in the body because that is the part that survives — an SDK that throws the parsed body, a serverless log that keeps the body and drops the headers, a ticket with the JSON pasted in.
404 No such thing — one of the ids in the path does not resolve, or resolves to something this caller may not see (*.not_found).
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
Stable, machine-readable error code, e.g. rbac.forbidden.
messagestringrequired
Human-readable explanation.
detailsobject
Field-level validation problems, keyed by field path (422 only).
docsstring
Where the vocabulary or format this error is about is published — an absolute URL, or an API route such as GET /space-types/{type}/presets. Present on errors over a controlled list, so the answer to "what am I allowed to send?" is in the error itself.
reasonstring
Why a credential was refused, as one stable word, where one status has several causes — e.g. an external_jwt redeem answers iat_too_old, iat_in_future, bad_signature, bad_issuer, bad_audience, expired and more. Branch on this, not on message.
slugsstring[]
The exact slugs that collided, on a slug-conflict 409 — space.slug_taken, page.slug_taken, collection.slug_taken, site.slug_taken or badge.slug_taken.
conflictobject
On a 409 from a content entry field write (PATCH …/entries/{entryId}/fields) whose If-Match was stale.
Show child parameters
etagstringrequired
The entry's current fields etag.
opsarrayrequired
The field operations since your If-Match that touch a path your own operations touch. Empty: none did — retry the batch unchanged under etag. null: the history no longer reaches your tag — re-read the entry first.
requestIdstring
The id of this request — the same value as the x-request-id and x-forumulate-request-id response headers. Quote it in a bug report: it is the only thing that finds your exact request in our logs. It is in the body because that is the part that survives — an SDK that throws the parsed body, a serverless log that keeps the body and drops the headers, a ticket with the JSON pasted in.
429 Rate limited — see the RateLimit-* headers.
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
Stable, machine-readable error code, e.g. rbac.forbidden.
messagestringrequired
Human-readable explanation.
detailsobject
Field-level validation problems, keyed by field path (422 only).
docsstring
Where the vocabulary or format this error is about is published — an absolute URL, or an API route such as GET /space-types/{type}/presets. Present on errors over a controlled list, so the answer to "what am I allowed to send?" is in the error itself.
reasonstring
Why a credential was refused, as one stable word, where one status has several causes — e.g. an external_jwt redeem answers iat_too_old, iat_in_future, bad_signature, bad_issuer, bad_audience, expired and more. Branch on this, not on message.
slugsstring[]
The exact slugs that collided, on a slug-conflict 409 — space.slug_taken, page.slug_taken, collection.slug_taken, site.slug_taken or badge.slug_taken.
conflictobject
On a 409 from a content entry field write (PATCH …/entries/{entryId}/fields) whose If-Match was stale.
Show child parameters
etagstringrequired
The entry's current fields etag.
opsarrayrequired
The field operations since your If-Match that touch a path your own operations touch. Empty: none did — retry the batch unchanged under etag. null: the history no longer reaches your tag — re-read the entry first.
requestIdstring
The id of this request — the same value as the x-request-id and x-forumulate-request-id response headers. Quote it in a bug report: it is the only thing that finds your exact request in our logs. It is in the body because that is the part that survives — an SDK that throws the parsed body, a serverless log that keeps the body and drops the headers, a ticket with the JSON pasted in.
default Error — the stable { error: { code, message } } envelope.
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
Stable, machine-readable error code, e.g. rbac.forbidden.
messagestringrequired
Human-readable explanation.
detailsobject
Field-level validation problems, keyed by field path (422 only).
docsstring
Where the vocabulary or format this error is about is published — an absolute URL, or an API route such as GET /space-types/{type}/presets. Present on errors over a controlled list, so the answer to "what am I allowed to send?" is in the error itself.
reasonstring
Why a credential was refused, as one stable word, where one status has several causes — e.g. an external_jwt redeem answers iat_too_old, iat_in_future, bad_signature, bad_issuer, bad_audience, expired and more. Branch on this, not on message.
The Forumulate teamUpdated