Get a campaign

GET

campaigns

{id}

Get a campaign

curl --request GET \
  --url https://backend.leadey.ai/v1/campaigns/{id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "status": "active",
    "createdAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

Your API key, created in the Leadey dashboard under Settings → API Keys. Send it as Authorization: Bearer leadey_sk_live_….

Path Parameters

string

required

The resource id.

Response

The requested campaign.

data

object

Show child attributes

List companiesReturns a paginated list of companies in your workspace, ordered by name.

⌘I

Get a campaign

curl --request GET \
  --url https://backend.leadey.ai/v1/campaigns/{id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "status": "active",
    "createdAt": "2023-11-07T05:31:56Z"
  }
}