Campaign Builder API
  1. Entity Management
Campaign Builder API
  • Campaign
    • Create a new campaign
      POST
    • Update an existing campaign
      PATCH
    • Delete a campaign
      DELETE
    • List campaigns with filtering and pagination
      GET
    • Simple campaign listing
      GET
    • Get a single campaign
      GET
  • Campaign Bulk Operations
    • Archive multiple campaigns
      POST
  • Booking
    • Create new booking
      POST
    • Update booking
      PATCH
    • Create segmentation rule for booking
      POST
    • Get single booking by ID
      GET
    • Confirm booking
      POST
    • Get booking assets with pagination
      GET
    • Update asset status for booking
      PATCH
    • Update booking segmentation
      POST
    • Refresh booking segmentation
      POST
    • Export booking locations as CSV
      GET
  • Booking Campaign Integration
    • Associate campaigns with booking
      PATCH
    • Remove campaign from booking association
      POST
  • Entity Management
    • Create new entity
      POST
    • Update entity
      PATCH
    • Get single entity
      GET
    • Get entity statistics
      GET
    • Duplicate entities
      POST
    • Archive entities
      PATCH
    • Restore archived entities
      PATCH
  • Campaign Management
    • Publish a campaign
    • Send campaign preview email
  • Campaign Statistics
    • Get campaign statistics
  • Campaign Reports
    • Get available reports for a campaign
  • Campaign Pricing
    • Get campaign item pricing information
  • Campaign Asset Management
    • Get campaign item overview
    • Get priority allocations for a campaign item
    • Update priority allocations for a campaign item
  • Campaign Import
    • Export
      • Duplicate an existing campaign
      • Import artwork files for campaign items
  • Campaign Items
    • Create a new campaign item
    • Get a single campaign item
    • Update a campaign item
    • Delete a campaign item
    • List campaign items
    • Create multiple campaign items
    • Get MOS information for a campaign item
    • Delete MOS information for a campaign item
  • Campaign Items Import
    • Export
      • Export campaign items as CSV
      • Import campaign items from structured data
  • Campaign Artwork
    • Create campaign artworks in bulk
    • List campaign artworks with filtering
    • Update an existing campaign artwork
  • Campaign Artwork Management
    • Assign artworker to multiple campaign artworks
    • Cancel multiple campaign artworks
    • Duplicate multiple campaign artworks
    • Remove multiple campaign artworks
  • Schemas
    • Schemas
      • User
      • Task
      • TaskListResponse
      • ErrorResponse
      • TaskCreateRequest
      • TaskResponse
      • TaskUpdateRequest
      • UserTasksResponse
      • TaskAssignRequest
      • Opportunity
      • OpportunityResponse
      • OpportunityUpdateRequest
      • OpportunityListResponse
      • OpportunityCreateRequest
      • OpportunityTier
      • OpportunityTierResponse
      • OpportunityTierUpdateRequest
      • OpportunityTierCreateRequest
      • OpportunityTierListResponse
      • OpportunityTierAsset
      • OpportunityTierAssetResponse
      • OpportunityTierAssetUpdateRequest
      • OpportunityTierAssetCreateRequest
      • OpportunityTierAssetListResponse
      • EntityInstanceFormBase
      • EntityInstanceFormResponse
      • EntityInstanceFormUpdate
      • EntityInstanceFormCreate
      • FormGroupBase
      • FormGroupResponse
      • FormGroupCreate
      • FormGroupUpdate
      • FormFieldLabel
      • FormFieldOption
      • FormFieldIntegrationConfig
      • FormFieldLinkFilter
      • FormFieldBase
      • FormFieldResponse
      • FormFieldCreate
      • FormFieldUpdate
      • EntityInstanceFormSubmissionCreate
      • EntityInstanceFormSubmissionResponse
      • EntityInstanceFormConfigResponse
      • EntityInstanceFormSubmissionFull
      • Advertiser
      • AdvertiserListResponse
      • AdvertiserCreateRequest
      • AdvertiserResponse
      • AdvertiserUserEntity
      • AdvertiserUserBatchListResponse
      • AdvertiserUpdateRequest
      • AdvertiserUser
      • AdvertiserUserListResponse
      • AdvertiserInvite
      • AdvertiserInviteListResponse
      • AdvertiserInviteCreateRequest
      • AdvertiserInviteResponse
      • BulkAssociationCreateRequest
      • OpportunityAdvertiserAssociation
      • BulkAssociationCreateResponse
      • OpportunityAdvertiserUser
      • OpportunityAdvertiser
      • OpportunityAdvertiserListResponse
      • OpportunityAdvertiserUsersResponse
      • DeleteResponse
      • UnavailableAssetMapping
      • BookingUpdateResponse
      • BookingResponse
      • OpportunityAcceptanceResponse
      • OpportunityAcceptanceDetails
      • OpportunityAcceptanceListResponse
      • OpportunityAcceptanceRequest
      • OpportunityAcceptanceResult
      • FormTemplate
      • FormTemplateResponse
      • FormTemplateListResponse
      • FormTemplateCreateRequest
      • FormTemplateUpdateRequest
      • FormTemplateField
      • FormTemplateGroup
      • FormTemplateConfigResponse
      • FormTemplateGroupListResponse
      • FormTemplateGroupCreateRequest
      • FormTemplateGroupUpdateRequest
      • FormTemplateFieldListResponse
      • FormTemplateFieldCreateRequest
      • FormTemplateFieldUpdateRequest
      • FormTemplateFieldMoveGroupRequest
      • SegmentationRuleFilter
      • SegmentationRuleFilterGroup
      • SegmentationRuleNestedFilterGroup
      • SegmentationRuleRules
      • SegmentationRuleItem
      • SegmentationRuleCreate
      • BookingCreate
      • BookingSegmentationRuleRequest
      • BookingErrorResponse
      • BookingAssetResponse
      • BookingAssetListResponse
      • AssetStatusUpdateRequest
      • AssetStatusUpdateResponse
      • BookingUpdateRequest
      • LocationExportResponse
      • CampaignAllocationRule
      • CampaignDefaults
      • CampaignPriceMeta
      • CampaignNotificationEvent
      • CampaignCreateRequest
      • CampaignStatus
      • CampaignState
      • CampaignElementGroup
      • CampaignAssetGroup
      • Campaign
      • CampaignListResponse
      • CampaignUpdateRequest
      • CampaignItemStatus
      • CampaignItemAllocationRule
      • CampaignItem
      • CampaignItemCreateRequest
      • CampaignItemUpdateRequest
      • CampaignItemListResponse
      • CampaignArtworkCategoryGroup
      • CampaignArtworkTargetAsset
      • CampaignArtwork
      • CampaignArtworkListResponse
      • CampaignArtworkUpdateRequest
      • FormPage
      • FormGroupWithFields
      • FormPageResponse
      • FormPageUpdateRequest
      • FormPageListResponse
      • PageConfigResponse
      • FieldValuesResponse
      • FieldValueOption
      • SearchableFieldValue
      • SearchableValuesResponse
      • FormGroupCreateRequest
      • FormGroupUpdateRequest
      • FieldReorderRequest
      • FieldReorderResponse
      • BatchFieldOperation
      • BatchFieldOperationResponse
      • EntityCreateRequest
      • EntityResponse
      • EntityUpdateRequest
      • EntityStatisticsResponse
      • EntityDuplicationRequest
      • EntityDuplicationResponse
      • EntityBulkOperationRequest
      • EntityBulkOperationResponse
  1. Entity Management

Get single entity

GET
/page/{entityPath}/{entityId}
Retrieves a single entity by ID through the form page configuration. The response includes
all core entity fields plus custom field data in the meta object.
Population: For asset entities, element quantities and features are automatically populated.
Meta Object: Custom field data is returned in the meta object using the field ID + field name format.

Request

Authorization
API Key
Add parameter in header
Authorization
Example:
Authorization: ********************
or
Path Params

Responses

🟢200OK
application/json
Entity retrieved successfully
Body

🟠404Not Found
🔴500Internal Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://prod.your-api-server.com/page/asset/' \
--header 'Authorization: <api-key>'
Response Response Example
200 - Asset with custom field data and populated references
{
    "_id": "e6fb1b70-5295-11f0-b0ba-adfe69a423b8",
    "name": "Q1 Display Asset",
    "code": "Q1_DISPLAY_001",
    "description": "Primary display asset for Q1 campaign",
    "isLocked": false,
    "isActive": true,
    "meta": {
        "91ce6620-5295-11f0-b0ba-adfe69a423b8_assetName": "Custom Display Name",
        "a2df7730-5295-11f0-b0ba-adfe69a423b8_priority": "high",
        "b3e08840-5295-11f0-b0ba-adfe69a423b8_releaseDate": "2024-03-15",
        "additionalMetadata": "Some extra data"
    },
    "elementsQty": [
        {
            "elementId": {
                "_id": "h8id3d90-5295-11f0-b0ba-adfe69a423b8",
                "name": "Header Banner",
                "productCode": "HEADER_001"
            },
            "qty": 2
        },
        {
            "elementId": {
                "_id": "i9je4ea0-5295-11f0-b0ba-adfe69a423b8",
                "name": "Footer Logo",
                "productCode": "FOOTER_001"
            },
            "qty": 1
        }
    ],
    "features": [
        {
            "featureId": {
                "_id": "j0kf5fb0-5295-11f0-b0ba-adfe69a423b8",
                "name": "Interactive Elements",
                "code": "INTERACTIVE"
            }
        },
        {
            "featureId": {
                "_id": "k1lg6gc0-5295-11f0-b0ba-adfe69a423b8",
                "name": "Mobile Responsive",
                "code": "MOBILE_RESP"
            }
        }
    ],
    "createdAt": "2024-03-15T10:30:00.000Z",
    "updatedAt": "2024-03-15T10:30:00.000Z",
    "__v": 0
}
Modified at 2025-09-25 10:04:16
Previous
Update entity
Next
Get entity statistics
Built with