Get Entity by Short ID

Retrieve an entity using its short identifier

GET /:projectId/entities/by-short-id

Get Entity by Short ID

cURL

curl --request GET \
  --url https://api.replyke.com/api/v6/:projectId/entities/by-short-id

200

{
  "id": "<string>",
  "shortId": "<string>",
  "title": "<string>",
  "content": "<string>",
  "userId": "<string>",
  "keywords": [
    {}
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Retrieves a single entity using its shortId. Publicly accessible.

Query Parameters

shortId · string · required

The short identifier of the entity

Response

id · string

Unique entity identifier

shortId · string

Short identifier for easy sharing

title · string

Entity title

content · string

Entity content

userId · string

ID of the user who created the entity

keywords · array

Array of keywords

createdAt · string

Creation timestamp in ISO 8601 format

updatedAt · string

Last update timestamp in ISO 8601 format

Error Responses

Missing Short ID - 400 Bad Request

{
  "error": "Missing shortId in request query.",
  "code": "entity/invalid-query-params"
}

Not Found - 404 Not Found

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

Server Error - 500 Internal Server Error

{
  "error": "Internal server error.",
  "code": "entity/server-error",
  "details": "<Error message>"
}

---

Notes

• No authentication is required.
• The shortId is typically used for easily shareable or user-friendly URLs.