Public Projects

List projects

Authorization

apiKey

x-api-key<token>

In: header

Query Parameters

cursor?string

Pagination cursor from a previous response.

limit?integer

Maximum number of projects to return.

Default20

Range1 <= value <= 100

Response Body

`application/json`

curl -X GET "https://loading/api/public/v1/projects"

{
  "projects": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "pid": "string",
      "name": "string",
      "theme": "default",
      "pageLayersScrollable": true,
      "pageAspectRatio": "16:9",
      "pageGridEnabled": false,
      "pageGridType": "12-column",
      "pageNumbersEnabled": false,
      "linkShareToken": "string",
      "linkAccess": "tenant",
      "linkRole": "owner",
      "publishSlug": null,
      "isPublished": false,
      "publishedAt": null,
      "ogImageUrl": null,
      "publishDescription": null,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "pinnedAt": null,
      "firstPageId": "2f8ddfb6-97dc-4f88-8a30-be55455ab046",
      "members": [
        {
          "id": "string",
          "userId": "string",
          "name": "string",
          "email": "string",
          "avatar": "string",
          "role": {
            "id": "owner",
            "name": "string"
          }
        }
      ]
    }
  ],
  "nextCursor": null,
  "hasMore": false
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

Create a project

Authorization

apiKey

x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

pid?string

name*string

Length1 <= length <= 255

theme?|

pageLayersScrollable?boolean

pageAspectRatio?string

Value in"16:9" | "3:2"

pageGridEnabled?boolean

pageGridType?string

Value in"12-column" | "6x4"

pageNumbersEnabled?boolean

linkShareToken?|

linkAccess?string

Value in"tenant" | "anyone"

linkRole?string

Value in"owner" | "editor" | "content_editor" | "viewer"

pages?array<>

members?array<>

Response Body

`application/json`

curl -X POST "https://loading/api/public/v1/projects" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "pid": "string",
  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  "name": "string",
  "theme": "default",
  "pageLayersScrollable": true,
  "pageAspectRatio": "16:9",
  "pageGridEnabled": false,
  "pageGridType": "12-column",
  "pageNumbersEnabled": false,
  "linkShareToken": "string",
  "linkAccess": "tenant",
  "linkRole": "owner",
  "publishSlug": null,
  "isPublished": false,
  "publishedAt": null,
  "ogImageUrl": null,
  "publishDescription": null,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "pinnedAt": null,
  "pages": [
    {
      "pageBackground": "floating-lines",
      "pageBackgroundColor": "rgba(0, 0, 0, 0)",
      "pageBackgroundAnimatedGradient": null,
      "pageBackgroundSettings": null,
      "presentModeAnimation": "layers-staggered",
      "currentSelectedLayerId": null,
      "currentSelectedLayerType": null,
      "selectedLayoutId": null,
      "layoutSlotOccupancy": {},
      "speakerNotes": "",
      "watermarkEnabled": false,
      "watermarkText": "",
      "watermarkShowOnAllPages": false,
      "layout": [],
      "isPageLayoutLocked": false,
      "hide": false,
      "layerVisibilityDefaults": null,
      "showLayoutBounds": true,
      "fluidLayout": null,
      "narrativeBeat": null,
      "pageTypeId": "string",
      "pageTypeVariantId": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "slug": "string",
      "position": 0
    }
  ],
  "members": [
    {
      "id": "string",
      "userId": "string",
      "name": "string",
      "email": "string",
      "avatar": "string",
      "role": {
        "id": "owner",
        "name": "string"
      }
    }
  ]
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

Get a project by pid

Authorization

apiKey

x-api-key<token>

In: header

Path Parameters

pid*string

Response Body

`application/json`

curl -X GET "https://loading/api/public/v1/projects/string"

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "pid": "string",
  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  "name": "string",
  "theme": "default",
  "pageLayersScrollable": true,
  "pageAspectRatio": "16:9",
  "pageGridEnabled": false,
  "pageGridType": "12-column",
  "pageNumbersEnabled": false,
  "linkShareToken": "string",
  "linkAccess": "tenant",
  "linkRole": "owner",
  "publishSlug": null,
  "isPublished": false,
  "publishedAt": null,
  "ogImageUrl": null,
  "publishDescription": null,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "pinnedAt": null,
  "pages": [
    {
      "pageBackground": "floating-lines",
      "pageBackgroundColor": "rgba(0, 0, 0, 0)",
      "pageBackgroundAnimatedGradient": null,
      "pageBackgroundSettings": null,
      "presentModeAnimation": "layers-staggered",
      "currentSelectedLayerId": null,
      "currentSelectedLayerType": null,
      "selectedLayoutId": null,
      "layoutSlotOccupancy": {},
      "speakerNotes": "",
      "watermarkEnabled": false,
      "watermarkText": "",
      "watermarkShowOnAllPages": false,
      "layout": [],
      "isPageLayoutLocked": false,
      "hide": false,
      "layerVisibilityDefaults": null,
      "showLayoutBounds": true,
      "fluidLayout": null,
      "narrativeBeat": null,
      "pageTypeId": "string",
      "pageTypeVariantId": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "slug": "string",
      "position": 0
    }
  ],
  "members": [
    {
      "id": "string",
      "userId": "string",
      "name": "string",
      "email": "string",
      "avatar": "string",
      "role": {
        "id": "owner",
        "name": "string"
      }
    }
  ]
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

Update a project

Authorization

apiKey

x-api-key<token>

In: header

Path Parameters

pid*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Length1 <= length <= 255

theme?|

pageLayersScrollable?boolean

pageAspectRatio?string

Value in"16:9" | "3:2"

pageGridEnabled?boolean

pageGridType?string

Value in"12-column" | "6x4"

pageNumbersEnabled?boolean

linkShareToken?|

linkAccess?string

Value in"tenant" | "anyone"

linkRole?string

Value in"owner" | "editor" | "content_editor" | "viewer"

isPublished?boolean

publishDescription?|

pages?array<>

members?array<>

Response Body

`application/json`

curl -X PATCH "https://loading/api/public/v1/projects/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "pid": "string",
  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  "name": "string",
  "theme": "default",
  "pageLayersScrollable": true,
  "pageAspectRatio": "16:9",
  "pageGridEnabled": false,
  "pageGridType": "12-column",
  "pageNumbersEnabled": false,
  "linkShareToken": "string",
  "linkAccess": "tenant",
  "linkRole": "owner",
  "publishSlug": null,
  "isPublished": false,
  "publishedAt": null,
  "ogImageUrl": null,
  "publishDescription": null,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "pinnedAt": null,
  "pages": [
    {
      "pageBackground": "floating-lines",
      "pageBackgroundColor": "rgba(0, 0, 0, 0)",
      "pageBackgroundAnimatedGradient": null,
      "pageBackgroundSettings": null,
      "presentModeAnimation": "layers-staggered",
      "currentSelectedLayerId": null,
      "currentSelectedLayerType": null,
      "selectedLayoutId": null,
      "layoutSlotOccupancy": {},
      "speakerNotes": "",
      "watermarkEnabled": false,
      "watermarkText": "",
      "watermarkShowOnAllPages": false,
      "layout": [],
      "isPageLayoutLocked": false,
      "hide": false,
      "layerVisibilityDefaults": null,
      "showLayoutBounds": true,
      "fluidLayout": null,
      "narrativeBeat": null,
      "pageTypeId": "string",
      "pageTypeVariantId": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "slug": "string",
      "position": 0
    }
  ],
  "members": [
    {
      "id": "string",
      "userId": "string",
      "name": "string",
      "email": "string",
      "avatar": "string",
      "role": {
        "id": "owner",
        "name": "string"
      }
    }
  ]
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

Delete a project

Authorization

apiKey

x-api-key<token>

In: header

Path Parameters

pid*string

Response Body

`application/json`

curl -X DELETE "https://loading/api/public/v1/projects/string"

Empty

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

200application/json

400application/json

401application/json

403application/json

429application/json

500application/json

201application/json

400application/json

401application/json

403application/json

429application/json

500application/json

200application/json

401application/json

403application/json

404application/json

429application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

204

401application/json

403application/json

404application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`