Microapps

Smartsheet connector specifications

Deploy the Smartsheet integration to manage sheets, discussions, update requests, and attachments.

Version Details

Smartsheet integration template supports the latest Smartsheet REST APIs v2.0: https://smartsheet-platform.github.io/api-docs/

Endpoints

POST

https://app.smartsheet.com/b/authorize
https://api.smartsheet.com/2.0/token
https://api.smartsheet.com/2.0/sheets/{sheetId}/discussions/{discussionId}/comments
https://api.smartsheet.com/2.0/favorites
https://api.smartsheet.com/2.0/sheets/{sheetId}/shares
https://api.smartsheet.com/2.0/sheets
https://api.smartsheet.com/2.0/sheets/{sheetId}/discussions
https://api.smartsheet.com/2.0/sheets/{sheetId}/emails

GET

https://api.smartsheet.com/2.0/users
https://api.smartsheet.com/2.0/groups
https://api.smartsheet.com/2.0/groups/{groupId}
https://api.smartsheet.com/2.0/users/sheets
https://api.smartsheet.com/2.0/sheets/{sheetId}/sentupdaterequests
https://api.smartsheet.com/2.0/sheets/{sheetId}/discussions
https://api.smartsheet.com/2.0/sheets/{sheetId}
https://api.smartsheet.com/2.0/sheets/{sheetId}/shares

DELETE

https://api.smartsheet.com/2.0/sheets/{sheetId}/sentupdaterequests/{sentUpdateRequestId}

Service Actions

  • Delete Sent Update Request - Delete the specified sent update request in the source system.
  • Add Comment - Reply to a previous comment in the source system.
  • Add to Favorites - Add a sheet as favorite in the source system.
  • Share Sheet with Group - Share a sheet with a group with pertinent details, such as group name and access level, and send email in the source system.
  • Create a Sheet - Create a new sheet with pertinent details such as sheet name, column title, and column type in the source system.
  • Start a Discussion - Create a discussion on sheet level in the source system
  • Send Sheet as an Attachment - Send a sheet as attachment (PDF/MS Excel) with other users with details such as send email, subject, and message in the source system.
  • Share Sheet with User - Share a sheet with pertinent details such as user name, access level, and user email in the source system.

Key Entities

The following are the main business entities that this connector addresses:

  • list_users
  • list_groups
    • get_group
    • get_group_members
  • list_org_sheets
    • get_all_org_sentupdatere
    • list_org_discussions
    • list_org_discussions_comm
    • list_org_discussions_1
  • list_sheets
    • get_sheets
    • list_sheet_shares

Entities with Attributes

The following is a full list of entities and their attributes:

list_users

  • admin: BOOLEAN
  • email: STRING(255), FK(list_sheet_shares.list_she_owner)
  • first_name: STRING(255)
  • group_admin: BOOLEAN
  • id: LONG
  • last_name: STRING(255)
  • licensed_sheet_creator: BOOLEAN
  • name: STRING(255)
  • resource_viewer: BOOLEAN
  • sheet_count: INTEGER
  • status: STRING(255)

list_groups

  • created_at: TIMESTAMP
  • id: LONG
  • modified_at: TIMESTAMP
  • name: STRING(255)
  • owner: STRING(255)
  • owner_id: LONG

get_group

  • created_at: TIMESTAMP
  • id: LONG, FK(list_sheet_shares.group_id)
  • modified_at: TIMESTAMP
  • name: STRING(255)
  • owner: STRING(255)
  • owner_id: LONG

get_group_members

  • last_name: STRING(255)
  • first_name: STRING(255)
  • name: STRING(255)
  • id: LONG
  • email: STRING(255)
  • parent_id: LONG, FK(list_sheet_shares.group_id)
  • unique_id: STRING(36)
  • root_id: LONG

list_org_sheets

  • id: LONG, FK(get_sheets.id)
  • name: STRING(255)
  • owner: STRING(255)
  • owner_id: LONG

list_sheets

  • id: LONG
  • name: STRING(255)
  • owner: STRING(255)
  • owner_id: LONG

get_all_org_sentupdatere

  • id: LONG
  • list_org_id: LONG
  • list_org_name: STRING(255)
  • list_org_owner: STRING(255)
  • list_org_owner_id: LONG
  • message: STRING(255)
  • sent_at: TIMESTAMP
  • sent_by_email: STRING(255)
  • sent_by_name: STRING(255)
  • sent_to_email: STRING(255)
  • status: STRING(255)
  • subject: STRING(255)
  • update_request_id: LONG

list_org_discussions

  • access_level: STRING(255)
  • comment_count: INTEGER
  • created_by_email: STRING(255)
  • created_by_name: STRING(255)
  • id: LONG
  • last_commented_at: TIMESTAMP
  • last_commented_user_email: STRING(255)
  • last_commented_user_name: STRING(255)
  • list_org_id: LONG
  • list_org_name: STRING(255)
  • list_org_owner: STRING(255)
  • list_org_owner_id: LONG
  • parent_id: LONG
  • parent_type: STRING(255)
  • read_only: BOOLEAN
  • title: STRING(255)

list_org_discussions_comm

  • created_at: TIMESTAMP
  • created_by_email: STRING(255)
  • created_by_name: STRING(255)
  • id: LONG
  • modified_at: TIMESTAMP
  • text: STRING(255)
  • parent_id: LONG, FK(list_org_discussions.id)
  • unique_id: STRING(36)
  • root_id: LONG

list_org_discussions_1

  • attachment_type: STRING(255)
  • created_at: TIMESTAMP
  • created_by_email: STRING(255)
  • created_by_name: STRING(255)
  • id: LONG
  • mime_type: STRING(255)
  • name: STRING(255)
  • size_in_kb: INTEGER
  • parent_unique_id: STRING(36), FK(list_org_discussions_comm.unique_id)
  • unique_id: STRING(36)
  • root_id: LONG

get_sheets

  • access_level: STRING(255)
  • cell_image_upload_enabled: BOOLEAN
  • created_at: TIMESTAMP
  • dependencies_enabled: BOOLEAN
  • gantt_enabled: BOOLEAN
  • has_summary_fields: BOOLEAN
  • id: LONG, FK(list_sheet_shares.list_she_id)
  • is_multi_picklist_enabled: BOOLEAN
  • modified_at: TIMESTAMP
  • name: STRING(255)
  • permalink: STRING(255)
  • resource_management_enabl: BOOLEAN
  • total_row_count: INTEGER
  • user_permissions_summary: STRING(255)
  • user_settings_critical_pa: BOOLEAN
  • user_settings_display_sum: BOOLEAN
  • version: INTEGER

list_sheet_shares

  • access_level: STRING(255)
  • created_at: TIMESTAMP
  • email: STRING(255)
  • group_id: LONG
  • id: STRING(255)
  • list_she_id: LONG, FK(list_org_sheets.id)
  • list_she_name: STRING(255)
  • list_she_owner: STRING(255)
  • list_she_owner_id: LONG
  • modified_at: TIMESTAMP
  • name: STRING(255)
  • scope: STRING(255)
  • type: STRING(255)
  • user_id: LONG
Smartsheet connector specifications