Workspace

organization.workspace.add_app(organization_id, workspace_id, app_id)

Adds a PlaidCloud registered app to a workspace for use

Parameters
  • organization_id (str) – Unique organization identifier

  • workspace_id (str) – Unique workspace identifier

  • app_id (str) – Unique app identifier

Returns

None

organization.workspace.add_label(organization_id, worspace_id, label)

Sets a label on a workspace

Parameters
  • organization_id (str) – Unique organization identifier

  • workspace_id (str) – Unique workspace identifier

  • label (str) – The label unique name

Returns

None

organization.workspace.apps(organization_id, workspace_id)

Provides a list of registered apps with the workspace

Parameters
  • organization_id (str) – Unique organization identifier

  • workspace_id (str) – Unique workspace identifier

Returns

None

organization.workspace.copy(organization_id, workspace_id, rollup_id, after_position)

Copies a workspace

Parameters
  • organization_id (str) – Unique organization identifier

  • workspace_id (str) – Unique workspace identifier

  • rollup_id (str) – Unique rollup identifier

  • after_position (int) – Position within the object rollup the object should be placed after

Returns

None

organization.workspace.create(organization_id, rollup_id, name, memo)

Creates a workspace within an organization

Parameters
  • organization_id (str) – Unique organization identifier

  • rollup_id (str) – Unique rollup identifier

  • name (str) – The object name

  • memo (str) – The object description

Returns

None

organization.workspace.create_label(organization_id, worspace_id, name)

Creates a workspace label

Parameters
  • organization_id (str) – Unique organization identifier

  • worspace_id (str) – Unique workspace identifier

  • name (str) – The object name

Returns

None

organization.workspace.create_rollup(organization_id, rollup_id, position, name)

Creates a folder in the workspace hierarchy

Parameters
  • organization_id (str) – Unique organization identifier

  • rollup_id (str) – Unique rollup identifier

  • position (int) – The position order of the object within the rollup

  • name (str) – The object name

Returns

None

organization.workspace.delete(organization_id, workspace_id)

Deletes a workspace and all associated projects, workflows, data, etc…

Parameters
  • organization_id (str) – Unique organization identifier

  • workspace_id (str) – Unique workspace identifier

Returns

None

organization.workspace.delete_label(organization_id, worspace_id, label)

Deletes a workspace label

Parameters
  • organization_id (str) – Unique organization identifier

  • workspace_id (str) – Unique workspace identifier

  • label (str) – The label unique name

Returns

None

organization.workspace.delete_rollup(organization_id, workspace_id)

Deletes a folder and its contents in the workspace hierarchy

Parameters
  • organization_id (str) – Unique organization identifier

  • workspace_id (str) – Unique workspace identifier

  • rollup_id (int) – Unique rollup identifier

Returns

None

organization.workspace.disable(organization_id, workspace_id)

Set the workspace to disabled to prevent usage and access

Parameters
  • organization_id (str) – Unique organization identifier

  • workspace_id (str) – Unique workspace identifier

Returns

None

organization.workspace.enable(organization_id, workspace_id)

Sets the workspace to enabled to allow access

Parameters
  • organization_id (str) – Unique organization identifier

  • workspace_id (str) – Unique workspace identifier

Returns

None

organization.workspace.get_welcome_message()

Gets the current welcome email message for new members

Returns

welcome message text

Return type

str

organization.workspace.id_from_path(organization_id, path)

Provides the cannonical id for the from a provided path

Parameters
  • organization_id (str) – Unique organization identifier

  • path (str) – Object rollup path using unix style forward slashes

Returns

None

organization.workspace.labels(organization_id)

Provides a list of labels for workspaces

Parameters

organization_id (str) – Unique organization identifier

Returns

None

organization.workspace.make_rollups(organization_id, workspace_id)

Creates the path and all intermediate rollup points

Parameters
  • organization_id (str) – Unique organization identifier

  • workspace_id (str) – Unique workspace identifier

  • path (str) – Object rollup path using unix style forward slashes

Returns

None

organization.workspace.move(organization_id, workspace_id, rollup_id, after_position)

Moves a workspace in the hierarchy

Parameters
  • organization_id (str) – Unique organization identifier

  • workspace_id (str) – Unique workspace identifier

  • rollup_id (str) – Unique rollup identifier

  • after_position (int) – Position within the object rollup the object should be placed after

Returns

None

organization.workspace.paths_from_id(organization_id, workspace_id)

Provides a list of paths associated with the cannonical id

Parameters
  • organization_id (str) – Unique organization identifier

  • workspace_id (str) – Unique workspace identifier

Returns

None

organization.workspace.remove_app(organization_id, workspace_id, app_id)

Removes registered PlaidCloud app from the workspace

Parameters
  • organization_id (str) – Unique organization identifier

  • workspace_id (str) – Unique workspace identifier

  • app_id (str) – Unique app identifier

Returns

None

organization.workspace.remove_label(organization_id, worspace_id, label)

Removes a label on a workspace

Parameters
  • organization_id (str) – Unique organization identifier

  • workspace_id (str) – Unique workspace identifier

  • label (str) – The label unique name

Returns

None

organization.workspace.search_by_label(organization_id, workspace_id, text, criteria='contains')

Returns list of workspaces that match the search criteria

Parameters
  • organization_id (str) – Unique organization identifier

  • workspace_id (str) – Unique workspace identifier

  • text (str) – The search text to locate

  • criteria (str) – The search criteria (contains, exact, startswith, or endswith)

Returns

None

organization.workspace.search_by_name(organization_id, workspace_id, text, criteria='contains')

Returns list of workspaces that match the search criteria

Parameters
  • organization_id (str) – Unique organization identifier

  • workspace_id (str) – Unique workspace identifier

  • text (str) – The search text to locate

  • criteria (str) – The search criteria (contains, exact, startswith, or endswith)

Returns

None

organization.workspace.set_welcome_message(message)

Sets the welcome email message for new members

Parameters

message (str) – The new welcome message

Returns

None

organization.workspace.update(organization_id, workspace_id, **kwargs)

Updates a workspace name and memo

Parameters
  • organization_id (str) – Unique organization identifier

  • workspace_id (str) – Unique workspace identifier

Kwargs:

name (str): The object name memo (str): The object description

Returns

None

organization.workspace.update_label(organization_id, worspace_id, label, name)

Creates a workspace label

Parameters
  • organization_id (str) – Unique organization identifier

  • workspace_id (str) – Unique workspace identifier

  • label (str) – The label unique name

  • name (str) – The object name

Returns

None

organization.workspace.update_rollup(organization_id, workspace_id, **kwargs)

Updates a folder name in the workspace hierarchy

Parameters
  • organization_id (str) – Unique organization identifier

  • workspace_id (str) – Unique workspace identifier

Kwargs:

rollup_id (str): Unique rollup identifier position (int): The position order of the object within the rollup name (str): The object name

Returns

None

organization.workspace.workspace(organization_id, workspace_id)

Provides detailed information about the workspace

Parameters
  • organization_id (str) – Unique organization identifier

  • workspace_id (str) – Unique workspace identifier

Returns

None

organization.workspace.workspaces(organization_id, id_filter=None)

Provides a list of workspaces within the specified organization

Parameters
  • organization_id (str) – Unique organization identifier

  • id_filter (list) – List or tuple of object unique identifiers to which to limit the results

Returns

None

organization.workspace.workspaces_from_labels(organization_id, labels)

Provides list of workspaces for based on set of labels. Uses AND condition.

Parameters
  • organization_id (str) – Unique organization identifier

  • labels (list) – List or tuple of label unique names

Returns

None

organization.workspace.workspaces_from_path(organization_id, path)

Provides list of workspaces based on a path fragment. Path fragment can be to parent level.

Parameters
  • organization_id (str) – Unique organization identifier

  • path (str) – Object rollup path using unix style forward slashes

Returns

None