Skip to content
Dashboard
API Reference

Shared Stores ​

Store reusable organization data and keep it synchronized through the API.

Shared stores are organization-scoped collections of reusable records. Certain Mosaic tiles can use these records when processing content.

Each entry has:

  • A stable entry_id that you choose.
  • A human-readable display_name.
  • A metadata JSON object for your own structured fields.

All endpoints use your Mosaic API key and are automatically scoped to its organization.

bash
curl "https://api.mosaic.so/shared-stores" \
  -H "Authorization: Bearer mk_your_api_key"

Limits ​

ResourceLimit
Shared stores per organization10
Entries per shared store10,000
Entries per bulk request5,000
Metadata per entry256 KB

Creating a resource beyond a store or entry limit returns 409 Conflict with a stable error code and the applicable limit.

IDs ​

Mosaic generates the UUID returned as store.id. Use that UUID as {store_id} in store and entry endpoint paths.

You provide each entry's entry_id. Entry IDs must be unique within their store and remain the lookup key for API updates.

Data types ​

Store object ​

FieldTypePossible values
idUUID stringMosaic-generated store ID.
namestringAny non-empty display name after surrounding whitespace is removed.
source_typestringmanual by default, or another non-empty caller-supplied source label. This is not an enum.
created_atISO 8601 stringUTC creation timestamp.
updated_atISO 8601 stringUTC last-update timestamp.

Entry object ​

FieldTypePossible values
entry_idstringAny non-empty, store-scoped ID supplied by you. URL-encode it when used in a path.
display_namestringAny non-empty human-readable label after surrounding whitespace is removed.
metadataJSON object{} or an object up to 256 KB. Keys are strings; values may be any JSON value, including nested objects, arrays, strings, numbers, booleans, and null. The field itself is never null.
created_atISO 8601 stringUTC creation timestamp. Replacing an entry preserves its original creation timestamp.

Common error responses ​

Authentication errors use a detail field:

json
{ "detail": "invalid_api_key" }
Statusdetail valueMeaning
401 UnauthorizedAuthorization header must start with BearerThe header is missing or does not use Bearer.
401 Unauthorizedinvalid_api_keyThe key is malformed, unknown, or revoked.
401 UnauthorizedAPI key must be associated with an organizationThe key has no organization scope.
403 Forbiddenapi_access_requiredThe organization does not have API access.

Endpoint validation and operational errors use the payloads documented on each endpoint page. A 500 Internal Server Error has an error string describing the failed operation; clients should treat any 500 as retryable only according to their own retry policy.

Endpoints ​

Use the endpoint pages in the left navigation for request bodies, responses, and errors.