Get Compositions Batch

curl --request POST \
  --url https://api.widgetic.com/v1/compositions/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "compositionIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

import requests

url = "https://api.widgetic.com/v1/compositions/batch"

payload = { "compositionIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({compositionIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']})
};

fetch('https://api.widgetic.com/v1/compositions/batch', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.widgetic.com/v1/compositions/batch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'compositionIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.widgetic.com/v1/compositions/batch"

	payload := strings.NewReader("{\n  \"compositionIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.widgetic.com/v1/compositions/batch")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"compositionIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.widgetic.com/v1/compositions/batch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"compositionIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "compositions": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "creatorId": "123e4567-e89b-12d3-a456-426614174001",
        "widgetId": "123e4567-e89b-12d3-a456-426614174002",
        "name": "My Composition",
        "content": {
          "key": "value"
        },
        "contentVersion": 3,
        "status": "draft",
        "createdAt": "2023-01-01T00:00:00Z",
        "updatedAt": "2023-01-02T00:00:00Z",
        "embedSettings": {
          "width": "100%",
          "height": "500px"
        },
        "design": {
          "theme": "light",
          "colors": {
            "primary": "#0066ff"
          }
        },
        "databaseId": "123e4567-e89b-12d3-a456-426614174003",
        "projectId": "123e4567-e89b-12d3-a456-426614174004",
        "managedUserId": "b7c8d9e0-1f2a-4b3c-8d4e-5f6a7b8c9d0e",
        "direct": true,
        "lastEditedBy": {},
        "lastEditedAt": "2026-10-28T14:32:00Z"
      }
    ],
    "errors": [
      {
        "id": "<string>",
        "error": "<string>"
      }
    ]
  },
  "meta": {
    "page": 1,
    "size": 20,
    "total": 135,
    "limit": 20,
    "offset": 0,
    "hasNextPage": true,
    "hasPreviousPage": false,
    "nextCursor": "<string>",
    "warnings": [
      "<string>"
    ]
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

Compositions

Get Compositions Batch

Retrieves multiple compositions by their IDs in a single request. This endpoint includes domain validation for embed contexts and is used by the embed SDK.

Each composition is checked on its own. If its owner listed the websites it may appear on (the workspace’s domain list, or the allowedDomains of a partner the owner administers) and the request comes from another website (the Origin header, or the host of Referer when there is no Origin), that composition is left out of compositions and reported in errors as Domain access denied: <reason>; the others are still returned. A request that names no website, and an owner who listed nothing, are not restricted, and a page on the visitor’s own machine (localhost, 127.0.0.1 or [::1], on any port) is always allowed. So is the website where a partner integrates Widgetic, with every subdomain of it (platformDomain in the answer of GET /partners/mine), for the compositions of that partner: a partner’s list never has to name it.

POST

compositions

batch

Get Compositions Batch

curl --request POST \
  --url https://api.widgetic.com/v1/compositions/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "compositionIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

import requests

url = "https://api.widgetic.com/v1/compositions/batch"

payload = { "compositionIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({compositionIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']})
};

fetch('https://api.widgetic.com/v1/compositions/batch', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.widgetic.com/v1/compositions/batch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'compositionIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.widgetic.com/v1/compositions/batch"

	payload := strings.NewReader("{\n  \"compositionIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.widgetic.com/v1/compositions/batch")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"compositionIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.widgetic.com/v1/compositions/batch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"compositionIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "compositions": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "creatorId": "123e4567-e89b-12d3-a456-426614174001",
        "widgetId": "123e4567-e89b-12d3-a456-426614174002",
        "name": "My Composition",
        "content": {
          "key": "value"
        },
        "contentVersion": 3,
        "status": "draft",
        "createdAt": "2023-01-01T00:00:00Z",
        "updatedAt": "2023-01-02T00:00:00Z",
        "embedSettings": {
          "width": "100%",
          "height": "500px"
        },
        "design": {
          "theme": "light",
          "colors": {
            "primary": "#0066ff"
          }
        },
        "databaseId": "123e4567-e89b-12d3-a456-426614174003",
        "projectId": "123e4567-e89b-12d3-a456-426614174004",
        "managedUserId": "b7c8d9e0-1f2a-4b3c-8d4e-5f6a7b8c9d0e",
        "direct": true,
        "lastEditedBy": {},
        "lastEditedAt": "2026-10-28T14:32:00Z"
      }
    ],
    "errors": [
      {
        "id": "<string>",
        "error": "<string>"
      }
    ]
  },
  "meta": {
    "page": 1,
    "size": 20,
    "total": 135,
    "limit": 20,
    "offset": 0,
    "hasNextPage": true,
    "hasPreviousPage": false,
    "nextCursor": "<string>",
    "warnings": [
      "<string>"
    ]
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Composition not found",
    "timestamp": "2026-10-15T10:00:00.000Z",
    "param": "name",
    "docUrl": "<string>",
    "suggestedAction": "<string>",
    "retryAfter": 60,
    "details": {},
    "correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

compositionIds

string<uuid>[]

required

Array of composition IDs to retrieve

Maximum array length: 50

Response

Compositions retrieved successfully

success

boolean

required

Always true on a success.

Example:

true

data

object

required

Show child attributes

API Reference

Public Embed

Workflows

Partners

Widgets

Users

Uploads

Tokens

Operations

Managed Users

Invoices

Entitlements

Credits

Compositions

Canvases

Brand Kit

Get Compositions Batch

Authorizations

Body

Response