Get unified promotions with id

get https://{host}/v3/unifiedPromotions/6903253184daf5486232dec9

Endpoint for GET /v3/unifiedPromotions/6903253184daf5486232dec9

This endpoint retrieves a paginated list of all unified promotions within the organization, allowing filtering and sorting.

curl --location '[https://eu.api.capillarytech.com/v3/unifiedPromotions/6903253184daf5486232dec9](https://eu.api.capillarytech.com/v3/unifiedPromotions/6903253184daf5486232dec9)' \

--header 'Authorization: Basic Z2VvcmdlLmJ1kx3YzI4ZjU4ZjY3MmNhZjY1ZmY=' \

--header 'Cookie: _cfuvid=FpEQ1IKxM7IelsonuP1pTKDZjT_pAkTzJBGUZqKDqpA-1761801071752-0.0.1.1-604800000'

Prerequisites

Authentication: Basic or OAuth authentication.
Default access group

Resource information


URI	/v3/unifiedPromotions/{Promotion id}
HTTP Method	GET
Pagination	Yes
Batch support	No

Rate limit

Demo and Testing Clusters: 1,000 requests per minute per API key
Other Organizations: The rate limit is brand-specific.

To modify the limit, create a ticket with the Capillary Product support team.

Query Parameters

Field	Type	Required	Description
searchText	string	Optional	Specifies a search term to filter promotions by name or description. Use this to quickly find promotions containing specific keywords, like "Holiday Bonus". Supported Values: String. Example: "Holiday Bonus"
status	Array (string)	Optional	Specifies an array of statuses to filter by, allowing retrieval of only promotions in specific states. E.g., Filter for only ACTIVE and UPCOMING promotions to see what's currently running or scheduled. Supported Values: Array containing DRAFT, ACTIVE, PAUSED, PENDING_APPROVAL, STOPPED, SNAPSHOT, LIVE, UPCOMING, COMPLETED, PUBLISH_FAILED. Example: ["ACTIVE", "UPCOMING"]
sortBy	string	Optional	Specifies the field name to sort the results by. Use startDate to order promotions chronologically by when they begin. Supported Values: String representing a sortable field name (e.g., "name", "startDate", "lastModifiedOn"). Example: "startDate"
sortOrder	string	Optional	Specifies the sort order (ascending or descending). Use DESC with startDate to see the most recently started promotions first. Supported Values: ASC, DESC. Example: "DESC"
page	integer	Optional	Specifies the page number to retrieve (0-indexed) for pagination. Use 0 for the first page, 1 for the second, etc. Supported Values: Non-negative integer. Example: 1 (retrieves the second page)
size	integer	Optional	Specifies the number of promotions to return per page. Set to 20 to retrieve 20 promotions at a time. Supported Values: Positive integer. Example: 20
includeDraftDetails	boolean	Optional	Indicates whether to include details about the draft version if a promotion exists as both a live version and a draft. true includes this extra draft info. Supported Values: true, false. Example: true
includeParentDetails	boolean	Optional	Indicates whether to include details about the parent promotion if the retrieved promotion is a version or clone. true includes info about the original promotion. Supported Values: true, false. Example: false
filters	Object	Yes	Specifies a map of key-value pairs for additional, potentially custom filtering beyond the standard parameters. Even if no filters are needed, an empty object `{}` must be sent. Supported Values: Object with string keys and string values.

Example response

{
    "data": {
        "metadata": {
            "name": "Efd Activity Based Prom",
            "description": "Enrollment for all members, requires activity-based opt-in.",
            "programId": "HiddenGemDefaultProgram_ID",
            "orgId": 100458,
            "startDate": "2025-11-27T00:00:00Z",
            "endDate": "2025-12-27T23:59:59Z",
            "timezoneName": "Asia/Kolkata",
            "promotionType": "LOYALTY",
            "status": "DRAFT",
            "promoIdentifer": null,
            "promotionId": 0,
            "createdOn": "2025-10-30T08:43:29Z",
            "lastModifiedOn": "2025-10-30T08:43:29Z",
            "createdBy": 0,
            "lastModifiedBy": 0,
            "loyaltyEarningType": null,
            "version": null,
            "draftDetails": null,
            "loyaltyConfigMetaData": {
                "isStackable": false,
                "isConsideredForRanking": false,
                "isExclusive": false,
                "isAlwaysApply": false,
                "skipEarnedDateCheckOnRedeem": null
            },
            "promotionMetadata": null,
            "commonStrategies": null,
            "promotionMode": "UNIFIED"
        },
        "customerEnrolment": {
            "enrolmentMethod": "TRANSACTION"
        },
        "activities": [
            {
                "type": "SINGLE",
                "id": "activity_reward_trigger",
                "type": "SINGLE",
                "name": "Main Reward Activity",
                "commonCycleActionMapping": [
                    {
                        "cycle": "cycle_promo_period",
                        "actions": [
                            {
                                "id": "action_award_points",
                                "actionName": "AWARD_CURRENCY",
                                "actionClass": "com.capillary.loyalty.engine.actor.promotion.actions.AwardCurrency",
                                "mandatoryPropertiesValues": {
                                    "POINTS_TO_AWARD": "100",
                                    "CURRENCY_IDENTIFIER": "POINTS"
                                }
                            }
                        ],
                        "startDate": "2025-11-27",
                        "endDate": "2025-12-27"
                    }
                ],
                "event": "TransactionAdd",
                "allCycles": []
            }
        ],
        "comments": null,
        "parentId": null,
        "parentDetails": null,
        "version": 1,
        "limits": [],
        "liabilityOwnerSplitInfo": [],
        "id": "6903253184daf5486232dec9",
        "workflowMetadata": {
            "enrolment": {
                "basedOn": null,
                "activities": null,
                "audienceMapping": null,
                "restrictions": null
            },
            "optin": {
                "basedOn": "ACTIVITY",
                "audienceMapping": null,
                "activities": [
                    {
                        "type": "SINGLE",
                        "id": "activity_optin_trigger",
                        "type": "SINGLE",
                        "name": "Opt-in Trigger Activity",
                        "event": "TransactionAdd",
                        "allCycles": []
                    }
                ],
                "restrictions": null
            }
        },
        "communicationApprovalStatus": null
    },
    "errors": null,
    "warnings": null
}

Response parameters

Field	Type	Description
data	Object	Defines the main data object containing pagination details and the list of promotions. Possible Values: A valid PageUnifiedPromotion object.
.totalElements	integer (int64)	Specifies the total number of promotions found matching the filter criteria across all pages. Possible Values: Non-negative integer.
.totalPages	integer (int32)	Specifies the total number of pages available based on the size parameter. Possible Values: Non-negative integer.
.size	integer (int32)	Specifies the number of items requested per page (reflects the size query parameter). Possible Values: Positive integer.
.content	Array (Object)	Defines the list of UnifiedPromotion objects for the current page. Possible Values: Array of UnifiedPromotion objects.
..id	String	Specifies the unique system-generated identifier for the unified promotion. Possible Values: System-generated unique string ID.
..metadata	Object	Defines the object containing all metadata for the promotion (Metadata). Possible Values: A valid Metadata object.
...name	String	Specifies the name of the promotion. Possible Values: String.
...description	String	Specifies the description of the promotion. Possible Values: String.
...programId	String	Specifies the program ID associated with the promotion. Possible Values: String or Integer Program ID.
...orgId	Integer (int64)	Specifies the organization ID. Possible Values: Integer Org ID.
...startDate	String (date-time)	Specifies the start date and time of the promotion in ISO 8601 format. Possible Values: ISO 8601 date-time string.
...endDate	String (date-time)	Specifies the end date and time of the promotion in ISO 8601 format. Possible Values: ISO 8601 date-time string.
...timezoneName	String	Specifies the timezone name for the promotion's schedule. Possible Values: Valid IANA Time Zone Database name or null.
...promotionType	String	Specifies the type of promotion. Possible Values: String representing promotion type (e.g., "LOYALTY", "GENERIC", "DISCOUNT").
...status	String	Indicates the current status of the promotion. Possible Values: DRAFT, ACTIVE, PAUSED, PENDING_APPROVAL, STOPPED, SNAPSHOT, LIVE, UPCOMING, COMPLETED, PUBLISH_FAILED.
...promoIdentifer	String	Specifies a unique string identifier for the promotion (may be system-generated). Possible Values: String or null.
...promotionId	Integer (int32)	Specifies the legacy numerical promotion ID (system assigned). Possible Values: Integer.
...createdOn	String (date-time)	Specifies the creation timestamp (system-set). Possible Values: ISO 8601 date-time string.
...lastModifiedOn	String (date-time)	Specifies the last modification timestamp (system-set). Possible Values: ISO 8601 date-time string.
...createdBy	Integer (int32)	Specifies the user ID of the creator (system-set). Possible Values: Integer user ID.
...lastModifiedBy	Integer (int32)	Specifies the user ID of the last modifier (system-set). Possible Values: Integer user ID.
...loyaltyEarningType	String	Indicates the loyalty earning type. Possible Values: DIRECT_EARN, ISSUE_AND_EARN, null.
...version	String	Specifies the version string of the promotion (system managed). Possible Values: String version identifier or null.
...draftDetails	Object	Defines details if the promotion is a draft (DraftDetails). Included if includeDraftDetails is true. Possible Values: A valid DraftDetails object or null.
....id	String	Specifies the draft's unique ID. Possible Values: String ID.
....status	String	Specifies the draft's status. Possible Values: String status.
....version	Integer (int32)	Specifies the draft version number. Possible Values: Integer.
....lastModifiedBy	Integer (int32)	Specifies the user who last modified the draft. Possible Values: Integer user ID.
....lastModifiedOn	String (date-time)	Specifies when the draft was last modified. Possible Values: ISO 8601 date-time string.
...loyaltyConfigMetaData	Object	Defines loyalty-specific configurations (LoyaltyConfigMetaDto). Possible Values: A valid LoyaltyConfigMetaDto object.
....isStackable	Boolean	Indicates if the promotion is stackable. Possible Values: true, false.
....isConsideredForRanking	Boolean	Indicates if the promotion is considered for ranking. Possible Values: true, false.
....isExclusive	Boolean	Indicates if the promotion is exclusive. Possible Values: true, false.
....isAlwaysApply	Boolean	Indicates if the promotion should always apply. Possible Values: true, false.
....skipEarnedDateCheckOnRedeem	Boolean	Indicates if the earned date check should be skipped on redemption. Possible Values: true, false.
...promotionMetadata	Array (Object)	Defines a list of custom key-value metadata pairs (PromotionMetadata). Possible Values: Array of PromotionMetadata objects or null.
....isBrandDefined	String	Specifies if the metadata is defined by the brand. Possible Values: String representing boolean.
....key	String	Specifies the metadata key. Possible Values: String.
....value	String	Specifies the metadata value. Possible Values: String.
...commonStrategies	Object	Defines common strategies, like expiry (CommonStrategies). Possible Values: A valid CommonStrategies object or null.
....expiry	Array (Object)	Defines a list of expiry strategies (StrategyInfo). Possible Values: Array of StrategyInfo objects.
.....strategyTypeId	Integer (int32)	Specifies the strategy type ID. Possible Values: Integer ID.
.....propertyValues	String	Specifies the property values for the strategy. Possible Values: JSON string.
.....owner	String	Specifies the owner of the strategy. Possible Values: String.
.....updatedViaNewUI	Boolean	Indicates if the strategy was updated via the new UI. Possible Values: true, false.
.....useCommonExpiryStrategy	Boolean	Indicates if the common expiry strategy is used. Possible Values: true, false.
.....strategyRef	String	Specifies the strategy reference. Possible Values: String.
.....strategySubType	String	Indicates the strategy sub-type. Possible Values: ROLLING_EXPIRY_STRATEGY, DEFAULT.
...promotionMode	String	Indicates the promotion mode. Possible Values: LEGACY, UNIFIED.
..customerEnrolment	Object	Defines the customer enrolment rules (CustomerEnrolment). Possible Values: A valid CustomerEnrolment object.
...enrolmentMethod	String	Indicates the method of customer enrolment. Possible Values: TRANSACTION, IMPORT, AUDIENCE_FILTER.
...audienceGroups	Array (Object)	Defines a list of audience groups for enrolment (AudienceGroupDetails). Possible Values: Array of AudienceGroupDetails objects or null.
....audienceGroupId	Integer (int64)	Specifies the unique ID for the audience group. Possible Values: Integer ID.
....audienceGroupName	String	Specifies the name of the audience group. Possible Values: String.
....description	String	Specifies the description of the audience group. Possible Values: String.
..activities	Array (Object)	Defines a list of activities (SingleActivity or GroupActivity). Possible Values: Array of valid Activity objects.
...id	String	Specifies the unique ID for the activity. Possible Values: String ID.
...type	String	Specifies the type of the activity. Possible Values: SINGLE, GROUP.
...name	String	Specifies the name of the activity. Possible Values: String.
...refId	String	Specifies the reference ID for the activity. Possible Values: String or null.
...parentId	String	Specifies the parent activity's ID. Possible Values: String ID or null.
...commonCycleActionMapping	Array (Object)	Defines action mappings for common cycles (CycleActionMapping). Possible Values: Array of CycleActionMapping objects.
....cycle	String	Specifies the cycle name/ID. Possible Values: String ID.
....defaultValue	Number (double)	Specifies the default value for the action. Possible Values: Number or null.
....actions	Array (Object)	Defines a list of actions (Action). Possible Values: Array of Action objects.
.....id	String	Specifies the action ID. Possible Values: String ID.
.....actionName	String	Specifies the action name. Possible Values: String representing a valid action name.
.....actionClass	String	Specifies the action class. Possible Values: Fully qualified Java class name string.
.....description	String	Specifies the action description. Possible Values: String or null.
.....mandatoryPropertiesValues	Object	Defines key-value pairs for mandatory properties. Possible Values: Object with string keys/values.
.....mandatoryComplexPropertiesValues	Object	Defines key-value pairs for mandatory complex properties. Possible Values: Object with string keys and object values, or null.
.....embeddedStrategies	Array (Object)	Defines a list of embedded StrategyInfo objects. Possible Values: Array of StrategyInfo objects or null.
....startDate	String (date-time)	Specifies the cycle mapping start date. Possible Values: Date or date-time string, or null.
....endDate	String (date-time)	Specifies the cycle mapping end date. Possible Values: Date or date-time string, or null.
....rulesetId	String	Specifies the cycle mapping ruleset ID. Possible Values: String ID or null.
...rulesetId	String	Specifies the ruleset ID for the activity. Possible Values: String ID or null.
...cycles	Array (Object)	Defines a list of general cycles (Cycle). Possible Values: Array of Cycle objects or null.
--- Fields specific to SingleActivity ---
...event	String	Specifies the event associated with the single activity. Possible Values: String event name.
...ruleExpression	String	Specifies the rule expression for the single activity. Possible Values: String DSL or null.
...expJSON	String	Specifies the rule expression in JSON format. Possible Values: JSON string or null.
...frequencyType	String	Specifies the frequency type. Possible Values: String or null.
...targetEvaluationType	String	Specifies the target evaluation type. Possible Values: String or null.
...targetCycleStartDate	String (date-time)	Specifies the target cycle start date. Possible Values: ISO 8601 date-time string or null.
...targetCycleEndDate	String (date-time)	Specifies the target cycle end date. Possible Values: ISO 8601 date-time string or null.
...activityCycles	Array (Object)	Defines activity-specific cycles (ActivityCycle). Possible Values: Array of ActivityCycle objects or null.
...milestones	Array (Object)	Defines milestones (Milestone). Possible Values: Array containing max one Milestone object, or null.
...allCycles	Array (Object)	Defines a list of all cycles. Possible Values: Array of cycle objects or null.
--- Fields specific to GroupActivity ---
...event	String	Specifies the event associated with the group activity. Possible Values: String event name or null.
...combinationType	String	Indicates how child activities are combined. Possible Values: ANY, ALL.
...children	Array (Object)	Defines a nested list of child GroupActivity or SingleActivity objects. Possible Values: Array of Activity objects.
...ruleExpression	String	Specifies the rule expression for the group activity. Possible Values: String DSL or null.
...expJSON	String	Specifies the rule expression in JSON format. Possible Values: JSON string or null.
..comments	String	Specifies any comments on the promotion. Possible Values: String or null.
..parentId	String	Specifies the ID of the parent promotion. Possible Values: String promotion ID or null.
..parentDetails	Object	Defines details of the parent promotion (ParentDetails). Included if includeParentDetails is true. Possible Values: A valid ParentDetails object or null.
...id	String	Specifies the parent promotion ID. Possible Values: String ID.
...status	String	Specifies the parent promotion status. Possible Values: Status string (e.g., ACTIVE, DRAFT).
...version	Integer (int32)	Specifies the parent promotion version. Possible Values: Integer.
...lastModifiedBy	Integer (int32)	Specifies the user who last modified the parent. Possible Values: Integer user ID.
...lastModifiedOn	String (date-time)	Specifies when the parent was last modified. Possible Values: ISO 8601 date-time string.
..version	Integer (int32)	Specifies the version number of the promotion. Possible Values: Integer version number (system-managed).
..limits	Array (Object)	Defines a list of limits for the promotion (Limit). Possible Values: Array of Limit objects.
...id	Integer (int64)	Specifies the limit ID. Possible Values: Integer ID (system-assigned).
...entityScope	String	Indicates the scope of the limit. Possible Values: PROGRAM, PROMOTION.
...granularity	String	Indicates the granularity of the limit. Possible Values: OVERALL, USER, PER_ACTIVITY.
...entityId	Integer (int64)	Specifies the entity ID the limit applies to. Possible Values: Integer ID.
...actionType	String	Indicates the action type being limited. Possible Values: AWARD_CURRENCY, AWARD_BADGE.
...actionSubTypeId	String	Specifies the action sub-type ID. Possible Values: String identifier.
...limitType	String	Indicates the type of limit. Possible Values: SUM, COUNT.
...limitValue	Number	Specifies the value of the limit. Possible Values: Number.
...period	Object	Defines the time period for the limit (LimitPeriod). Possible Values: A valid LimitPeriod object.
....id	Integer (int64)	Specifies the period ID. Possible Values: Integer ID (system-assigned).
....periodType	String	Indicates the type of period. Possible Values: MOVING_WINDOW, FIXED_CALENDAR_WINDOW, NON_PERIOD_BASED, FIXED_WINDOW.
....periodUnit	String	Indicates the unit for the period. Possible Values: DAYS, WEEKS, MONTHS, null.
....periodValue	Integer (int32)	Specifies the value for the period. Possible Values: Integer or null.
....periodStartDay	String	Indicates the start day for weekly periods. Possible Values: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, null.
....startDate	String (date-time)	Specifies the fixed start date for the period. Possible Values: ISO 8601 date-time string or null.
....endDate	String (date-time)	Specifies the fixed end date for the period. Possible Values: ISO 8601 date-time string or null.
...createdOn	String (date-time)	Specifies the creation timestamp of the limit. Possible Values: ISO 8601 date-time string (system-set).
...createdBy	Integer (int64)	Specifies the user ID of the limit creator. Possible Values: Integer user ID (system-set).
...lastUpdatedOn	String (date-time)	Specifies the last update timestamp of the limit. Possible Values: ISO 8601 date-time string (system-set).
...lastUpdatedBy	Integer (int64)	Specifies the user ID of the last updater. Possible Values: Integer user ID (system-set).
...active	Boolean	Indicates if the limit is active. Possible Values: true, false.
..liabilityOwnerSplitInfo	Array (Object)	Defines how liability is split (LiabilityOwnerSplitInfo). Possible Values: Array of LiabilityOwnerSplitInfo objects.
...orgId	Integer (int32)	Specifies the organization ID. Possible Values: Integer Org ID.
...liabilityOwnerId	Integer (int32)	Specifies the liability owner ID. Possible Values: Integer ID.
...componentId	Integer (int32)	Specifies the component ID. Possible Values: Integer ID.
...componentType	String	Indicates the component type. Possible Values: PROGRAM, PROMOTION.
...createdBy	Integer (int32)	Specifies the user ID of the creator. Possible Values: Integer user ID.
...ratio	Number (double)	Specifies the liability split ratio. Possible Values: Number between 0 and 1.
...liabilityOwnerName	String	Specifies the liability owner's name. Possible Values: String.
...liabilityOwnerType	String	Indicates the liability owner's type. Possible Values: PARTNER, PROGRAM.
...active	Boolean	Indicates if the split info is active. Possible Values: true, false.
..workflowMetadata	Object	Defines workflow metadata for enrolment and opt-in (WorkflowMetadata). Possible Values: A valid WorkflowMetadata object or null.
...enrolment	Object	Defines enrolment workflow details (Enrolment). Possible Values: A valid Enrolment object or empty object .
....basedOn	String	Indicates the basis for enrolment. Possible Values: ACTIVITY, AUDIENCE, EXTERNAL_TRIGGER, null.
....activities	Array (Object)	Defines activities (SingleActivity/GroupActivity) triggering enrolment. Possible Values: Array of Activity objects or null.
....audienceMapping	Array (Object)	Defines audience mappings (AudienceMapping) for enrolment. Possible Values: Array of AudienceMapping objects or null.
.....groupId	Integer (int64)	Specifies the group ID. Possible Values: Integer ID.
.....groupName	String	Specifies the group name. Possible Values: String.
....restrictions	Object	Defines enrolment restrictions (PromotionRestrictions). Possible Values: A valid PromotionRestrictions object or null.
.....optinExpiryBasedOn	Object	Defines opt-in expiry (PromotionExpiryConfig). Possible Values: A valid PromotionExpiryConfig object or null.
.....enrolmentExpiryBasedOn	Object	Defines enrolment expiry (PromotionExpiryConfig). Possible Values: A valid PromotionExpiryConfig object or null.
.....optinLimitPerCustomer	Object	Defines opt-in limit (PromotionRestrictionsConfig). Possible Values: A valid PromotionRestrictionsConfig object or null.
.....maxRedemptionsPerEarnPerCustomer	Object	Defines redemption limit (PromotionRestrictionsConfig). Possible Values: A valid PromotionRestrictionsConfig object or null.
.....enrolmentLimitPerPromotion	Object	Defines total enrolment limit (PromotionRestrictionsConfig). Possible Values: A valid PromotionRestrictionsConfig object or null.
.....enrolmentLimitPerCustomer	Object	Defines enrolment limit per customer (PromotionRestrictionsConfig). Possible Values: A valid PromotionRestrictionsConfig object or null.
.....maxPointsPerEarnPerCustomer	Object	Defines max points per earn limit (PromotionRestrictionsConfig). Possible Values: A valid PromotionRestrictionsConfig object or null.
...optin	Object	Defines opt-in workflow details (Optin). Possible Values: A valid Optin object or empty object .
....basedOn	String	Indicates the basis for opt-in. Possible Values: ACTIVITY, AUDIENCE, EXTERNAL_TRIGGER, null.
....activities	Array (Object)	Defines activities (SingleActivity/ProupActivity) triggering opt-in. Possible Values: Array of Activity objects or null.
....audienceMapping	Array (Object)	Defines audience mappings (AudienceMapping) for opt-in. Possible Values: Array of AudienceMapping objects or null.
.....groupId	Integer (int64)	Specifies the group ID. Possible Values: Integer ID.
.....groupName	String	Specifies the group name. Possible Values: String.
....restrictions	Object	Defines opt-in restrictions (PromotionRestrictions). Possible Values: A valid PromotionRestrictions object or null.
.....optinExpiryBasedOn	Object	Defines opt-in expiry (PromotionExpiryConfig). Possible Values: A valid PromotionExpiryConfig object or null.
.....enrolmentExpiryBasedOn	Object	Defines enrolment expiry (PromotionExpiryConfig). Possible Values: A valid PromotionExpiryConfig object or null.
.....optinLimitPerCustomer	Object	Defines opt-in limit (PromotionRestrictionsConfig). Possible Values: A valid PromotionRestrictionsConfig object or null.
.....maxRedemptionsPerEarnPerCustomer	Object	Defines redemption limit (PromotionRestrictionsConfig). Possible Values: A valid PromotionRestrictionsConfig object or null.
.....enrolmentLimitPerPromotion	Object	Defines total enrolment limit (PromotionRestrictionsConfig). Possible Values: A valid PromotionRestrictionsConfig object or null.
.....enrolmentLimitPerCustomer	Object	Defines enrolment limit per customer (PromotionRestrictionsConfig). Possible Values: A valid PromotionRestrictionsConfig object or null.
.....maxPointsPerEarnPerCustomer	Object	Defines max points per earn limit (PromotionRestrictionsConfig). Possible Values: A valid PromotionRestrictionsConfig object or null.
..communicationApprovalStatus	Object	Defines the status of communication approval (BulkClaimApproveResponse). Possible Values: A valid BulkClaimApproveResponse object or null (system-set).
...success	Boolean	Indicates if the approval status check was successful. Possible Values: true, false.
...message	String	Specifies the status message. Possible Values: String or null.
...response	Object	Defines the nested response object. Possible Values: Object or null.
...statusCode	Integer (int32)	Specifies the status code. Possible Values: Integer HTTP status code or null.
.number	integer (int32)	Specifies the current page number (0-indexed). Possible Values: Non-negative integer.
.sort	Array (Object)	Defines the sorting rules applied to the results (SortObject). Possible Values: Array of SortObject objects.
..direction	String	Specifies the sort direction. Possible Values: String (e.g., "ASC", "DESC").
..nullHandling	String	Specifies how null values are handled during sorting. Possible Values: String (e.g., "NATIVE", "NULLS_FIRST", "NULLS_LAST").
..ascending	Boolean	Indicates if the sort direction is ascending. Possible Values: true, false.
..property	String	Specifies the field name used for sorting. Possible Values: String field name.
..ignoreCase	Boolean	Indicates if case should be ignored during sorting (for string fields). Possible Values: true, false.
.pageable	Object	Defines pagination details (PageableObject). Possible Values: A valid PageableObject object.
..offset	integer (int64)	Specifies the offset of the first element returned on the page. Possible Values: Non-negative integer.
..sort	Array (Object)	Defines the sorting rules applied (SortObject, same structure as .sort above). Possible Values: Array of SortObject objects.
..pageNumber	integer (int32)	Specifies the current page number (0-indexed). Possible Values: Non-negative integer.
..pageSize	integer (int32)	Specifies the number of items requested per page. Possible Values: Positive integer.
..paged	Boolean	Indicates if pagination is applied. Possible Values: true, false.
..unpaged	Boolean	Indicates if pagination is not applied. Possible Values: true, false.
.numberOfElements	integer (int32)	Specifies the number of promotions returned on the current page. Possible Values: Non-negative integer.
errors	Array (Object)	Defines a list of errors that occurred, if any (ApiError). Possible Values: Array of ApiError objects or null.
.code	Integer (int64)	Specifies the error code. Possible Values: Integer error code.
.message	String	Specifies the error message. Possible Values: String error description.
warnings	Array (Object)	Defines a list of warnings, if any (ApiWarning). Possible Values: Array of ApiWarning objects or null.
.message	String	Specifies the warning message. Possible Values: String warning description.

Language

URL

Click Try It! to start a request and see the response here!