Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Upsales

Scalekit connector
Open markdown

The Upsales connector lets your AI agent act in each user's Upsales account. Each user connects their own Upsales API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.

Tools
60
What they doRead · write · destructive
29 · 21 · 1029 read21 write10 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the Upsales connection

    In AgentKit > Connections, create an Upsales connection. The name you give it is the connection_name your code passes. See Configure connections.

  4. Authorize a user and make your first call

    quickstart.mts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    import { createInterface } from 'node:readline/promises'
    const scalekit = new ScalekitClient(
    process.env.SCALEKIT_ENVIRONMENT_URL,
    process.env.SCALEKIT_CLIENT_ID,
    process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    const connector = 'upsales'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Upsales:', link)
    const rl = createInterface({ input: process.stdin, output: process.stdout })
    await rl.question('Press Enter after authorizing...')
    rl.close()
    // Make your first call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'upsales_activities_list',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their Upsales credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • upsales_activities_listList activities (tasks such as phone calls and to-dos), optionally by company, user or date, with limit/offset paging.Read-only

    List Activities

    List activities (tasks such as phone calls and to-dos), optionally by company, user or date, with limit/offset paging. Returns activities with description, date, type, company, contacts and close date.

    Inputs

    close_datestring
    Filter by close date; null for open activities. Prefix a comparison to filter by range: eq:, ne:, gt:, gte:, lt: or lte: (for example gte:2026-01-01). Example: null.
    company_idinteger
    Only activities of this company ID. Example: 2.
    datestring
    Filter by activity date (YYYY-MM-DD). Prefix a comparison to filter by range: eq:, ne:, gt:, gte:, lt: or lte: (for example gte:2026-01-01). Example: gte:2026-01-01.
    limitinteger
    Number of records to return, up to 2000. Defaults to 1000. Example: 50.
    offsetinteger
    Number of records to skip, for paging. Example: 0.
    sortstring
    Field to sort by; prefix with - for descending, for example -regDate. Example: date.
    user_idinteger
    Only activities of this user ID. Example: 1.
  • upsales_activity_getGet one activity (phone call or to-do) by ID.Read-only

    Get Activity

    Get one activity (phone call or to-do) by ID. Returns the activity.

    Inputs

    activity_idintegerrequired
    Activity ID, from upsales_activities_list. Example: 45.
  • upsales_activity_types_listList the activity types (for example phone call and to-do).Read-only

    List Activity Types

    List the activity types (for example phone call and to-do). Returns type IDs and names to use as activity_type_id.

    Inputs

    This tool takes no inputs.

  • upsales_appointment_types_listList the appointment types (for example first meeting, demo).Read-only

    List Appointment Types

    List the appointment types (for example first meeting, demo). Returns type IDs and names to use as activity_type_id.

    Inputs

    This tool takes no inputs.

  • upsales_appointments_listList appointments (meetings), optionally by company, user or date, with limit/offset paging.Read-only

    List Appointments

    List appointments (meetings), optionally by company, user or date, with limit/offset paging. Returns appointments with start and end, description, type, company and attendees.

    Inputs

    company_idinteger
    Only appointments of this company ID. Example: 2.
    datestring
    Filter by start date. Prefix a comparison to filter by range: eq:, ne:, gt:, gte:, lt: or lte: (for example gte:2026-01-01). Example: gte:2026-01-01.
    limitinteger
    Number of records to return, up to 2000. Defaults to 1000. Example: 50.
    offsetinteger
    Number of records to skip, for paging. Example: 0.
    sortstring
    Field to sort by; prefix with - for descending, for example -regDate. Example: date.
    user_idinteger
    Only appointments of this user ID. Example: 1.
  • upsales_campaign_getGet one campaign.Read-only

    Get Campaign

    Get one campaign. Returns the campaign.

    Inputs

    campaign_idintegerrequired
    Campaign ID, from upsales_campaigns_list. Example: 4.
  • upsales_campaigns_listList campaigns (called projects in the API), optionally only active ones, with limit/offset paging.Read-only

    List Campaigns

    List campaigns (called projects in the API), optionally only active ones, with limit/offset paging. Returns campaign IDs, names, dates and users.

    Inputs

    activeinteger
    1 for active campaigns, 0 for inactive. Example: 1.one of 01
    limitinteger
    Number of records to return, up to 2000. Defaults to 1000. Example: 50.
    offsetinteger
    Number of records to skip, for paging. Example: 0.
    sortstring
    Field to sort by; prefix with - for descending, for example -regDate. Example: id.
  • upsales_comments_listList comments (notes) on companies, tickets or opportunities, with limit/offset paging.Read-only

    List Comments

    List comments (notes) on companies, tickets or opportunities, with limit/offset paging. Returns comments with text, author and pinned flag.

    Inputs

    company_idinteger
    Only comments on this company ID. Example: 12.
    limitinteger
    Number of records to return, up to 2000. Defaults to 1000. Example: 50.
    offsetinteger
    Number of records to skip, for paging. Example: 0.
    opportunity_idstring
    Only comments on this opportunity, for example eq:900. Example: eq:900.
    sortstring
    Field to sort by; prefix with - for descending, for example -regDate. Example: -regDate.
    ticket_idstring
    Only comments on this ticket, for example eq:400. Example: eq:400.