> ## Documentation Index > Fetch the complete documentation index at: https://docs.unblockedbrands.com/llms.txt > Use this file to discover all available pages before exploring further. # Search and filter Pique Campaigns > Search and retrieve Pique Campaigns with optional filtering and pagination. **Features:** - Search campaigns by name using keyword query - Filter by campaign status (Prepping, InProgress, Completed, Paused, NotStarted, Cancelled) - Filter by campaign type (BoostedPost, SyndicatedContent) - Pagination support with cursor-based navigation - Returns only published campaigns for branded users **Pagination:** - Use `cursor` parameter for next page navigation - `limit` controls page size (default: 20) - Response includes `items` array, `cursor`, and `hasMore` fields ## OpenAPI ````yaml api-reference/openapi.json get /pique-campaign openapi: 3.1.0 info: title: Unblocked Wallet Passes API description: Unblocked Wallet Passes API version: 1.0.0 servers: - url: https://api.ubpass.co/v1 description: Generated server url security: - AccessToken: [] - APIKey: [] tags: - name: Pique description: Get Pique Campaigns and their video performance data - name: Passport - Passes description: >- Create, update, retrieve, and delete wallet passes for Apple and Google platforms - name: Passport - Push Notifications description: Create, update, get, and delete wallet pass notifications - name: Passport - Locations description: Create, update, get, and delete wallet pass locations - name: Upload APIs description: Upload and manage pass assets and images paths: /pique-campaign: get: tags: - Pique summary: Search and filter Pique Campaigns description: > Search and retrieve Pique Campaigns with optional filtering and pagination. **Features:** - Search campaigns by name using keyword query - Filter by campaign status (Prepping, InProgress, Completed, Paused, NotStarted, Cancelled) - Filter by campaign type (BoostedPost, SyndicatedContent) - Pagination support with cursor-based navigation - Returns only published campaigns for branded users **Pagination:** - Use `cursor` parameter for next page navigation - `limit` controls page size (default: 20) - Response includes `items` array, `cursor`, and `hasMore` fields operationId: searchPiqueCampaign parameters: - name: query in: query description: Search keyword to filter campaigns by name (case-insensitive) required: false schema: type: string maxLength: 255 example: summer collection - name: cursor in: query description: >- Pagination cursor for fetching the next set of results. Use the 'cursor' value from the previous response. required: false schema: type: string example: 1f089d37-5ebe-6778-af59-99631cec7ab5 - name: limit in: query description: Number of campaigns to return per page (1-20, max 20) required: false schema: type: integer maximum: 20 minimum: 1 example: 20 - name: statusList in: query description: Filter campaigns by status. Multiple values allowed. required: false schema: type: array items: type: string enum: - Prepping - InProgress - Completed - Paused - NotStarted - Canceled example: InProgress,Completed - name: typeList in: query description: Filter campaigns by type. Multiple values allowed. required: false schema: type: array items: type: string enum: - BoostedPost - SyndicatedContent example: SocialPush,BrandDiscovery - name: id in: query description: Filter by specific campaign ID required: false schema: type: string pattern: ^[a-zA-Z0-9-_]+$ example: 1f089d37-5ebe-6778-af59-99631cec7ab5 - name: ids in: query description: Filter by a list of campaign IDs required: false schema: type: array items: type: string example: >- 1f089d37-5ebe-6778-af59-99631cec7ab5,1f089d37-5ebc-6778-af59-99631cec7ab5 - name: x-workspace-id in: header description: >- Workspace ID to perform the operation in. If not provided, system will use the first one assigned to the user required: false schema: type: string pattern: ^[a-zA-Z0-9-_]+$ example: 1f089d29-6f9c-66c2-af59-99631cec7ab5 responses: '200': description: Successfully retrieved campaigns content: application/json: schema: $ref: '#/components/schemas/BXPagedList' examples: Success Response: summary: Paginated list of campaigns description: Success Response value: 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 '400': description: Bad Request - Invalid parameters content: application/json: schema: $ref: '#/components/schemas/BuildXAPIError' '401': description: Unauthorized - Invalid or missing authentication content: application/json: schema: $ref: '#/components/schemas/BuildXAPIError' examples: Unauthorized Error: summary: Authentication failed description: Unauthorized Error value: txId: Root=1-68d3693c-26a3db2278c7668f5e086711 timestamp: 24-09-2025 03:45:00 errorCode: UNAUTHORIZED errorMessage: UNAUTHORIZED. components: schemas: BXPagedList: type: object properties: items: type: array items: {} cursor: type: string hasMore: type: boolean BuildXAPIError: type: object properties: txId: type: string timestamp: type: string format: date-time errorCode: type: string errorMessage: type: string context: type: object additionalProperties: {} securitySchemes: AccessToken: type: http description: Bearer token authentication scheme: bearer bearerFormat: JWT APIKey: type: apiKey description: API Key authentication name: api-key in: header ````