Embed Links
Short-lived, revocable, read-only links for rendering one Node as standalone content or in a third-party iframe.
Authorization
bearerAuth API key authentication. Get your API key from the dashboard.
In: header
Query Parameters
Which kind of target the links point at. Omitting it returns links of every kind.
Value in
- "node"
- "change-request"
- "record-detail"
The target's id, interpreted according to type.
1 <= lengthResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/embed-links"[ { "id": "string", "type": "node", "typeId": "string", "targetName": "string", "nodeType": "base", "createdAt": "2019-08-24T14:15:22Z", "expiresAt": "2019-08-24T14:15:22Z", "revokedAt": "2019-08-24T14:15:22Z", "active": true, "framePolicy": { "mode": "anywhere", "allowedOrigins": [ "http://example.com" ] } }]Authorization
bearerAuth API key authentication. Get your API key from the dashboard.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/embed-links" \ -H "Content-Type: application/json" \ -d '{ "type": "node", "typeId": "string" }'{ "id": "string", "type": "node", "typeId": "string", "targetName": "string", "nodeType": "base", "createdAt": "2019-08-24T14:15:22Z", "expiresAt": "2019-08-24T14:15:22Z", "revokedAt": "2019-08-24T14:15:22Z", "active": true, "framePolicy": { "mode": "anywhere", "allowedOrigins": [ "http://example.com" ] }, "url": "http://example.com", "iframeUrl": "http://example.com"}Authorization
bearerAuth API key authentication. Get your API key from the dashboard.
In: header
Path Parameters
1 <= lengthResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/api/v1/embed-links/string"{ "revoked": true}