Skroll API: Brands

3 endpoints for working with brands.

get/brandslist_brands

Lists the organization's brands. A brand is optional when creating a skroll; use a brand id only when the skroll should follow a captured brand book.

curl

curl -X GET https://skrollai.com/api/v1/brands \
  -H "Authorization: Bearer sk_..."

200Brands, newest first

Array of Brand

Field	Type	Description
id*	string (uuid)	n/a
name*	string	n/a
sourceUrl*	string	Website the brand was extracted from
createdAt*	string (date-time)	n/a
updatedAt*	string (date-time)	n/a

401Missing, malformed, unknown or revoked credentials

403The key's creator lacks access

422Input failed validation

429Rate limit exceeded. See the Retry-After header

500Unexpected server error

get/brands/{id}get_brand

Returns a brand including its full brand book (palette, typography, voice, imagery).

curl

curl -X GET https://skrollai.com/api/v1/brands/0b1e0f7c-1c3f-4a0e-9f5a-1a2b3c4d5e6f \
  -H "Authorization: Bearer sk_..."

Parameter	In	Type	Description
id*	path	string (uuid)	n/a

200The brand

401Missing, malformed, unknown or revoked credentials

403The key's creator lacks access

404Resource not found

422Input failed validation

429Rate limit exceeded. See the Retry-After header

500Unexpected server error

delete/brands/{id}delete_brand

Deletes a brand. Fails with 409 if any skroll still uses it.

curl

curl -X DELETE https://skrollai.com/api/v1/brands/0b1e0f7c-1c3f-4a0e-9f5a-1a2b3c4d5e6f \
  -H "Authorization: Bearer sk_..."

Parameter	In	Type	Description
id*	path	string (uuid)	n/a

200Deleted

Deleted

Field	Type	Description
deleted*	true	n/a

401Missing, malformed, unknown or revoked credentials

403The key's creator lacks access

404Resource not found

409Brand is still used by existing skrolls

422Input failed validation

429Rate limit exceeded. See the Retry-After header

500Unexpected server error