Endpoint
api/v1/offer-wall/pub-member/offers
Returns in-progress or completed offers and offer details personalized to a specific user.
It does not return all available offers that a user can start. For listing all available offers to a user, refer to the standard Get Offers endpoint instead.
Key Details
Supports all query parameters here
Returns the general response schema here
For details on how to handle new fields in our API schema, please see our SDK API Schema Disclaimer.
Default Sorting: Offers are sorted using GoKart’s EPC algorithm unless otherwise specified.
Required Parameters: listed in table below
Field Name | Type | Description | Examples |
| string/integer | ID of a publisher's member | 2173 |
filter.Progress
The filter.Progress parameter is used in the PubMemberSDK to return offers filtered by their completion status for a specific user. It allows you to request only offers that are either InProgress or fully Completed.
If not specified, both InProgress and Completed offers are returned.
The filter.Progress parameter is only available in the PubMemberSDK.
Status | Definition | Usage |
| User has clicked the offer, but additional events are required to complete it | Indicates the user is actively progressing through the offer steps |
| All required events for the offer have been successfully completed | Signifies the user has fulfilled all events in the offer |
Response Fields
| boolean | A flag indicating whether the offer is still active | true/false |
| boolean | A flag indicating whether the user has completed the associated offer. | true/false |
| date (string/text),null | The date and time when the user completed the offer. This field is nullable, meaning it may contain | 2024-10-21T09:26:32.369306+00:00 |
| string/text,null | The status of the reward associated with the offer. Can have values: Completed, Pending, or | Completed |
| string/text | A unique identifier for the user's session |
|
| array | Array containing event objects in a multi-event offer. | [{},{},{}...] |
| string/text,null | The status of the reward associated with the event. Can have values: Completed, Pending, or | Completed, null |
| date (string/text),null | The date and time by which the user must complete the event. This is calculated by adding | 2024-10-21T09:26:32.369306+00:00, null |
| boolean | A flag indicating whether the user has completed the associated event. | true/false |
| date (string/text),null | The date and time when the user completed the event. This field is nullable, meaning it may contain | 2024-10-21T09:26:32.369306+00:00, null |
| string/text | Unique identifier for the offer event. | e9623b92-4d90-404d-beaf-6b27a7ac66ac |
| string/text | Name of the offer event. | Install |
| number (floating) | Number that indicates the position in which the event should be displayed within the offer or event list. | 2 |
| number (floating),null | Sequence number of the event within the offer, starting at 1. A value of | 3 |
| number (floating),null | The reward amount for completing the event. | 30, null |
| number (floating),null | The number of days a user has to complete the event, relative to the completion of the sequence 1 event. | 30, null |
| number (floating),null | The number of days a reward will remain in a pending status. If the field is | 30, null |
| string/text | A unique identifier for the offer in the form of a UUID. | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
| string/text | The name of the offer, typically used as a title. | SiriusXM |
| string/text | A brief, attention-grabbing statement or headline summarizing the offer. | Get 3 months of streaming for only $1 |
| string/text | A concise description providing key information about the offer. | Stream sports, music, podcasts and more |
| string/text | Highlights or main points of the offer. | Subscribe for 3 month trial for $1 Stream daily for your first 7 days |
| string/text | A detailed explanation of the offer. | Download Bingo <br/> Blitz Complete Level "Rome" Collect Coins! |
| string/text | The legal terms, conditions, and disclaimers associated with the offer. | Must make first trade. Award within 30 days |
| string/text | A URL linking to a creative asset associated with the offer, such as an image or video. | |
| string/text | The name of the category this offer falls under. | Fin-Tech |
| string/text | Indicates whether the origin of the offer is tenant-owned or comes from an integration. | RevU |
| number (floating),null | The reward amount for completing the offer. | 30, null |
| number (floating),null | The number of days a reward will remain in a pending status. If the field is | 10, null |
| enum (string/text) | Can have values: SingleEvent or MultiEvent | SingleEvent |
| string/text | The date the offer launched | 2025-02-27T23:00:00+00:00 |
| string/text | The date the offer expires | 2025-02-27T23:00:00+00:00 |
| array | A list of devices targeted to the offer | IOS MacOS Browser |
| string/text | A unique identifier for the advertiser in the form of a UUID. | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
| string/text | The name of the advertiser | Agency1 |
| array | A list of creative asset associated with the offer. | [{},{},{}...] |
| integer | Index position of the creative in the array, starting at 0. | 1 |
| string/text | A URL linking to a creative asset associated with the offer, such as an image or video. | |
| string/text | Optional metadata about the creative. Can be | banner |
| array | This array contains all categories associated with an offer | [{},{},{}...] |
| string/text | Unique identifier for the category | 744d754b-17c5-45b0-bdee-c65458f983f7 |
| string/text | Name of the category | Other |
Request:
GET https://api.[YOUR_TENANT].getgokart.ai/api/v1/offer-wall/pub-member/offers?pub_member_id=123&filter.Progress=InProgress
Response:
"items": [
{
"isOfferAvailable": true,
"isUserCompleted": false,
"userCompletedAt": null,
"rewardStatus": "InProgress",
"sessionId": null,
"events": [
{
"rewardStatus": "Success",
"deadlineExpiresAt": null,
"isUserCompleted": true,
"userCompletedAt": "2025-08-11T06:13:27.837752+00:00",
"offerEventId": "c123c8f-1234-4d91-b38f-a08b7e867677",
"name": "Install",
"sequenceNumber": 1,
"reward": 0.25,
"deadlineDays": null,
"rewardPendingDays": 0
},
{
"rewardStatus": null,
"deadlineExpiresAt": null,
"isUserCompleted": false,
"userCompletedAt": null,
"offerEventId": "e9623b92-4d90-404d-beaf-6b27a7ac66ac",
"name": "Sign Up",
"sequenceNumber": 2,
"reward": 0.25,
"deadlineDays": null,
"rewardPendingDays": 0
}
],
"id": "f3f66231-a50e-4deb-a123-49ba12345678",
"name": "Free Play - iOS",
"headline": "Install and Sign Up",
"shortDescription": "",
"keyPoints": "<p>FreePlay offers a fun and engaging way to discover new products, services, and experiences. Check out our exclusive deals and amazing rewards, making your time on FreePlay even more enjoyable!</p>\n<p></p>\n<p></p>\n",
"offerDetails": "",
"termsAndDisclaimers": "<p>New Users only.</p>\n",
"creativeFileUrl": "https://example.com/image.png",
"categoryName": "Shopping",
"offerSource": "Super.com",
"reward": 0.5,
"rewardPendingDays": null,
"offerType": "MultiEvent",
"launchDate": "2025-02-28T05:00:00+00:00",
"endDate": null,
"deviceTypes": [
"IOS"
],
"advertiserId": "c123c8f-1234-4d91-b38f-a08b7e867677",
"advertiserName": "Brown Boots",
"creatives": [
{
"order": 0,
"url": "https://example.com/image.png",
"metadata": ""
}
],
"categories": [
{
"id": "744d754b-17c5-45b0-bdee-c65458f983f7",
"name": "Shopping"
}
]
}
},
"responseId": "963b3083-fd33-43c9-80c9-21b162123456",
"isSuccessful": true,
"responseTitle": "Success",
"responseType": "Success",
"messages": []
}