Get Colors

Learn how to retrieve saved brand colors from your workspace

Published Mar 25, 2026·Updated Mar 28, 2026

GET

/v1/brand-assets/colors/get

curl -X GET "https://api.orshot.com/v1/brand-assets/colors/get?tag=<TAG>&embedId=<EMBED_ID>&embedUserId=<EMBED_USER_ID>" \
  -H "Authorization: Bearer <ORSHOT_API_KEY>"

const res = await fetch("https://api.orshot.com/v1/brand-assets/colors/get?tag=<TAG>&embedId=<EMBED_ID>&embedUserId=<EMBED_USER_ID>", {
  method: "GET",
  headers: {
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
});

const data = await res.json();

import requests

response = requests.get(
    "https://api.orshot.com/v1/brand-assets/colors/get?tag=<TAG>&embedId=<EMBED_ID>&embedUserId=<EMBED_USER_ID>",
    headers={"Authorization": "Bearer <ORSHOT_API_KEY>"},
)

data = response.json()

$ch = curl_init("https://api.orshot.com/v1/brand-assets/colors/get?tag=<TAG>&embedId=<EMBED_ID>&embedUserId=<EMBED_USER_ID>");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <ORSHOT_API_KEY>",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);

require "net/http"
require "json"

uri = URI("https://api.orshot.com/v1/brand-assets/colors/get?tag=<TAG>&embedId=<EMBED_ID>&embedUserId=<EMBED_USER_ID>")
req = Net::HTTP::Get.new(uri)
req["Authorization"] = "Bearer <ORSHOT_API_KEY>"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

Overview#

This endpoint allows you to retrieve a list of saved brand colors from your workspace. Brand colors can be used across your templates and designs for consistent branding.

Endpoint

https://api.orshot.com/v1/brand-assets/colors/get

Query Parameters#

Parameter	Type	Required	Description
`tag`	String	No	Comma-separated list of tags to filter by. Returns only colors that have all specified tags.
`embedId`	String	No	Embed instance ID. Pair with `embedUserId` to scope this call to one embed user
`embedUserId`	String	No	The same `userId` your app passes to the embed URL. Requires `embedId`

Request#

JavaScript

await fetch("https://api.orshot.com/v1/brand-assets/colors/get", {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
});

JavaScript

await fetch("https://api.orshot.com/v1/brand-assets/colors/get?tag=primary,brand", {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
});

JSON

{
  "data": [
    {
      "id": 123,
      "created_at": "2025-09-10T15:30:45.123Z",
      "type": "hex",
      "value": "#FF5733",
      "tags": ["primary", "brand"],
      "workspace_id": 50,
      "user_id": "abcdef01-2345-6789-abcd-ef0123456789"
    },
    {
      "id": 124,
      "created_at": "2025-09-10T14:20:30.456Z",
      "type": "gradient",
      "value": "linear-gradient(135deg, #667eea 0%, #764ba2 100%)",
      "tags": ["brand"],
      "workspace_id": 50,
      "user_id": "abcdef01-2345-6789-abcd-ef0123456789"
    }
  ]
}

Pass embedId and embedUserId together to return only that embed user's colors instead of the whole workspace palette. This is how one embed serves many brands or tenants, each with its own brand space.

Omit them and this endpoint behaves exactly as documented above. See Per-User Brand Assets for the full picture.

Rate Limits#

30 requests per minute per endpoint

Response Fields#

Field	Type	Description
`id`	Number	Unique identifier for the color
`created_at`	String	Timestamp when the color was saved
`type`	String	Color type: `hex`, `rgb`, `hsl`, or `gradient`
`value`	String	The color value (e.g., `#FF5733`, `rgb(255, 87, 51)`)
`tags`	String[]	Tags associated with the color
`workspace_id`	Number	ID of the workspace the color belongs to
`user_id`	String	ID of the user who saved the color

Was this page helpful?

Ready to automate?

Start rendering images, PDFs and videos from your templates in under 2 minutes. Free plan, no credit card.

Get your API key

Image, PDF and video generation via API
Visual editor with AI and smart layouts
Zapier, Make, MCP and 50+ integrations
White-label embed for your own app
100 free credits a month, no credit card required