Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Clientary

Scalekit connector
Open markdown

The Clientary connector lets your AI agent work with Clientary. Scalekit handles authentication for every call, so your agent never handles credentials. It comes with 60 tools.

Tools
60
What they doRead · write · destructive
26 · 24 · 1026 read24 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 Clientary connection

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

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • clientary_client_getGet one client by ID.Read-only

    Get Client

    Get one client by ID. Returns its number, name, address, website, description and app URL.

    Inputs

    idintegerrequired
    ID of the client. Example: 1234.
  • clientary_clients_listList clients (companies or organizations you bill), 10 per page, sorted by name or by newest.Read-only

    List Clients

    List clients (companies or organizations you bill), 10 per page, sorted by name or by newest. Returns page_count, total_count and per client its id, number, name, address, website and description. Use clientary_client_get for one client.

    Inputs

    filterstring
    archived to list archived clients; active clients otherwise. Example: archived.one of archived
    pageinteger
    Page number, starting at 1. Example: 2.
    qstring
    Search clients by name or number. Example: acme.
    sortstring
    date to sort newest first; name order otherwise. Example: date.one of date
    updated_sincestring
    Only records changed on or after this date (YYYY-MM-DD). Example: 2026-01-01.
  • clientary_comments_listList the comments on an invoice, estimate, project, task, proposal or contract, newest first.Read-only

    List Comments

    List the comments on an invoice, estimate, project, task, proposal or contract, newest first. Returns per comment its id, body, staff_only flag, author and dates.

    Inputs

    resourcestringrequired
    Type of record the comments are on. Example: invoices.one of invoicesestimatesprojectstasksproposalscontracts
    resource_idintegerrequired
    ID of the invoice, estimate, project, task, proposal or contract. Example: 1234.
  • clientary_contact_getGet one contact by ID.Read-only

    Get Contact

    Get one contact by ID. Returns client_id, name, title, email, phone, extension and mobile.

    Inputs

    idintegerrequired
    ID of the contact. Example: 1234.
  • clientary_contacts_listList contacts (people at clients and leads) across the account, in name order or newest first.Read-only

    List Contacts

    List contacts (people at clients and leads) across the account, in name order or newest first. Returns page_count, total_count and per contact its id, client_id, name, title, email and phones. Use clientary_contact_get for one contact.

    Inputs

    pageinteger
    Page number, starting at 1. Example: 2.
    page_sizeinteger
    Results per page, up to 100. Example: 50.
    qstring
    Search contacts by name or email. Example: jane.
    sortstring
    date to sort newest first; name order otherwise. Example: date.one of date
    updated_sincestring
    Only records changed on or after this date (YYYY-MM-DD). Example: 2026-01-01.
  • clientary_contract_getGet one contract by ID.Read-only

    Get Contract

    Get one contract by ID. Returns subject, status, date, client, sections, signers and signing state, plus url, client_view_url and pdf_url links.

    Inputs

    idintegerrequired
    ID of the contract. Example: 1234.
  • clientary_contracts_listList contracts (documents the client reads and signs), optionally for one project, status or date range, or by search text.Read-only

    List Contracts

    List contracts (documents the client reads and signs), optionally for one project, status or date range, or by search text. Returns page_count, total_count and per contract its id, subject, status, date, client, project and sections.

    Inputs

    from_datestring
    Start of the date range (YYYY-MM-DD). Example: 2026-01-01.
    pageinteger
    Page number, starting at 1. Example: 2.
    project_idinteger
    Only contracts of this project ID. Example: 7.
    qstring
    Search by title or client name. Example: lawn.
    statusstring
    draft, sent, viewed, signed or voided. Example: sent.one of draftsentviewedsignedvoided
    to_datestring
    End of the date range (YYYY-MM-DD). Example: 2026-03-31.
  • clientary_estimate_getGet one estimate by ID.Read-only

    Get Estimate

    Get one estimate by ID. Returns number, client, project, date, status, taxes, totals and items, plus url, client_view_url and pdf_url links.

    Inputs

    idintegerrequired
    ID of the estimate. Example: 1234.