> ## 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. # Get Pique Campaign by ID > Retrieve a specific Pique Campaign by its unique identifier. ## OpenAPI ````yaml api-reference/openapi.json get /pique-campaign/{id} 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/{id}: get: tags: - Pique summary: Get Pique Campaign by ID description: | Retrieve a specific Pique Campaign by its unique identifier. operationId: getPiqueCampaign parameters: - name: id in: path description: Unique identifier of the Pique Campaign required: true schema: type: string pattern: ^[a-zA-Z0-9-_]+$ example: 1f089d37-5ebe-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: Campaign found and returned successfully content: application/json: schema: $ref: '#/components/schemas/PiqueCampaign' examples: Campaign Response: summary: Complete campaign details description: Campaign Response value: 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 '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. '404': description: Campaign not found or not accessible content: application/json: schema: $ref: '#/components/schemas/BuildXAPIError' examples: Not Found Error: summary: Campaign not found description: Not Found Error value: txId: Root=1-68d30006-614205915f11c2e02dc1dcd3 timestamp: 23-09-2025 08:16:06 errorCode: NOT_FOUND errorMessage: Not found. context: id: 1f061c3e-ed45-60e0-884d-85e4657e9d601 components: schemas: PiqueCampaign: type: object properties: id: type: string createdTime: type: string format: date-time description: >- The time when the entity was created in ISO 8601 format including milliseconds and timezone offset. example: '2025-05-13T15:07:15.036Z' updatedTime: type: string format: date-time description: >- The time when the entity was last updated in ISO 8601 format including milliseconds and timezone offset. example: '2025-05-13T15:07:15.036Z' createdBy: type: string description: The user who created the entity. updatedBy: type: string description: The user who last updated the entity. workspaceId: type: string description: The ID of the workspace to which this entity belongs. accountId: type: string name: type: string type: type: string enum: - BoostedPost - SyndicatedContent status: type: string enum: - Prepping - InProgress - Completed - Paused - NotStarted - Canceled startDate: type: string format: date isPublished: type: boolean campaignData: $ref: '#/components/schemas/PiqueCampaignData' campaignDataFileInfo: $ref: '#/components/schemas/UploadInfo' videoPerformanceFileInfo: $ref: '#/components/schemas/UploadInfo' platforms: type: array items: type: string targetViews: type: integer format: int32 beforeViews: type: integer format: int32 afterViews: type: integer format: int32 deliveredViews: type: integer format: int32 contentLink: type: string submissionNotes: type: string endDate: type: string format: date beforeImage: $ref: '#/components/schemas/UploadInfo' afterImage: $ref: '#/components/schemas/UploadInfo' BuildXAPIError: type: object properties: txId: type: string timestamp: type: string format: date-time errorCode: type: string errorMessage: type: string context: type: object additionalProperties: {} PiqueCampaignData: type: object properties: id: type: string createdTime: type: string format: date-time description: >- The time when the entity was created in ISO 8601 format including milliseconds and timezone offset. example: '2025-05-13T15:07:15.036Z' updatedTime: type: string format: date-time description: >- The time when the entity was last updated in ISO 8601 format including milliseconds and timezone offset. example: '2025-05-13T15:07:15.036Z' createdBy: type: string description: The user who created the entity. updatedBy: type: string description: The user who last updated the entity. workspaceId: type: string description: The ID of the workspace to which this entity belongs. campaignId: type: string totalViews: type: integer format: int32 totalClicks: type: integer format: int32 totalLikes: type: integer format: int32 totalCreators: type: integer format: int32 totalComments: type: integer format: int32 totalShares: type: integer format: int32 totalVideos: type: number format: double instagramViews: type: integer format: int32 instagramLikes: type: integer format: int32 instagramShares: type: integer format: int32 instagramComments: type: integer format: int32 tiktokViews: type: integer format: int32 tiktokLikes: type: integer format: int32 tiktokShares: type: integer format: int32 tiktokComments: type: integer format: int32 assetFolderLink: type: string rec1: type: string rec2: type: string rec3: type: string rec4: type: string UploadInfo: type: object properties: fileKey: type: string fileName: type: string url: type: string securitySchemes: AccessToken: type: http description: Bearer token authentication scheme: bearer bearerFormat: JWT APIKey: type: apiKey description: API Key authentication name: api-key in: header ````