Files
a2a-platform 81e94a55c6 deploy
2026-06-27 01:02:44 +00:00

30 KiB

name, description
name description
accounts-5-routes Handle 75 OpenAPI operation(s) under /v2.1/accounts for the accounts 5 route group.

accounts 5 API Routes

Handle 75 OpenAPI operation(s) under /v2.1/accounts for the accounts 5 route group.

Use the generated operation tools to make real API calls. Do not invent API responses. If a tool reports missing setup, return the exact setup field name to the caller. For write, update, or delete operations, state the intended action before calling the tool.

Operations

recipients_put_template_recipients_document_visibility

  • Operation ID: recipients_put_template_recipients_document_visibility
  • Route: PUT /v2.1/accounts/{accountId}/templates/{templateId}/recipients/document_visibility
  • Mode: WRITE
  • Summary: Updates document visibility for template recipients
  • Parameters:
    • accountId in path required
    • templateId in path required
  • Body: JSON request body accepted.

responsive_html_post_template_responsive_html_preview

  • Operation ID: responsive_html_post_template_responsive_html_preview
  • Route: POST /v2.1/accounts/{accountId}/templates/{templateId}/responsive_html_preview
  • Mode: WRITE
  • Summary: Creates a preview of the responsive versions of all of the documents associated with a template.
  • Parameters:
    • accountId in path required
    • templateId in path required
  • Body: JSON request body accepted.

views_post_template_edit_view

  • Operation ID: views_post_template_edit_view
  • Route: POST /v2.1/accounts/{accountId}/templates/{templateId}/views/edit
  • Mode: WRITE
  • Summary: Gets a URL for a template edit view.
  • Parameters:
    • accountId in path required
    • templateId in path required
  • Body: JSON request body accepted.

views_post_template_recipient_preview

  • Operation ID: views_post_template_recipient_preview
  • Route: POST /v2.1/accounts/{accountId}/templates/{templateId}/views/recipient_preview
  • Mode: WRITE
  • Summary: Creates a template recipient preview.
  • Parameters:
    • accountId in path required
    • templateId in path required
  • Body: JSON request body accepted.

template_workflow_definition_get_template_workflow_definition

  • Operation ID: template_workflow_definition_get_template_workflow_definition
  • Route: GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow
  • Mode: READ
  • Summary: Returns the workflow definition for a template.
  • Parameters:
    • accountId in path required
    • templateId in path required

template_workflow_definition_put_template_workflow_definition

  • Operation ID: template_workflow_definition_put_template_workflow_definition
  • Route: PUT /v2.1/accounts/{accountId}/templates/{templateId}/workflow
  • Mode: WRITE
  • Summary: Updates the workflow definition for a template.
  • Parameters:
    • accountId in path required
    • templateId in path required
  • Body: JSON request body accepted.

template_workflow_definition_delete_template_workflow_definition

  • Operation ID: template_workflow_definition_delete_template_workflow_definition
  • Route: DELETE /v2.1/accounts/{accountId}/templates/{templateId}/workflow
  • Mode: WRITE
  • Summary: Delete the workflow definition for a template.
  • Parameters:
    • accountId in path required
    • templateId in path required

template_workflow_scheduled_sending_get_template_scheduled_sending_definition

  • Operation ID: template_workflow_scheduled_sending_get_template_scheduled_sending_definition
  • Route: GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending
  • Mode: READ
  • Summary: Returns the scheduled sending rules for a template's workflow definition.
  • Parameters:
    • accountId in path required
    • templateId in path required

template_workflow_scheduled_sending_put_template_scheduled_sending_definition

  • Operation ID: template_workflow_scheduled_sending_put_template_scheduled_sending_definition
  • Route: PUT /v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending
  • Mode: WRITE
  • Summary: Updates the scheduled sending rules for a template's workflow definition.
  • Parameters:
    • accountId in path required
    • templateId in path required
  • Body: JSON request body accepted.

template_workflow_scheduled_sending_delete_template_scheduled_sending_definition

  • Operation ID: template_workflow_scheduled_sending_delete_template_scheduled_sending_definition
  • Route: DELETE /v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending
  • Mode: WRITE
  • Summary: Deletes the scheduled sending rules for the template's workflow.
  • Parameters:
    • accountId in path required
    • templateId in path required

template_workflow_step_post_template_workflow_step_definition

  • Operation ID: template_workflow_step_post_template_workflow_step_definition
  • Route: POST /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps
  • Mode: WRITE
  • Summary: Adds a new step to a template's workflow.
  • Parameters:
    • accountId in path required
    • templateId in path required
  • Body: JSON request body accepted.

template_workflow_step_get_template_workflow_step_definition

  • Operation ID: template_workflow_step_get_template_workflow_step_definition
  • Route: GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}
  • Mode: READ
  • Summary: Returns a specified workflow step for a specified envelope.
  • Parameters:
    • accountId in path required
    • templateId in path required
    • workflowStepId in path required

template_workflow_step_put_template_workflow_step_definition

  • Operation ID: template_workflow_step_put_template_workflow_step_definition
  • Route: PUT /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}
  • Mode: WRITE
  • Summary: Updates a specified workflow step for a template.
  • Parameters:
    • accountId in path required
    • templateId in path required
    • workflowStepId in path required
  • Body: JSON request body accepted.

template_workflow_step_delete_template_workflow_step_definition

  • Operation ID: template_workflow_step_delete_template_workflow_step_definition
  • Route: DELETE /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}
  • Mode: WRITE
  • Summary: Deletes a workflow step from an template's workflow definition.
  • Parameters:
    • accountId in path required
    • templateId in path required
    • workflowStepId in path required

template_workflow_delayed_routing_get_template_delayed_routing_definition

  • Operation ID: template_workflow_delayed_routing_get_template_delayed_routing_definition
  • Route: GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting
  • Mode: READ
  • Summary: Returns the delayed routing rules for a template's workflow step definition.
  • Parameters:
    • accountId in path required
    • templateId in path required
    • workflowStepId in path required

template_workflow_delayed_routing_put_template_delayed_routing_definition

  • Operation ID: template_workflow_delayed_routing_put_template_delayed_routing_definition
  • Route: PUT /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting
  • Mode: WRITE
  • Summary: Updates the delayed routing rules for a template's workflow step.
  • Parameters:
    • accountId in path required
    • templateId in path required
    • workflowStepId in path required
  • Body: JSON request body accepted.

template_workflow_delayed_routing_delete_template_delayed_routing_definition

  • Operation ID: template_workflow_delayed_routing_delete_template_delayed_routing_definition
  • Route: DELETE /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting
  • Mode: WRITE
  • Summary: Deletes the delayed routing rules for the specified template workflow step.
  • Parameters:
    • accountId in path required
    • templateId in path required
    • workflowStepId in path required

templates_auto_match_put_templates

  • Operation ID: templates_auto_match_put_templates
  • Route: PUT /v2.1/accounts/{accountId}/templates/auto_match
  • Mode: WRITE
  • Summary: TemplatesAutoMatch_PutTemplates
  • Parameters:
    • accountId in path required
  • Body: JSON request body accepted.

unsupported_file_types_get_unsupported_file_types

  • Operation ID: unsupported_file_types_get_unsupported_file_types
  • Route: GET /v2.1/accounts/{accountId}/unsupported_file_types
  • Mode: READ
  • Summary: Gets a list of unsupported file types.
  • Parameters:
    • accountId in path required

users_get_users

  • Operation ID: users_get_users
  • Route: GET /v2.1/accounts/{accountId}/users
  • Mode: READ
  • Summary: Retrieves the list of users for the specified account. You can filter the users list to get specific users.
  • Parameters:
    • accountId in path required
    • additional_info in query
    • alternate_admins_only in query
    • count in query
    • domain_users_only in query
    • email in query
    • email_substring in query
    • group_id in query
    • include_license in query
    • include_usersettings_for_csv in query
    • login_status in query
    • not_group_id in query
    • start_position in query
    • status in query
    • user_name_substring in query

users_put_users

  • Operation ID: users_put_users
  • Route: PUT /v2.1/accounts/{accountId}/users
  • Mode: WRITE
  • Summary: Changes one or more users in the specified account.
  • Parameters:
    • accountId in path required
    • allow_all_languages in query
  • Body: JSON request body accepted.

users_post_users

  • Operation ID: users_post_users
  • Route: POST /v2.1/accounts/{accountId}/users
  • Mode: WRITE
  • Summary: Adds new users to the specified account.
  • Parameters:
    • accountId in path required
  • Body: JSON request body accepted.

users_delete_users

  • Operation ID: users_delete_users
  • Route: DELETE /v2.1/accounts/{accountId}/users
  • Mode: WRITE
  • Summary: Closes one or more users in the account.
  • Parameters:
    • accountId in path required
    • delete in query
  • Body: JSON request body accepted.

user_get_user

  • Operation ID: user_get_user
  • Route: GET /v2.1/accounts/{accountId}/users/{userId}
  • Mode: READ
  • Summary: Gets the user information for a specified user using a userId (GUID). To find a user based on their email address, use the list endpoint.
  • Parameters:
    • accountId in path required
    • userId in path required
    • additional_info in query
    • email in query
    • include_license in query

user_put_user

  • Operation ID: user_put_user
  • Route: PUT /v2.1/accounts/{accountId}/users/{userId}
  • Mode: WRITE
  • Summary: Updates user information for the specified user.
  • Parameters:
    • accountId in path required
    • userId in path required
    • allow_all_languages in query
  • Body: JSON request body accepted.

user_authorization_create_user_authorization

  • Operation ID: user_authorization_create_user_authorization
  • Route: POST /v2.1/accounts/{accountId}/users/{userId}/authorization
  • Mode: WRITE
  • Summary: Creates a user authorization.
  • Parameters:
    • accountId in path required
    • userId in path required
  • Body: JSON request body accepted.

user_authorization_get_user_authorization

  • Operation ID: user_authorization_get_user_authorization

  • Route: GET /v2.1/accounts/{accountId}/users/{userId}/authorization/{authorizationId}

  • Mode: READ

  • Summary: Returns the user authorization for a given authorization ID.

  • Parameters:

    • accountId in path required
    • authorizationId in path required
    • userId in path required

user_authorization_update_user_authorization

  • Operation ID: user_authorization_update_user_authorization
  • Route: PUT /v2.1/accounts/{accountId}/users/{userId}/authorization/{authorizationId}
  • Mode: WRITE
  • Summary: Updates the start or end date for a user authorization.
  • Parameters:
    • accountId in path required
    • authorizationId in path required
    • userId in path required
  • Body: JSON request body accepted.

user_authorization_delete_user_authorization

  • Operation ID: user_authorization_delete_user_authorization

  • Route: DELETE /v2.1/accounts/{accountId}/users/{userId}/authorization/{authorizationId}

  • Mode: WRITE

  • Summary: Deletes the user authorization.

  • Parameters:

    • accountId in path required
    • authorizationId in path required
    • userId in path required

user_authorizations_get_principal_user_authorizations

  • Operation ID: user_authorizations_get_principal_user_authorizations
  • Route: GET /v2.1/accounts/{accountId}/users/{userId}/authorizations
  • Mode: READ
  • Summary: Returns the authorizations for which the specified user is the principal user.
  • Parameters:
    • accountId in path required
    • userId in path required
    • active_only in query
    • count in query
    • email_substring in query
    • include_closed_users in query
    • permissions in query
    • start_position in query
    • task_source in query
    • task_type in query
    • user_name_substring in query

user_authorizations_post_user_authorizations

  • Operation ID: user_authorizations_post_user_authorizations
  • Route: POST /v2.1/accounts/{accountId}/users/{userId}/authorizations
  • Mode: WRITE
  • Summary: Create or update multiple user authorizations.
  • Parameters:
    • accountId in path required
    • userId in path required
  • Body: JSON request body accepted.

user_authorizations_delete_user_authorizations

  • Operation ID: user_authorizations_delete_user_authorizations
  • Route: DELETE /v2.1/accounts/{accountId}/users/{userId}/authorizations
  • Mode: WRITE
  • Summary: Delete multiple user authorizations.
  • Parameters:
    • accountId in path required
    • userId in path required
  • Body: JSON request body accepted.

user_agent_authorizations_get_agent_user_authorizations

  • Operation ID: user_agent_authorizations_get_agent_user_authorizations
  • Route: GET /v2.1/accounts/{accountId}/users/{userId}/authorizations/agent
  • Mode: READ
  • Summary: Returns the authorizations for which the specified user is the agent user.
  • Parameters:
    • accountId in path required
    • userId in path required
    • active_only in query
    • count in query
    • email_substring in query
    • include_closed_users in query
    • permissions in query
    • start_position in query
    • task_source in query
    • task_type in query
    • user_name_substring in query

cloud_storage_get_cloud_storage_providers

  • Operation ID: cloud_storage_get_cloud_storage_providers
  • Route: GET /v2.1/accounts/{accountId}/users/{userId}/cloud_storage
  • Mode: READ
  • Summary: Get the Cloud Storage Provider configuration for the specified user.
  • Parameters:
    • accountId in path required
    • userId in path required
    • redirectUrl in query

cloud_storage_post_cloud_storage

  • Operation ID: cloud_storage_post_cloud_storage
  • Route: POST /v2.1/accounts/{accountId}/users/{userId}/cloud_storage
  • Mode: WRITE
  • Summary: Configures the redirect URL information for one or more cloud storage providers for the specified user.
  • Parameters:
    • accountId in path required
    • userId in path required
  • Body: JSON request body accepted.

cloud_storage_delete_cloud_storage_providers

  • Operation ID: cloud_storage_delete_cloud_storage_providers
  • Route: DELETE /v2.1/accounts/{accountId}/users/{userId}/cloud_storage
  • Mode: WRITE
  • Summary: Deletes the user authentication information for one or more cloud storage providers.
  • Parameters:
    • accountId in path required
    • userId in path required
  • Body: JSON request body accepted.

cloud_storage_get_cloud_storage

  • Operation ID: cloud_storage_get_cloud_storage
  • Route: GET /v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}
  • Mode: READ
  • Summary: Gets the specified Cloud Storage Provider configuration for the User.
  • Parameters:
    • accountId in path required
    • serviceId in path required
    • userId in path required
    • redirectUrl in query

cloud_storage_delete_cloud_storage

  • Operation ID: cloud_storage_delete_cloud_storage
  • Route: DELETE /v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}
  • Mode: WRITE
  • Summary: Deletes the user authentication information for the specified cloud storage provider.
  • Parameters:
    • accountId in path required
    • serviceId in path required
    • userId in path required

cloud_storage_folder_get_cloud_storage_folder_all

  • Operation ID: cloud_storage_folder_get_cloud_storage_folder_all
  • Route: GET /v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders
  • Mode: READ
  • Summary: Retrieves a list of all the items in a specified folder from the specified cloud storage provider.
  • Parameters:
    • accountId in path required
    • serviceId in path required
    • userId in path required
    • cloud_storage_folder_path in query
    • count in query
    • order in query
    • order_by in query
    • search_text in query
    • start_position in query

cloud_storage_folder_get_cloud_storage_folder

  • Operation ID: cloud_storage_folder_get_cloud_storage_folder
  • Route: GET /v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders/{folderId}
  • Mode: READ
  • Summary: Gets a list of items from a cloud storage provider.
  • Parameters:
    • accountId in path required
    • folderId in path required
    • serviceId in path required
    • userId in path required
    • cloud_storage_folder_path in query
    • cloud_storage_folderid_plain in query
    • count in query
    • order in query
    • order_by in query
    • search_text in query
    • sky_drive_skip_token in query
    • start_position in query

user_custom_settings_get_custom_settings

  • Operation ID: user_custom_settings_get_custom_settings
  • Route: GET /v2.1/accounts/{accountId}/users/{userId}/custom_settings
  • Mode: READ
  • Summary: Retrieves the custom user settings for a specified user.
  • Parameters:
    • accountId in path required
    • userId in path required

user_custom_settings_put_custom_settings

  • Operation ID: user_custom_settings_put_custom_settings
  • Route: PUT /v2.1/accounts/{accountId}/users/{userId}/custom_settings
  • Mode: WRITE
  • Summary: Adds or updates custom user settings for the specified user.
  • Parameters:
    • accountId in path required
    • userId in path required
  • Body: JSON request body accepted.

user_custom_settings_delete_custom_settings

  • Operation ID: user_custom_settings_delete_custom_settings
  • Route: DELETE /v2.1/accounts/{accountId}/users/{userId}/custom_settings
  • Mode: WRITE
  • Summary: Deletes custom user settings for a specified user.
  • Parameters:
    • accountId in path required
    • userId in path required
  • Body: JSON request body accepted.

user_profile_get_profile

  • Operation ID: user_profile_get_profile
  • Route: GET /v2.1/accounts/{accountId}/users/{userId}/profile
  • Mode: READ
  • Summary: Retrieves the user profile for a specified user.
  • Parameters:
    • accountId in path required
    • userId in path required

user_profile_put_profile

  • Operation ID: user_profile_put_profile
  • Route: PUT /v2.1/accounts/{accountId}/users/{userId}/profile
  • Mode: WRITE
  • Summary: Updates the user profile information for the specified user.
  • Parameters:
    • accountId in path required
    • userId in path required
  • Body: JSON request body accepted.

user_profile_image_get_user_profile_image

  • Operation ID: user_profile_image_get_user_profile_image
  • Route: GET /v2.1/accounts/{accountId}/users/{userId}/profile/image
  • Mode: READ
  • Summary: Retrieves the user profile image for the specified user.
  • Parameters:
    • accountId in path required
    • userId in path required
    • encoding in query

user_profile_image_put_user_profile_image

  • Operation ID: user_profile_image_put_user_profile_image
  • Route: PUT /v2.1/accounts/{accountId}/users/{userId}/profile/image
  • Mode: WRITE
  • Summary: Updates the user profile image for a specified user.
  • Parameters:
    • accountId in path required
    • userId in path required

user_profile_image_delete_user_profile_image

  • Operation ID: user_profile_image_delete_user_profile_image
  • Route: DELETE /v2.1/accounts/{accountId}/users/{userId}/profile/image
  • Mode: WRITE
  • Summary: Deletes the user profile image for the specified user.
  • Parameters:
    • accountId in path required
    • userId in path required

user_settings_get_user_settings

  • Operation ID: user_settings_get_user_settings
  • Route: GET /v2.1/accounts/{accountId}/users/{userId}/settings
  • Mode: READ
  • Summary: Gets the user account settings for a specified user.
  • Parameters:
    • accountId in path required
    • userId in path required

user_settings_put_user_settings

  • Operation ID: user_settings_put_user_settings
  • Route: PUT /v2.1/accounts/{accountId}/users/{userId}/settings
  • Mode: WRITE
  • Summary: Updates the user account settings for a specified user.
  • Parameters:
    • accountId in path required
    • userId in path required
    • allow_all_languages in query
  • Body: JSON request body accepted.

user_signatures_get_user_signatures

  • Operation ID: user_signatures_get_user_signatures
  • Route: GET /v2.1/accounts/{accountId}/users/{userId}/signatures
  • Mode: READ
  • Summary: Retrieves a list of signature definitions for a user.
  • Parameters:
    • accountId in path required
    • userId in path required
    • stamp_type in query

user_signatures_put_user_signature

  • Operation ID: user_signatures_put_user_signature
  • Route: PUT /v2.1/accounts/{accountId}/users/{userId}/signatures
  • Mode: WRITE
  • Summary: Adds/updates a user signature.
  • Parameters:
    • accountId in path required
    • userId in path required
  • Body: JSON request body accepted.

user_signatures_post_user_signatures

  • Operation ID: user_signatures_post_user_signatures
  • Route: POST /v2.1/accounts/{accountId}/users/{userId}/signatures
  • Mode: WRITE
  • Summary: Adds user Signature and initials images to a Signature.
  • Parameters:
    • accountId in path required
    • userId in path required
  • Body: JSON request body accepted.

user_signatures_get_user_signature

  • Operation ID: user_signatures_get_user_signature
  • Route: GET /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}
  • Mode: READ
  • Summary: Gets the user signature information for the specified user.
  • Parameters:
    • accountId in path required
    • signatureId in path required
    • userId in path required

user_signatures_put_user_signature_by_id

  • Operation ID: user_signatures_put_user_signature_by_id
  • Route: PUT /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}
  • Mode: WRITE
  • Summary: Updates the user signature for a specified user.
  • Parameters:
    • accountId in path required
    • signatureId in path required
    • userId in path required
    • close_existing_signature in query
  • Body: JSON request body accepted.

user_signatures_delete_user_signature

  • Operation ID: user_signatures_delete_user_signature
  • Route: DELETE /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}
  • Mode: WRITE
  • Summary: Removes removes signature information for the specified user.
  • Parameters:
    • accountId in path required
    • signatureId in path required
    • userId in path required

user_signatures_get_user_signature_image

  • Operation ID: user_signatures_get_user_signature_image
  • Route: GET /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}
  • Mode: READ
  • Summary: Retrieves the user initials image or the user signature image for the specified user.
  • Parameters:
    • accountId in path required
    • imageType in path required
    • signatureId in path required
    • userId in path required
    • include_chrome in query

user_signatures_put_user_signature_image

  • Operation ID: user_signatures_put_user_signature_image
  • Route: PUT /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}
  • Mode: WRITE
  • Summary: Updates the user signature image or user initials image for the specified user.
  • Parameters:
    • accountId in path required
    • imageType in path required
    • signatureId in path required
    • userId in path required
    • transparent_png in query
  • Body: JSON request body accepted.

user_signatures_delete_user_signature_image

  • Operation ID: user_signatures_delete_user_signature_image
  • Route: DELETE /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}
  • Mode: WRITE
  • Summary: Deletes the user initials image or the user signature image for the specified user.
  • Parameters:
    • accountId in path required
    • imageType in path required
    • signatureId in path required
    • userId in path required

views_post_account_console_view

  • Operation ID: views_post_account_console_view
  • Route: POST /v2.1/accounts/{accountId}/views/console
  • Mode: WRITE
  • Summary: Returns a URL to the Docusign eSignature web application.
  • Parameters:
    • accountId in path required
  • Body: JSON request body accepted.

watermark_get_watermark

  • Operation ID: watermark_get_watermark
  • Route: GET /v2.1/accounts/{accountId}/watermark
  • Mode: READ
  • Summary: Get watermark information.
  • Parameters:
    • accountId in path required

watermark_put_watermark

  • Operation ID: watermark_put_watermark
  • Route: PUT /v2.1/accounts/{accountId}/watermark
  • Mode: WRITE
  • Summary: Update watermark information.
  • Parameters:
    • accountId in path required
  • Body: JSON request body accepted.

watermark_preview_put_watermark_preview

  • Operation ID: watermark_preview_put_watermark_preview
  • Route: PUT /v2.1/accounts/{accountId}/watermark/preview
  • Mode: WRITE
  • Summary: Get watermark preview.
  • Parameters:
    • accountId in path required
  • Body: JSON request body accepted.

workspace_get_workspaces

  • Operation ID: workspace_get_workspaces
  • Route: GET /v2.1/accounts/{accountId}/workspaces
  • Mode: READ
  • Summary: List Workspaces
  • Parameters:
    • accountId in path required

workspace_post_workspace

  • Operation ID: workspace_post_workspace
  • Route: POST /v2.1/accounts/{accountId}/workspaces
  • Mode: WRITE
  • Summary: Create a Workspace
  • Parameters:
    • accountId in path required
  • Body: JSON request body accepted.

workspace_get_workspace

  • Operation ID: workspace_get_workspace
  • Route: GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}
  • Mode: READ
  • Summary: Get Workspace
  • Parameters:
    • accountId in path required
    • workspaceId in path required

workspace_put_workspace

  • Operation ID: workspace_put_workspace
  • Route: PUT /v2.1/accounts/{accountId}/workspaces/{workspaceId}
  • Mode: WRITE
  • Summary: Update Workspace
  • Parameters:
    • accountId in path required
    • workspaceId in path required
  • Body: JSON request body accepted.

workspace_delete_workspace

  • Operation ID: workspace_delete_workspace
  • Route: DELETE /v2.1/accounts/{accountId}/workspaces/{workspaceId}
  • Mode: WRITE
  • Summary: Delete Workspace
  • Parameters:
    • accountId in path required
    • workspaceId in path required

workspace_folder_get_workspace_folder

  • Operation ID: workspace_folder_get_workspace_folder
  • Route: GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}
  • Mode: READ
  • Summary: List workspace folder contents
  • Parameters:
    • accountId in path required
    • folderId in path required
    • workspaceId in path required
    • count in query
    • include_files in query
    • include_sub_folders in query
    • include_thumbnails in query
    • include_user_detail in query
    • start_position in query
    • workspace_user_id in query

workspace_folder_delete_workspace_items

  • Operation ID: workspace_folder_delete_workspace_items
  • Route: DELETE /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}
  • Mode: WRITE
  • Summary: Deletes files or sub-folders from a workspace.
  • Parameters:
    • accountId in path required
    • folderId in path required
    • workspaceId in path required
  • Body: JSON request body accepted.

workspace_file_post_workspace_files

  • Operation ID: workspace_file_post_workspace_files
  • Route: POST /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files
  • Mode: WRITE
  • Summary: Creates a workspace file.
  • Parameters:
    • accountId in path required
    • folderId in path required
    • workspaceId in path required

workspace_file_get_workspace_file

  • Operation ID: workspace_file_get_workspace_file
  • Route: GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}
  • Mode: READ
  • Summary: Gets a workspace file
  • Parameters:
    • accountId in path required
    • fileId in path required
    • folderId in path required
    • workspaceId in path required
    • is_download in query
    • pdf_version in query

workspace_file_put_workspace_file

  • Operation ID: workspace_file_put_workspace_file
  • Route: PUT /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}
  • Mode: WRITE
  • Summary: Update workspace file or folder metadata
  • Parameters:
    • accountId in path required
    • fileId in path required
    • folderId in path required
    • workspaceId in path required

workspace_file_pages_get_workspace_file_pages

  • Operation ID: workspace_file_pages_get_workspace_file_pages
  • Route: GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}/pages
  • Mode: READ
  • Summary: List File Pages
  • Parameters:
    • accountId in path required
    • fileId in path required
    • folderId in path required
    • workspaceId in path required
    • count in query
    • dpi in query
    • max_height in query
    • max_width in query
    • start_position in query

accounts_get_provisioning

  • Operation ID: accounts_get_provisioning
  • Route: GET /v2.1/accounts/provisioning
  • Mode: READ
  • Summary: Retrieves the account provisioning information for the account.