# Get Campaigns

Retrieves a paginated list of campaigns, optionally filtered by a payout instruction ID.
To include details about total funds received and statistics on the statuses of the payout instructions, use 'includeDetails' flag.

Endpoint: GET /v2/campaign-manager/campaigns
Version: v2
Security: oauth2

## Query parameters:

  - `pageNumber` (integer)

  - `pageSize` (integer)

  - `payoutInstructionId` (string)

  - `includeDetails` (boolean)

## Response 200 fields (application/json):

  - `pageNumber` (integer)

  - `pageSize` (integer)

  - `totalPages` (integer)

  - `totalItems` (integer)

  - `data` (array)

  - `data.campaign` (object)

  - `data.campaign.id` (string)
    The unique identifier for the campaign.

  - `data.campaign.name` (string)
    The name of the campaign.

  - `data.campaign.fundingSourceId` (string)
    The funding source associated with the campaign.

  - `data.campaign.welcomeHeadline` (string,null)
    The welcome headline text that will be displayed in the application welcome screen.

  - `data.campaign.campaignDescription` (string,null)
    The campaign description of the campaign.

  - `data.campaign.campaignManager` (string,null)
    The name of the campaign manager.

  - `data.campaign.welcomeText` (string,null)
    The welcome text that will be displayed in the application welcome screen.

  - `data.campaign.iconUrl` (string,null)
    URL to the campaign's icon image that will be displayed in the application welcome screen.

  - `data.campaign.payoutMethods` (array)
    Available payout methods for this campaign.

  - `data.campaign.payoutMethods.payoutMethodId` (string)
    The unique identifier of the payout method.

  - `data.campaign.payoutMethods.isDisabled` (boolean)
    Indicates whether this payout method is disabled for the campaign.

  - `data.campaign.payoutMethods.disableReason` (integer)
    Enum: "Default", "InvalidPhoneNumber", "AmountNotSupported"

  - `data.campaign.expiryDate` (string,null)
    The date when the campaign expires.

  - `data.campaign.displayEndDate` (string,null)
    The date informing beneficiaries when is the end of the campaign.

  - `data.campaign.creationDate` (string)
    The date when the campaign was created.

  - `data.campaign.validMobilePhoneNumberRequiredToInitiatePayoutInstructions` (boolean)
    Indicates whether a valid mobile phone number is required to initiate payout instructions.If this is disabled payouts with no phone number will be sent to customers, but some payout methods might be disabled.

  - `data.campaign.emailTemplates` (object)
    The dictionary containing the template ids for given template type.If template type is not provided, the default template will be used.

  - `data.campaign.emailTemplates.InitiateEmail` (string)

  - `data.campaign.emailTemplates.ReminderEmail` (string)

  - `data.campaign.emailTemplates.FailureReinitiateEmail` (string)

  - `data.campaign.emailTemplates.OtpEmail` (string)

  - `data.campaign.emailTemplates.PushEmail` (string)

  - `data.details` (object)

  - `data.details.totalFundsReceived` (number,null)
    Total funds that landed in the campaign FBO aczcount

  - `data.details.stats` (object)

  - `data.details.stats.eligible` (object)

  - `data.details.stats.eligible.count` (integer)
    Number of payout instructions in this stage

  - `data.details.stats.eligible.amount` (number)
    Total monetary amount of payout instructions in this stage

  - `data.details.stats.eligible.percentage` (number)
    Percentage of eligible payout instructions that are in this stage

  - `data.details.stats.eligible.statuses` (array)
    List of payout instruction statuses that are included in this stage
    Enum: "Draft", "Ready", "PushInitiated", "Initiated", "InitiationFailed", "PayoutMethodSelected", "Requested", "Restored", "Reinitiated", "ExpiryRequested", "Fulfilled", "Expired", "Cancelled"

  - `data.details.stats.communicated` (object)

  - `data.details.stats.actioned` (object)

  - `data.details.stats.completed` (object)

  - `data.details.stats.excluded` (object)

## Response 401 fields (application/problem+json):

  - `type` (string,null)

  - `title` (string,null)

  - `status` (integer,null)

  - `detail` (string,null)

  - `instance` (string,null)

## Response 403 fields (application/problem+json):

  - `type` (string,null)

  - `title` (string,null)

  - `status` (integer,null)

  - `detail` (string,null)

  - `instance` (string,null)

## Response 404 fields (application/problem+json):

  - `type` (string,null)

  - `title` (string,null)

  - `status` (integer,null)

  - `detail` (string,null)

  - `instance` (string,null)