Skip to main content
GET
/
pique-campaign
Search and filter Pique Campaigns
curl --request GET \
  --url https://api.ubpass.co/v1/pique-campaign \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "1f0aeeff-c45d-64e6-a63e-e1179780e82f",
      "createdTime": "2025-10-22T02:37:00.169Z",
      "updatedTime": "2025-10-22T02:59:23.866Z",
      "createdBy": "1efe824d-1c2a-63b4-81ed-eb91480f4c4e",
      "updatedBy": "1efe824d-1c2a-63b4-81ed-eb91480f4c4e",
      "workspaceId": "1f08a693-3d4b-6d6d-8b30-81ed80c53926",
      "accountId": "1f08a693-3d55-69ae-8b30-81ed80c53926",
      "name": "BoostedPost Campaign 1761100620",
      "type": "BoostedPost",
      "status": "NotStarted",
      "startDate": "2025-12-01",
      "isPublished": false,
      "campaignData": {},
      "videoPerformanceFileInfo": {
        "fileName": "campaign-videos.csv",
        "url": "http://localhost:9012/bx-wallet-passes-setup-dev/pique-campaigns/1f0aeeff-c45d-64e6-a63e-e1179780e82f/campaign-videos.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20251022T232937Z&X-Amz-SignedHeaders=host&X-Amz-Expires=60&X-Amz-Credential=minioadmin%2F20251022%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=e05a5cae5730062d61c24caaf688923a6aeaacd4a899bcd7705f353ed8c0e097"
      },
      "platforms": [
        "Instagram",
        "TikTok"
      ],
      "targetViews": 100000,
      "beforeViews": 50000,
      "afterViews": 450000,
      "deliveredViews": 2000,
      "contentLink": "https://example.com/boosted-campaign-content",
      "submissionNotes": "Boosted campaign test",
      "beforeImage": {
        "fileName": "beforeImage.png",
        "url": "http://localhost:9012/bx-wallet-passes-setup-dev/pique-campaigns/1f0aeeff-c45d-64e6-a63e-e1179780e82f/beforeImage.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20251022T232937Z&X-Amz-SignedHeaders=host&X-Amz-Expires=59&X-Amz-Credential=minioadmin%2F20251022%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=45d22790c4d31620e60783bb4c3b6c87ffdc6cbb8d61705832e32a0ee772ed22"
      },
      "afterImage": {
        "fileName": "afterImage.png",
        "url": "http://localhost:9012/bx-wallet-passes-setup-dev/pique-campaigns/1f0aeeff-c45d-64e6-a63e-e1179780e82f/afterImage.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20251022T232937Z&X-Amz-SignedHeaders=host&X-Amz-Expires=60&X-Amz-Credential=minioadmin%2F20251022%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=b7336f06e64514acf03173497642438d786ee239cc0039f25eba41fd803f6eb6"
      }
    }
  ],
  "cursor": "1f0aeeff-c45d-64e6-a63e-e1179780e82f",
  "hasMore": true
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication

Headers

​
x-workspace-id
string

Workspace ID to perform the operation in. If not provided, system will use the first one assigned to the user

Pattern: ^[a-zA-Z0-9-_]+$

Query Parameters

​
query
string

Search keyword to filter campaigns by name (case-insensitive)

Maximum string length: 255
​
cursor
string

Pagination cursor for fetching the next set of results. Use the 'cursor' value from the previous response.

​
limit
integer

Number of campaigns to return per page (1-20, max 20)

Required range: 1 <= x <= 20
​
statusList
enum<string>[]

Filter campaigns by status. Multiple values allowed.

Available options:
Prepping,
InProgress,
Completed,
Paused,
NotStarted,
Canceled
​
typeList
enum<string>[]

Filter campaigns by type. Multiple values allowed.

Available options:
BoostedPost,
SyndicatedContent
​
id
string

Filter by specific campaign ID

Pattern: ^[a-zA-Z0-9-_]+$
​
ids
string[]

Filter by a list of campaign IDs

Response

Successfully retrieved campaigns

​
items
any[]
​
cursor
string
​
hasMore
boolean