List custom elements

get

https://api.andesine.app/extensions/elements

The custom elements that the workspace's active extensions draw in the editor, e.g. Tabs: their props, whether they have content, which child blocks their content accepts, and the elements that belong inside them. Write them in MDX as content. The editor guides edits by these rules and offers a clean-up; the API doesn't enforce them.

Required API key permissions: read:entries. Write permissions also grant read access for the same resource.

Authentication

apiKeyhttp, bearer, Andesine API key

Use an Andesine API key as a Bearer token

oauthhttp, bearer, Andesine OAuth access token

Use an OAuth access token with andesine:api scope. Send x-workspace-id for workspace operations. Current user permissions apply.

Headers

x-workspace-idstring

Required for OAuth: ID of the workspace to access. API keys use their own workspace.

Responses

200OKapplication/json

Bodyarray of object

9 fields

element*string

name*string

descriptionstring

content*boolean

False for an element without content, written as

acceptsobject

The direct child blocks that its content accepts; without it, any blocks

2 fields

elementsarray of string

blocksarray of string

rejectsobject

The direct child blocks that its content doesn't accept, even if accepts lists them

2 fields

elementsarray of string

blocksarray of string

propsarray of any of

The props, with their defaults, which a new element gets

Options

Any of

Option 1object

name*string

titlestring

descriptionstring

type*constant

Value: "string"

enumarray of string

controlstring

One of: "input", "textarea", "icon", "link", "select", "toggle"

placeholderstring

minLengthnumber

maxLengthnumber

defaultstring

Option 2object

name*string

titlestring

descriptionstring

type*string

One of: "number", "integer"

minimumnumber

maximumnumber

defaultnumber

Option 3object

name*string

titlestring

descriptionstring

type*constant

Value: "boolean"

defaultboolean

extension*string

The extension that renders it, e.g. andesine/pages

children*array of object

Elements that belong inside this one, e.g. Tab in Tabs

7 fields

element*string

namestring

descriptionstring

content*boolean

False for an element without content, written as

acceptsobject

The direct child blocks that its content accepts; without it, any blocks

2 fields

elementsarray of string

blocksarray of string

rejectsobject

The direct child blocks that its content doesn't accept, even if accepts lists them

2 fields

elementsarray of string

blocksarray of string

propsarray of any of

The props, with their defaults, which a new element gets

Options

Any of

Option 1object

name*string

titlestring

descriptionstring

type*constant

Value: "string"

enumarray of string

controlstring

One of: "input", "textarea", "icon", "link", "select", "toggle"

placeholderstring

minLengthnumber

maxLengthnumber

defaultstring

Option 2object

name*string

titlestring

descriptionstring

type*string

One of: "number", "integer"

minimumnumber

maximumnumber

defaultnumber

Option 3object

name*string

titlestring

descriptionstring

type*constant

Value: "boolean"

defaultboolean

400Bad Requestapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "BAD_REQUEST"

status*constant

Value: 400

message*string

Default: "Bad Request"

dataValidationErrorData

2 fields

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

issuesarray of ValidationIssue

3 fields

message*string

codestring

patharray of any of

Options

Any of

Option 1string

Option 2number

Option 3object

key*any of

Options

Any of

Option 1string

Option 2number

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

401Unauthorizedapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "UNAUTHORIZED"

status*constant

Value: 401

message*string

Default: "Unauthorized"

dataErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

403Forbiddenapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "FORBIDDEN"

status*constant

Value: 403

message*string

Default: "Forbidden"

dataForbiddenErrorData

4 fields

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

missingPermissionsarray of string

requiredPlanconstant

Value: "pro"

actionstring

The requested action that was denied

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

404Not Foundapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "NOT_FOUND"

status*constant

Value: 404

message*string

Default: "Not Found"

dataErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

409Conflictapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "CONFLICT"

status*constant

Value: 409

message*string

Default: "Conflict"

dataErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

429Too Many Requestsapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "TOO_MANY_REQUESTS"

status*constant

Value: 429

message*string

Default: "Too Many Requests"

dataRateLimitErrorData

3 fields

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

limitstring

The limit that was reached: a short-term rate limit, or a monthly API call, AI credit, or spending limit

One of: "rate", "api-calls", "ai-credits", "spending"

retryAfterSecondsnumber

Minimum delay before another attempt, in seconds. Also sent in Retry-After.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

500Internal Server Errorapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "INTERNAL_SERVER_ERROR"

status*constant

Value: 500

message*string

Default: "Internal Server Error"

dataErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

503Service Unavailableapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "SERVICE_UNAVAILABLE"

status*constant

Value: 503

message*string

Default: "Service Unavailable"

dataErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

Request

bash

curl --request GET \
  --url 'https://api.andesine.app/extensions/elements' \
  --header 'Authorization: Bearer <token>'

javascript

const response = await fetch("https://api.andesine.app/extensions/elements", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

const data = await response.json();

python

import requests

response = requests.get(
    "https://api.andesine.app/extensions/elements",
    headers={
        "Authorization": "Bearer <token>",
    },
)

print(response.json())

Response

json

[
  {
    "element": "string",
    "name": "string",
    "description": "string",
    "content": true,
    "accepts": {
      "elements": [
        "string"
      ],
      "blocks": [
        "string"
      ]
    },
    "rejects": {
      "elements": [
        "string"
      ],
      "blocks": [
        "string"
      ]
    },
    "props": [
      {
        "name": "string",
        "title": "string",
        "description": "string",
        "type": "string",
        "enum": [
          "string"
        ],
        "control": "input",
        "placeholder": "string",
        "minLength": 0,
        "maxLength": 0,
        "default": "string"
      }
    ],
    "extension": "string",
    "children": [
      {
        "element": "string",
        "name": "string",
        "description": "string",
        "content": true,
        "accepts": {
          "elements": [
            "string"
          ],
          "blocks": [
            "string"
          ]
        },
        "rejects": {
          "elements": [
            "string"
          ],
          "blocks": [
            "string"
          ]
        },
        "props": [
          {
            "name": "string",
            "title": "string",
            "description": "string",
            "type": "string",
            "enum": [
              "string"
            ],
            "control": "input",
            "placeholder": "string",
            "minLength": 0,
            "maxLength": 0,
            "default": "string"
          }
        ]
      }
    ]
  }
]

json

{
  "defined": true,
  "code": "BAD_REQUEST",
  "status": 400,
  "message": "Bad Request",
  "data": {
    "hints": [
      "string"
    ],
    "issues": [
      {
        "message": "string",
        "code": "string",
        "path": [
          "string"
        ]
      }
    ]
  }
}

json

{
  "defined": true,
  "code": "UNAUTHORIZED",
  "status": 401,
  "message": "Unauthorized",
  "data": {
    "hints": [
      "string"
    ]
  }
}

json

{
  "defined": true,
  "code": "FORBIDDEN",
  "status": 403,
  "message": "Forbidden",
  "data": {
    "hints": [
      "string"
    ],
    "missingPermissions": [
      "string"
    ],
    "requiredPlan": "pro",
    "action": "string"
  }
}

json

{
  "defined": true,
  "code": "NOT_FOUND",
  "status": 404,
  "message": "Not Found",
  "data": {
    "hints": [
      "string"
    ]
  }
}

json

{
  "defined": true,
  "code": "CONFLICT",
  "status": 409,
  "message": "Conflict",
  "data": {
    "hints": [
      "string"
    ]
  }
}

json

{
  "defined": true,
  "code": "TOO_MANY_REQUESTS",
  "status": 429,
  "message": "Too Many Requests",
  "data": {
    "hints": [
      "string"
    ],
    "limit": "rate",
    "retryAfterSeconds": 0
  }
}

json

{
  "defined": true,
  "code": "INTERNAL_SERVER_ERROR",
  "status": 500,
  "message": "Internal Server Error",
  "data": {
    "hints": [
      "string"
    ]
  }
}

json

{
  "defined": true,
  "code": "SERVICE_UNAVAILABLE",
  "status": 503,
  "message": "Service Unavailable",
  "data": {
    "hints": [
      "string"
    ]
  }
}