--- title: Search Data Releases slug: search-data-releases createdAt: 2026-04-28T15:27:55.333Z --- { "id": "fLLp2jzHjfBn3bGuWm-wo", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.b.preview.loyaltyservices.io/api/v3/data-releases", "servers": [ { "url": "https://api.b.preview.loyaltyservices.io/api/v3/data-releases" } ], "name": "Search Data Releases", "description": "

Search for data releases by status, text, and publish date range

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "text", "type": "string", "description": "Text to match in release name" }, { "kind": "optional", "name": "statusCode", "type": "string", "description": "Return only releases with this status code" }, { "kind": "optional", "name": "publishStartDate", "type": "string", "description": "

Release publish date is on or after this date (yyyy-MM-dd)

", "format": "date" }, { "kind": "optional", "name": "publishEndDate", "type": "string", "description": "

Release publish date is on or before this date (yyyy-MM-dd)

", "format": "date" }, { "kind": "optional", "name": "includeItemSummary", "type": "boolean", "description": "

When true, include item type counts in the response

" }, { "kind": "optional", "name": "includeItems", "type": "boolean", "description": "

When true, include full item data in the response

" }, { "kind": "optional", "name": "includeStatusHistories", "type": "boolean", "description": "

When true, include status history in the response

" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "OAuth2", "name": "OAuth2", "kind": "optional", "type": "oauth2", "description": "

See https://docs.wearephaedon.com/docs/platform-api-authentication

", "oauth2Flows": { "clientCredentials": { "tokenUrl": "https://phaedon.oktapreview.com/oauth2/auscfbbmieFBGGOzR1d7/v1/token", "scopes": { "api:custom-data:read": "Grants read access to custom data information", "api:custom-data:modify": "Grants modify access to custom data information", "api:data-codes:read": "Grants read access to data codes", "api:data-codes:modify": "Grants modify access to data codes", "api:coupon-compensation:read": "Grants read access to compensations for coupon code", "api:coupon-compensation:create": "Grants access to create compensations for coupon code", "api:coupon-compensation:modify": "Grants access to edit compensation nights for coupon code", "api:coupon-request:modify": "Grants modify access to create coupons", "api:member:search": "Grants search access to member information", "api:member:verify": "Grants verify access to member information", "api:member:merge": "Grants access to merge members", "api:member:enroll": "Grants access to enroll members", "api:member:modify": "Grants modify access to member information", "api:member:read": "Grants read access to member information", "api:member:close": "Grants access to close member account", "api:member:migrate": "Grants access to migrate member accounts", "api:member-address:read": "Grants read access to member address information", "api:member-address:modify": "Grants modify access to member address information", "api:member-alias:read": "Grants read access to member alias information", "api:member-alias:modify": "Grants modify access to member alias information", "api:member-badge:read": "Grants read access to member badge information", "api:member-badge:modify": "Grants modify access to member badge information", "api:member-bonus:add": "Grants access to add a bonus to a member", "api:member-bonus:read": "Grants read access to member bonus information", "api:member-comments:read": "Grants read access to member comments information", "api:member-comments:modify": "Grants modify access to member comments information", "api:member-communication:read": "Grants read access to member communication information", "api:member-communication:modify": "Grants modify access to member communication information", "api:member-coupon:read": "Grants read access to member coupon information", "api:member-coupon-use:cancel": "Grants access to cancel member coupon uses", "api:member-coupon:transfer": "Grants access to transfer a member coupon", "api:member-coupon-use:update": "Grants access to update member coupon uses", "api:member-currency:read": "Grants read access to member currency information", "api:member-currency:adjust": "Grants access to adjust member currency", "api:member-currency:migrate": "Grants access to migrate member currency", "api:member-currency-conversion:convert": "Grants access to convert member currency", "api:member-email:read": "Grants read access to member email information", "api:member-email:modify": "Grants modify access to member email information", "api:member-event:read": "Grants read access to member events", "api:member-event:modify": "Grants modify access to member events", "api:event-rule:read": "Grants read access to event rules", "api:event-rule:modify": "Grants access to modify event rule", "api:event-rule:admin": "Grants full admin access to event rules", "api:member-list:read": "Grants read access to member list information", "api:member-list:modify": "Grants modify access to member list information", "api:member-partner-link:read": "Grants read access to member partner link information", "api:member-partner-link:modify": "Grants modify access to member partner link information", "api:member-payment-card:read": "Grants read access to member payment card information", "api:member-payment-card:modify": "Grants modify access to member payment card information", "api:member-phone:read": "Grants read access to member phone information", "api:member-phone:modify": "Grants modify access to member phone information", "api:member-preference:read": "Grants read access to member preference information", "api:member-preference:modify": "Grants modify access to member preference information", "api:member-promotion:read": "Grants read access to member promotion information", "api:member-promotion:register": "Grants access to register a member into a promotion", "api:member-redemption:create": "Grants redeem access to member redemption information", "api:member-redemption:over-redeem": "Grants access to over redeem", "api:member-redemption:read": "Grants read access to member redemption information", "api:member-redemption:cancel": "Grants access to cancel member redemptions", "api:member-redemption:migrate": "Allows migration of member redemption information", "api:member-redemption:patch": "Grants patching access to member redemption", "api:member-tier:read": "Grants read access to member tier information", "api:member-tier:adjust": "Grants access to adjust member tiers", "api:member-tier:migrate": "Grants access to migrate member tiers", "api:member-transaction:read": "Grants read access to transaction information", "api:member-transaction:cancel": "Grants access to cancel transactions", "api:member-transaction:clone": "Grants access to clone transactions", "api:member-transfer:transfer": "Grants access to do member to member transfers", "api:preference:read": "Grants read access to preference information", "api:promotion:read": "Grants read access to promotion information", "api:tier:read": "Grant read access to tier information", "api:promotion:register": "Grants access to register a member into a promotion using token", "api:promotion-token:manage": "Grants access to generate promotion token", "api:redemption:read": "Grants read access to redemption information", "api:redemption:modify": "Grants access to modify redemption information", "api:bonus-rule:read": "Grants read access to bonus rule configuration", "api:bonus-rule:modify": "Grants access to modify bonus rule configuration", "api:bonus-rule:manage": "Grants limited admin access to bonus rule configuration", "api:bonus-rule:admin": "Grants full admin access to bonus rules", "api:promotion-rule:read": "Grants read access to promotion rule configuration", "api:promotion-rule:modify": "Grants access to modify promotion rule configuration", "api:promotion-rule:manage": "Grants limited admin access to promotion rule configuration", "api:promotion-rule:admin": "Grants full admin access to promotion rules", "api:reports:under-investigation": "Grants access to under investigation report", "api:transaction:submit": "Grants access to submit transactions", "api:transaction:migrate": "Grants access to migrate transactions", "api:user:read": "Grants access to read user information", "api:user:modify": "Grants access to create user", "api:user-task:read": "Grants read access to user tasks", "api:user-task:modify": "Grants modify access to user tasks", "api:user-role:read": "Grants read access to user roles", "api:user-role:modify": "Grants modify access to user roles", "api:compensation:read": "Grants read access to hotel summary information", "api:compensation:modify": "Grants modify access to hotel summary information", "api:member-referral:read": "Grants read access to member referral information", "api:member-referral:modify": "Grants modify access to member referral information", "api:member-referral-codes:read": "Grants read access to member referral codes", "api:member-referral-codes:create": "Grants access to create member referral codes", "api:outbound-notification:modify": "Grants access to send outbound notification", "api:outbound-notification:read": "Grants access to read outbound notification types", "api:background-task:read": "Grants read access to background task information", "api:async-task:create": "Grants access to submit operations for background processing", "api:async-task:read": "Grants read access to background processing results", "api:audit-configuration:read": "Grants read access to audit configuration information", "api:audit-configuration:modify": "Grants modify access to audit configuration information", "api:badge:read": "Grant read access to badge information", "api:broadcast-messages:read": "Grant Read access to broadcast messages", "api:expression-config:read": "Grant read access to expression builder configuration", "api:managed-entity:read": "Grant read access to managed entity data", "api:customer-satisfaction:modify": "Grants modify access to customer satisfaction metrics", "api:member-linked-account:modify": "Grant modify access to member linked account", "api:member-linked-account:read": "Grants access to read linked member accounts", "api:enroll-codes:read": "Grants access to read enroll codes", "api:contact-us:modify": "Grants access to submit Contact Us inquiry", "api:data-release:read": "Grants read access to data releases", "api:points-pool:read": "Grants read access to points pools", "api:points-pool:modify": "Grants modify access to points pools", "api:segment:read": "Grants read access to segments", "api:segment:modify": "Grants modify access to segments", "api:communication-type:read": "Grants read access to communication types", "api:communication-type:modify": "Grants modify access to communication types", "api:member-status-match:read": "Grants read access to status match eligibility and submitted images/applications", "api:member-status-match:create": "Grants access to upload status match images and submit applications", "api:earning-rule:modify": "Grant modify access to earning rules", "api:earning-rule:manage": "Grants limited editing of earning rules whose status is APPROVED, PUBLISHED, or LIVE" } } }, "requiredScopes": [ "api:data-release:read" ] } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Success", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "

A data release record, optionally including item summary, items, and status history

", "customType": "DataRelease[]", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "readOnly": true, "description": "Internal unique identifier of the release", "format": "int64" }, { "name": "name", "kind": "optional", "type": "string", "description": "Display name of the release" }, { "name": "description", "kind": "optional", "type": "string", "description": "Description of the release" }, { "name": "statusCode", "kind": "optional", "type": "string", "description": "Approval status code" }, { "name": "publishDate", "kind": "optional", "type": "string", "description": "

Date the release is published (yyyy-MM-dd)

" }, { "name": "approvalsNeeded", "kind": "optional", "type": "boolean", "description": "

If true, the release does not yet have sufficient approvals

" }, { "name": "approvers", "kind": "optional", "type": "array", "description": "Role names that can approve this release", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "cancelable", "kind": "optional", "type": "boolean", "description": "

If true, the release can be canceled when approved but not yet published

" }, { "name": "editable", "kind": "optional", "type": "boolean", "description": "

If true, the release can be edited

" }, { "name": "deletable", "kind": "optional", "type": "boolean", "description": "

If true, the release can be deleted

" }, { "name": "createDate", "kind": "optional", "type": "string", "readOnly": true, "description": "Date the release was created", "format": "date-time" }, { "name": "createUserName", "kind": "optional", "type": "string", "readOnly": true, "description": "Name of the user who created the release" }, { "name": "updateDate", "kind": "optional", "type": "string", "readOnly": true, "description": "Date the release was last updated", "format": "date-time" }, { "name": "updateUserName", "kind": "optional", "type": "string", "readOnly": true, "description": "Name of the user who last updated the release" }, { "name": "itemSummary", "kind": "optional", "type": "array", "description": "

Item type counts (present when includeItemSummary=true)

", "modelRef": "#/components/schemas/DataReleaseItemSummary", "customType": "DataReleaseItemSummary[]", "schema": [ { "name": "typeCode", "kind": "optional", "type": "string", "description": "

Type of item (e.g. BonusRule, PromotionRule, RedemptionRule)

" }, { "name": "count", "kind": "optional", "type": "integer", "description": "Quantity of items of this type in the release" } ] }, { "name": "items", "kind": "optional", "type": "array", "description": "

Full item data (present when includeItems=true)

", "modelRef": "#/components/schemas/DataReleaseItem", "customType": "DataReleaseItem[]", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "readOnly": true, "description": "Item identifier", "format": "int64" }, { "name": "itemId", "kind": "optional", "type": "string", "description": "

External identifier of the rule (promotion id, bonus id, or event rule id)

" }, { "name": "typeCode", "kind": "optional", "type": "string", "description": "

Type of item (e.g. BonusRule, PromotionRule, RedemptionRule)

" }, { "name": "statusCode", "kind": "optional", "type": "string", "description": "

Rule status (active or inactive)

" }, { "name": "name", "kind": "optional", "type": "string", "description": "Rule name" }, { "name": "workflowStatusCode", "kind": "optional", "type": "string", "description": "

Workflow state (WORKING or READY)

" }, { "name": "startDate", "kind": "optional", "type": "string", "description": "

First day rule is effective (yyyy-MM-dd)

" }, { "name": "endDate", "kind": "optional", "type": "string", "description": "

Last day rule is effective (yyyy-MM-dd)

" }, { "name": "dataReleaseItemStatus", "kind": "optional", "type": "string", "description": "Approval status of the item" }, { "name": "isEditable", "kind": "optional", "type": "boolean", "description": "

If true, the item can be edited

" }, { "name": "isReapprovable", "kind": "optional", "type": "boolean", "description": "

If true, editing the item will trigger re-approval

" }, { "name": "isBumpable", "kind": "optional", "type": "boolean", "description": "

If true, only the end date of the item can be changed

" }, { "name": "isUsed", "kind": "optional", "type": "boolean", "description": "

If true, the item has been used on at least one transaction

" } ] }, { "name": "statusHistories", "kind": "optional", "type": "array", "description": "

Status change history (present when includeStatusHistories=true)

", "modelRef": "#/components/schemas/DataReleaseHistory", "customType": "DataReleaseHistory[]", "schema": [ { "name": "prevStatusCode", "kind": "optional", "type": "string", "description": "Status prior to change" }, { "name": "statusCode", "kind": "optional", "type": "string", "description": "Status after change" }, { "name": "comments", "kind": "optional", "type": "string", "description": "Comments made on the status change" }, { "name": "createDate", "kind": "optional", "type": "string", "readOnly": true, "description": "Date this history entry was created", "format": "date-time" }, { "name": "createUserName", "kind": "optional", "type": "string", "readOnly": true, "description": "Name of the user who created this history entry" }, { "name": "updateDate", "kind": "optional", "type": "string", "readOnly": true, "description": "Date this history entry was last updated", "format": "date-time" }, { "name": "updateUserName", "kind": "optional", "type": "string", "readOnly": true, "description": "Name of the user who last updated this history entry" } ] } ], "modelRef": "#/components/schemas/DataRelease", "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "errors", "kind": "optional", "type": "array", "description": "List of errors", "modelRef": "#/components/schemas/ValidationError", "customType": "ValidationError[]", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "Error code assigned to this violation" }, { "name": "fieldName", "kind": "optional", "type": "string", "description": "

Name of field that violated validation constraint (optional)

" }, { "name": "message", "kind": "optional", "type": "string", "description": "Internal message describing the error" }, { "name": "messageParameters", "kind": "optional", "type": "array", "description": "Error message parameters", "example": "", "itemType": "object", "customType": "object[]", "schema": [] } ] } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "Unauthorized", "jsonExample": "", "isExpanded": true }, { "statusCode": "403", "description": "Forbidden", "jsonExample": "", "isExpanded": true }, { "statusCode": "500", "description": "Internal error", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "example-0-curl", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.b.preview.loyaltyservices.io/api/v3/data-releases \\\n --header 'accept: application/json'" }, { "id": "example-1-ruby", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.b.preview.loyaltyservices.io/api/v3/data-releases\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "example-2-python", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.b.preview.loyaltyservices.io/api/v3/data-releases\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" }, { "id": "example-3-java", "language": "java", "label": "Java", "code": "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"\");\nRequest request = new Request.Builder()\n .url(\"https://api.b.preview.loyaltyservices.io/api/v3/data-releases\")\n .method(\"GET\", body)\n .addHeader(\"accept\", \"application/json\")\n .addHeader(\"content-type\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" } ], "selectedLanguageId": "example-0-curl" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Success\n[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"statusCode\": \"\",\n \"publishDate\": \"\",\n \"approvalsNeeded\": false,\n \"approvers\": [\n \"\"\n ],\n \"cancelable\": false,\n \"editable\": false,\n \"deletable\": false,\n \"createDate\": \"\",\n \"createUserName\": \"\",\n \"updateDate\": \"\",\n \"updateUserName\": \"\",\n \"itemSummary\": [\n {\n \"typeCode\": \"\",\n \"count\": 0\n }\n ],\n \"items\": [\n {\n \"id\": \"\",\n \"itemId\": \"\",\n \"typeCode\": \"\",\n \"statusCode\": \"\",\n \"name\": \"\",\n \"workflowStatusCode\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"dataReleaseItemStatus\": \"\",\n \"isEditable\": false,\n \"isReapprovable\": false,\n \"isBumpable\": false,\n \"isUsed\": false\n }\n ],\n \"statusHistories\": [\n {\n \"prevStatusCode\": \"\",\n \"statusCode\": \"\",\n \"comments\": \"\",\n \"createDate\": \"\",\n \"createUserName\": \"\",\n \"updateDate\": \"\",\n \"updateUserName\": \"\"\n }\n ]\n }\n]" }, { "id": "response-1-400", "language": "400", "code": "// Bad request\n{\n \"errors\": [\n {\n \"code\": \"\",\n \"fieldName\": \"\",\n \"message\": \"\",\n \"messageParameters\": [\n {}\n ]\n }\n ]\n}" }, { "id": "response-2-401", "language": "401", "code": "// Unauthorized\n" }, { "id": "response-3-403", "language": "403", "code": "// Forbidden\n" }, { "id": "response-4-500", "language": "500", "code": "// Internal error\n" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }