Fetch Entity

Get a single entity by its Sublay ID

GET /:projectId/api/v7/entities/:entityId

Fetch Entity

cURL

curl --request GET \
  --url https://api.sublay.io/api/v6/:projectId/api/v7/entities/:entityId

Returns a single entity by its Sublay UUID. Always returns the entity regardless of moderation status, so the client can display the appropriate moderation state. Drafts are only returned to their author (or with a service/master key).

Path Parameters

entityId · string · required

The UUID of the entity to fetch.

Query Parameters

include · string

Comma-separated list of associations to include:

• user — the author’s user profile
• space — the space the entity belongs to
• topComment — the highest-voted comment
• saved — whether the authenticated user has saved this entity (requires auth)
• files — uploaded file/image attachments

Space-scoped reputation

This endpoint has a space in context, so it accepts the opt-in reputation params. They add a spaceReputation field to the populated author user, alongside the always-present reputation total. Requires the reputation bundle. See the Reputation data model for the full contract.

spaceReputationId · string

Adds spaceReputation to each returned user. One of: a space <uuid> (that space’s bucket), none (the project-general bucket), or context (the space derived from this request’s context — per-row on lists). The empty string and the legacy general / null aliases are rejected (400). Missing buckets read as 0.

spaceReputationDescendants · boolean

Only honored with an explicit space <uuid>. When true, spaceReputation is the subtree sum — the space plus all of its descendants (the root space’s own bucket included). Ignored for none; not allowed with context.

Response

Returns an Entity object.

Error Responses

Not Found — 404

{ "error": "Entity not found", "code": "entity/not-found" }

Also returned for draft entities when the requester is not the author.