Skip to content
vScope Support Page

Export a saved table via API (JSON/CSV/XLSX)

Through vScope’s open REST API, you can export saved tables to JSON, CSV or XLSX. This is useful for automation and for reusing structured data in other systems and processes, e.g. IT Service Management, Billing, BI or monitoring system.

Prerequisites

Section titled “Prerequisites”
  • Access to your vScope host, for example https://your-vscope.example.com.
  • Permission to view the table you want to export (share the table with the tokened user).

Use these placeholders in requests from your system:

  • {VSCOPE_HOST} — base URL, e.g. https://your-vscope.example.com
  • {TOKEN} — API token value
  • {TABLE_ID} — the numeric table ID, the last part of the link you get from Share > Copy link
Section titled “Creating a user (Recommended)”

It’s recommendet to create a user account for managing API access to data more securely.

  • Go to Settings > Users, Create User.
  • Enter user details. Keep the permission level low, i.e. Viewer and click Save

Creating a token (Required)

Section titled “Creating a token (Required)”
  • Go to Settings → API Tokens and create a token for the recently created user account. This token allows you to access the user’s content via API.

Verify the token

Section titled “Verify the token”

Send a simple request from your system to confirm the token works:

GET {VSCOPE_HOST}/rest/usermanager/me
Header: token: {TOKEN}

Expected results:

  • 200 OK with user info → token is valid and has access.
  • 401/403 → token missing/invalid or user lacks permission.

Exporting a saved table

Section titled “Exporting a saved table”
  1. Prepare and save the table
    • In Tables, build the view you need. Asset type, columns + filters and click Save.

  1. Share the table and find the table ID

    • In the saved table, click Share > Collaborators.
    • Add the user account you created (if applicable) as Collaborator to the table. This allows the account to fetch all the data that is listed in the table.
    • Click Share > Copy link (see Tables). The table ID is the last part of the URL, e.g. 1792055636942 in https://external-integrations.vscope.net/ui/explorer/1792055636942.

  2. Call the export endpoint from your system

    • Choose a format: json, csv, or xlsx.
    • Request shape:
GET {VSCOPE_HOST}/v1/tables/{TABLE_ID}/data/{FORMAT}
Header: token: {TOKEN}
  • Expected responses
    • 200 OK with the file/JSON payload.
    • 404 if the table ID is wrong or not shared with the tokened user.
    • 401/403 if the token is missing/invalid or lacks table access.

Errors

Section titled “Errors”
  • 401/403: Token missing/invalid or the tokened user lacks access to the table. Regenerate the token or share the table with that user.
  • 404: Table ID wrong or the table isn’t shared/visible. Re-copy the link from Share > Copy link and confirm the table is shared with the user.
Section titled “Related API tasks”