List CMS Collections

Returns every CMS collection in your organization.

GET /cms

List CMS Collections

cURL

curl --request GET \
  --url https://api.kardow.com/cms \
  --header 'x-api-key: <api-key>'

200

{
  "collections": [
    {
      "slug": "<string>",
      "name": "<string>",
      "schema": [
        {
          "name": "<string>",
          "label": "<string>",
          "required": false,
          "options": [
            "<string>"
          ],
          "max_length": 123,
          "min": 123,
          "max": 123,
          "default": "<unknown>"
        }
      ],
      "description": "<string>",
      "visibility": "public",
      "rules": {
        "allow_public_submit": false,
        "moderation": "manual",
        "sort_by": "created_at",
        "sort_dir": "desc"
      },
      "required_entitlement": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Use this to enumerate the collections your dashboard or build pipeline should sync.

Example

curl https://api.kardow.com/cms \
  -H "x-api-key: $KARDOW_API_KEY"

Authorizations

x-api-key · string · header · required

API key for authentication. Get yours from Settings > API Keys in the Kardow dashboard.

Response

200

application/json

Success

collections · object[]

Show child attributes