For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • Overview
    • Introduction
    • Response Codes
  • API Reference
LogoLogo
On this page
  • Groups
  • Authentication
  • Pagination
Overview

Introduction

||View as Markdown|
Was this page helpful?
Next

Response Codes

Built with

Welcome to the Alsona REST API! Let’s walk through a quick setup to get you.

API version: v1 (REST)

Groups

GroupDescription
AccountRetrieve and manage account details
AgencyCross-account access via a single Agency API key
CampaignsCreate, update, list, and delete outreach campaigns
Campaign ProfilesManage individual LinkedIn profiles inside campaigns
FiltersDefine targeting rules (one filter group per seat)
IntegrationsConnect third-party CRMs (HubSpot, Salesforce, etc.)
Inbox > EmailRead and manage email inbox threads and messages
Inbox > LinkedInRead and manage LinkedIn inbox threads and messages
LogsAudit logs for seat-profile activity
StatsAggregated activity metrics (DAY / HOUR / MIN granularity)
TemplatesReusable workflow templates scoped by group

Authentication

Two auth patterns are supported - both use the X-API-KEY request header.

Account key - scoped to a single account:

GET https://alsona.com/rest/accounts/{account_id}/campaigns
X-API-KEY: <account_api_key>

Agency key - access any account within your agency:

GET https://alsona.com/rest/agency/accounts/{account_id}/campaigns
X-API-KEY: <agency_api_key>

The Agency key does not aggregate across accounts - you must specify account_id in the path. Both key types produce the same response for account-scoped endpoints.

Pagination

List endpoints support cursor-based pagination via the last_key query parameter:

  1. Make the initial request without last_key.
  2. If the response includes a non-null last_key, URL-encode it and pass it as ?last_key=<value> in your next request.
  3. Repeat until last_key is null - you have fetched all results.