GET
/
api
/
teams
/
{teamId}
/
campaigns
curl --request GET \
  --url https://firstquadrant.ai/api/teams/{teamId}/campaigns \
  --header 'Bearer API key: <api-key>'
[
  {
    "id": "con_qxwVhUwAj3ijxWXstmCNvIII",
    "createdAt": "2024-05-12T00:00:00.000Z",
    "updatedAt": "2024-05-12T00:00:00.000Z",
    "status": "RUNNING",
    "name": "My Campaign",
    "goal": "SCHEDULE_MEETING",
    "goalUrl": "https://firstquadrant.ai/schedule-meeting",
    "offeringName": "FirstQuadrant",
    "offeringDescription": "The best way to send emails."
  }
]

Authorizations

​
Bearer API key
string
header
required

The API key used to authenticate requests, learn how to generate an API key on the Authentication page.

Path Parameters

​
teamId
string
required

Team ID, starting with tea_

Query Parameters

​
take
integer
default:25

The number of items to return per page.

Required range: x <= 100
​
startingAfter
string

ID of the item to start the pagination after (not inclusive).

​
q
string

Search query to filter items by.

​
orderBy
string

The field to order items by (e.g., createdAt).

​
sort
enum<string>

The direction to sort items by.

Available options:
asc,
desc

Response

200 - application/json
Array of campaigns

The response is of type object[].