Filter campaigns by their current status. ACTIVE: the account's link to the campaign is currently active. EXPIRED: the account's link to the campaign has expired. SCHEDULED: the account's link to the campaign has not yet started. If omitted, all campaigns are returned.

Returns

AccountCampaignConnectionTypeConnection

Paginator of Account Campaigns

Possible Errors

KT-CT-1113: Disabled GraphQL field requested.
KT-CT-4123: Unauthorized.
KT-CT-7899: An internal error occurred.

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can query account campaigns

Query Complexity

Examples

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Query

query Campaigns(
  $accountNumber: String!,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $status: CampaignAccountStatus
) {
  campaigns(
    accountNumber: $accountNumber,
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    status: $status
  ) {
    edgeCount
    edges {
      ...AccountCampaignConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "accountNumber": "A-32872BC1",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10,
  "status": "ACTIVE"
}

Response

{
  "data": {
    "campaigns": {
      "edgeCount": 83,
      "edges": [AccountCampaignConnectionTypeEdge],
      "pageInfo": PageInfo,
      "totalCount": 38
    }
  }
}