Excalidraw

App · 25 actions

Connect Excalidraw to automate images and design workflows.

Actions

ActionWhat it does
Create collectionCreate collection.
Create collection sceneCreate collection scene.
Create inviteCreate invite.
Create sceneCreate scene.
Delete collectionDelete collection.
Delete inviteDelete invite.
Delete sceneDelete scene.
Get collectionGet collection.
Get inviteGet invite.
Get sceneGet scene.
Get scene contentGet scene content.
Get workspaceGet workspace.
Get workspace userGet workspace user.
List collection scenesList collection scenes.
List collectionsList collections.
List invitesList invites.
List scenesList scenes.
List workspace usersList workspace users.
Patch scene contentPatch scene content.
Remove workspace userRemove workspace user.
Replace scene contentReplace scene content.
Update collectionUpdate collection.
Update sceneUpdate scene.
Update workspaceUpdate workspace.
Update workspace userUpdate workspace user.

Create collection

Create collection.

Inputs

NamenametextRequired
Name to use for this request.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "created": "example",
    "id": "example-id",
    "name": "Example",
    "updated": "example"
  }
}

Create collection scene

Create collection scene.

Inputs

Collectioncollection_idtextRequired
Collection id to use for this request.
NamenametextRequired
Name to use for this request.
Pinnedpinnedtrue/falseRequired
Pinned to use for this request.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "metadata": {
      "collection": "example",
      "created": "example",
      "id": "example-id",
      "name": "Example",
      "pinned": false,
      "updated": "example"
    }
  }
}

Create invite

Create invite.

Inputs

EmailemailtextRequired
Email to use for this request.
RoleroletextRequired
Role to use for this request.One of: member, admin.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "id": "example-id",
    "name": "Example"
  }
}

Create scene

Create scene.

Inputs

NamenametextRequired
Name to use for this request.
Pinnedpinnedtrue/falseRequired
Pinned to use for this request.
Collectioncollection_idtextRequired
Collection id to use for this request.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "metadata": {
      "collection": "example",
      "created": "example",
      "id": "example-id",
      "name": "Example",
      "pinned": false,
      "updated": "example"
    }
  }
}

Delete collection

Delete collection.

Inputs

Collectioncollection_idtextRequired
Collection id to use for this request.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "created": "example",
    "id": "example-id",
    "name": "Example",
    "updated": "example"
  }
}

Delete invite

Delete invite.

Inputs

Invite idinvite_idtextRequired
Invite id to use for this request.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "id": "example-id",
    "name": "Example"
  }
}

Delete scene

Delete scene.

Inputs

Scene idscene_idtextRequired
Scene id to use for this request.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "metadata": {
      "collection": "example",
      "created": "example",
      "id": "example-id",
      "name": "Example",
      "pinned": false,
      "updated": "example"
    }
  }
}

Get collection

Get collection.

Inputs

Collectioncollection_idtextRequired
Collection id to use for this request.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "created": "example",
    "id": "example-id",
    "name": "Example",
    "updated": "example"
  }
}

Get invite

Get invite.

Inputs

Invite idinvite_idtextRequired
Invite id to use for this request.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "id": "example-id",
    "name": "Example"
  }
}

Get scene

Get scene.

Inputs

Scene idscene_idtextRequired
Scene id to use for this request.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "metadata": {
      "collection": "example",
      "created": "example",
      "id": "example-id",
      "name": "Example",
      "pinned": false,
      "updated": "example"
    }
  }
}

Get scene content

Get scene content.

Inputs

Scene idscene_idtextRequired
Scene id to use for this request.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "appState": {
      "viewBackgroundColor": "example"
    },
    "elements": [],
    "files": {}
  }
}

Get workspace

Get workspace.

Inputs

None.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "id": "example-id",
    "name": "Example"
  }
}

Get workspace user

Get workspace user.

Inputs

Membermember_idtextRequired
Member id to use for this request.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "id": "example-id",
    "name": "Example"
  }
}

List collection scenes

List collection scenes.

Inputs

Collectioncollection_idtextRequired
Collection id to use for this request.
Limitlimitnumber
Limit to use for this request.From 1 to 100.
Offsetoffsetnumber
Offset to use for this request.At least 0.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "data": [],
    "hasNextPage": false
  }
}

List collections

List collections.

Inputs

Limitlimitnumber
Limit to use for this request.From 1 to 100.
Offsetoffsetnumber
Offset to use for this request.At least 0.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "data": [],
    "hasNextPage": false
  }
}

List invites

List invites.

Inputs

Limitlimitnumber
Limit to use for this request.From 1 to 100.
Offsetoffsetnumber
Offset to use for this request.At least 0.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "data": [],
    "hasNextPage": false
  }
}

List scenes

List scenes.

Inputs

Limitlimitnumber
Limit to use for this request.From 1 to 100.
Offsetoffsetnumber
Offset to use for this request.At least 0.
Collectioncollection_idtext
Collection id to use for this request.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "data": [],
    "hasNextPage": false
  }
}

List workspace users

List workspace users.

Inputs

Limitlimitnumber
Limit to use for this request.From 1 to 100.
Offsetoffsetnumber
Offset to use for this request.At least 0.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "data": [],
    "hasNextPage": false
  }
}

Patch scene content

Patch scene content.

Inputs

Scene idscene_idtextRequired
Scene id to use for this request.
Elementselementslist
Elements to use for this request.
App stateapp_stateobject
App state to use for this request.
Filesfilesobject
Files to use for this request.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "appState": {
      "viewBackgroundColor": "example"
    },
    "elements": [],
    "files": {}
  }
}

Remove workspace user

Remove workspace user.

Inputs

Membermember_idtextRequired
Member id to use for this request.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "id": "example-id",
    "name": "Example"
  }
}

Replace scene content

Replace scene content.

Inputs

Scene idscene_idtextRequired
Scene id to use for this request.
ElementselementslistRequired
Elements to use for this request.
App stateapp_stateobject
App state to use for this request.
Filesfilesobject
Files to use for this request.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "appState": {
      "viewBackgroundColor": "example"
    },
    "elements": [],
    "files": {}
  }
}

Update collection

Update collection.

Inputs

Collectioncollection_idtextRequired
Collection id to use for this request.
NamenametextRequired
Name to use for this request.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "created": "example",
    "id": "example-id",
    "name": "Example",
    "updated": "example"
  }
}

Update scene

Update scene.

Inputs

Scene idscene_idtextRequired
Scene id to use for this request.
Namenametext
Name to use for this request.
Pinnedpinnedtrue/false
Pinned to use for this request.
Collectioncollection_idtext
Collection id to use for this request.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "metadata": {
      "collection": "example",
      "created": "example",
      "id": "example-id",
      "name": "Example",
      "pinned": false,
      "updated": "example"
    }
  }
}

Update workspace

Update workspace.

Inputs

Namenametext
Name to use for this request.
Picturepicturetext
Picture to use for this request.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "id": "example-id",
    "name": "Example"
  }
}

Update workspace user

Update workspace user.

Inputs

Membermember_idtextRequired
Member id to use for this request.
Namenametext
Name to use for this request.
Roleroletext
Role to use for this request.One of: member, admin.

Outputs

Result returned by the service.

responseobject
Complete service response, including pagination.
Example output
{
  "response": {
    "id": "example-id",
    "name": "Example"
  }
}

On this page