Get Campaigns

Retrieves a list of all available campaigns for your organization

GET /organizations/campaigns

Try it

cURL

cURL

curl --request GET \
  --url https://api.growi.io/api/public/v1/organizations/campaigns \
  --header 'Authorization: Bearer <token>'

200

{
  "success": true,
  "campaigns": [
    {
      "id": 16425,
      "name": "Campaign Name",
      "campaign_type": "Campaign",
      "status": "Active"
    }
  ]
}

Retrieves a list of all available campaigns for your organization. This endpoint returns basic campaign information including campaign IDs, names, types, and statuses that can be used for filtering and organization purposes.

Request Parameters

This endpoint does not require any specific parameters, but standard authentication is required.

Parameter	Type	Description	Required
None	-	This endpoint does not accept additional parameters	-

Request Example

curl -X GET "https://api.growi.io/api/public/v1/organizations/campaigns" \
     -H "Authorization: Bearer YOUR_PUBLIC_API_KEY" \
     -H "Content-Type: application/json"

Response Example

{
  "success": true,
  "campaigns": [
    {
      "id": 16425,
      "name": "Campaign Name",
      "campaign_type": "Campaign",
      "status": "Active"
    },
    {
      "id": 16426,
      "name": "Summer Collection 2024",
      "campaign_type": "Contract",
      "status": "Paused"
    },
    {
      "id": 16427,
      "name": "Brand Ambassador Program",
      "campaign_type": "Ambassador Program",
      "status": "Active"
    }
  ]
}

Response Fields

Field	Type	Description
success	Boolean	Indicates whether the request was successful
campaigns	Array	Array of campaign objects
campaigns[].id	Integer	Unique identifier for the campaign
campaigns[].name	String	Display name of the campaign
campaigns[].campaign_type	String	Type of campaign (Campaign, Contract, Ambassador Program)
campaigns[].status	String	Current status of the campaign (Active, Paused, Canceled, Completed, Archived, Void)

Use Cases

• Campaign Filtering: Use campaign IDs to filter data in other API endpoints
• Campaign Management: Retrieve available campaigns for management interfaces
• Organization Setup: Get campaign information for initial application setup
• Reporting: Include campaign names and statuses in reports and analytics dashboards
• Status Monitoring: Track campaign statuses across your organization

Error Responses

{
  "error": "Not Authenticated"
}

Common error scenarios:

• 401 Unauthorized: Invalid or missing Bearer token
• 403 Forbidden: API key doesn’t have permission to access campaigns
• 422 Unprocessable Entity: Organization not found
• 500 Internal Server Error: Server-side error occurred

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200

application/json

Get your campaigns information

success · boolean

Example:

true

campaigns · object[]

Show child attributes

campaigns. id · integer

Unique identifier for the campaign

Example:

16425

campaigns. name · string

Display name of the campaign

Example:

"Campaign Name"

campaigns. campaign_type · enum<string>

Type of campaign

Available options: Campaign, Contract, Ambassador Program

Example:

"Campaign"

campaigns. status · enum<string>

Current status of the campaign

Available options: Active, Paused, Canceled, Completed, Archived, Void

Example:

"Active"