Skip to content

Resources API

Once you've defined a resource using Blueprints, you can interact with it using the Resources API.

The base API URL is https://api.diggama.com/v2/.

Endpoints overview

MethodEndpointDescriptionAbility
GET/resources/{blueprint}List resourcesview
GET/resources/{blueprint}/{id}Get a resourceview
POST/resources/{blueprint}Create a resourcecreate
PUT/resources/{blueprint}/{id}Full updateupdate
PATCH/resources/{blueprint}/{id}Partial updateupdate
DELETE/resources/{blueprint}/{id}Delete a resourcedelete
POST/resources/{blueprint}/bulkBulk createcreate
PATCH/resources/{blueprint}/bulkBulk updateupdate
DELETE/resources/{blueprint}/bulkBulk deletedelete
POST/resources/{blueprint}/bulk-publishBulk publishpublish
POST/resources/{blueprint}/bulk-unpublishBulk unpublishpublish
GET/resources/{blueprint}/exportExport resourcesview

Resource response format

All resource endpoints return data in the following format:

json
{
  "id": "gKqv6dx6pBk9",
  "type": "resource",
  "published_at": "2026-01-15T10:30:00+00:00",
  "created_at": "2026-01-10T08:00:00+00:00",
  "updated_at": "2026-01-15T10:30:00+00:00",
  "attributes": {
    "title": "Example page",
    "slug": "example-page",
    "content": "<p>Hello world</p>"
  },
  "relationships": {
    "blueprint": {
      "data": {
        "id": "pages",
        "type": "blueprint"
      }
    }
  }
}

Sparse fieldsets

You can control which top-level fields are returned using the fields and exclude query parameters.

GET /v2/resources/pages?fields=id,attributes
GET /v2/resources/pages?exclude=relationships

Variants

If a blueprint uses variants (e.g. for multilingual content), use the variant query parameter on any endpoint:

GET /v2/resources/pages?variant=fr
PUT /v2/resources/pages/gKqv6dx6pBk9?variant=fr

If omitted, the blueprint's default variant is used.

Diggama Documentation