Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIGrowthCampaign

Campaign routes: create, get, list

The Campaign Verbs create, get, list as api.sb routes, with inputs, result, refusals and an example.

Reference for Campaign, one group of Campaign routes.

Campaign.create

Creates a Campaign. Verb page.

Text
POST /{namespace}/campaigns

Body, as JSON: the inputs. Emits Campaign.created.

Inputs

InputTypeRequiredDescription
budgetmoneyWhat it may spend.
startsAtdatetimeWhen it starts.
endsAtdatetimeWhen it ends.
goalGoalA Campaign spends its budget and window toward one Goal.

Returns

OutputTypeRequiredDescription
campaignCampaignrequiredThe Campaign.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/campaigns \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"budget":{"amount":29,"currency":"USD"}}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "campaign": {
    "$id": "https://api.sb/leaseline.app/campaigns/campaign_NYwCp4DcII",
    "$type": "Campaign",
    "budget": {
      "amount": 29,
      "currency": "USD"
    },
    "startsAt": "2026-10-22T12:00:00Z"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Campaign.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Campaign.get

Returns one Campaign by id. Verb page.

Text
GET /{namespace}/campaigns/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Campaign.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
campaignCampaignrequiredThe Campaign.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl https://api.sb/leaseline.app/campaigns/campaign_NYwCp4DcII \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Campaign",
  "$id": "https://api.sb/leaseline.app/campaigns/campaign_NYwCp4DcII",
  "campaign": {
    "$id": "https://api.sb/leaseline.app/campaigns/campaign_NYwCp4DcII",
    "$type": "Campaign",
    "budget": {
      "amount": 29,
      "currency": "USD"
    },
    "startsAt": "2026-10-22T12:00:00Z"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/campaigns/campaign_NYwCp4DcII",
    "up": "https://api.sb/leaseline.app/campaigns"
  }
}

Campaign.list

Returns Campaigns, newest first, one page at a time. Verb page.

Text
GET /{namespace}/campaigns

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
campaignslist of CampaignrequiredOne page of Campaigns.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl "https://api.sb/leaseline.app/campaigns?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Campaign",
  "campaigns": [
    {
      "$id": "https://api.sb/leaseline.app/campaigns/campaign_NYwCp4DcII",
      "$type": "Campaign",
      "budget": {
        "amount": 29,
        "currency": "USD"
      },
      "startsAt": "2026-10-22T12:00:00Z"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "campaign_NYwCp4DcII"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/campaigns?limit=20",
    "next": "https://api.sb/leaseline.app/campaigns?after=campaign_NYwCp4DcII"
  }
}

Campaign

Previous

update, delete

Next