Yapper Docs
Api reference
GET
/links

A web app link to give the user for a page outside any session: view=elements (the element library; with element, an id or @ID like @hero or @hero:coat-on, that element opens on that image) or view=library (the asset library; with libraryFolderId, filtered to that Library folder). Session pages are GET /sessions/{sessionId}/links. Naming an element or a Library folder needs assets:read.

Authorization

bearerAuth processes:read
AuthorizationBearer <token>

In: header

Scope: processes:read

Query Parameters

view?string
Default"elements"

Value in

  • "elements"
  • "library"
element?string
libraryFolderId?string

view=library only: a Library folder (GET /library/folders) to open filtered to.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/links"
{  "view": "elements",  "url": "http://example.com",  "element": {    "id": "string",    "tag": "string"  },  "libraryFolder": {    "id": "string",    "name": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}