> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.warelycorp.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.warelycorp.com/_mcp/server.

# List Reward Programs

POST https://dev.warelypos.com/api/sp/reward-programs/list

Lists reward program definitions available to the authenticated SP Digital business.

Example curl:

```bash
curl --request POST '{{base_url}}/sp/reward-programs/list' \
  --header 'Authorization: Bearer {{access_token}}' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "search": "Silver",
    "per_page": 25,
    "page": 1
  }'
```

Example success response shape:

```json
{
  "success": true,
  "message": "OK",
  "data": [
    {
      "program_id": 1,
      "membership_name": "Silver Rewards",
      "amount_for_unit_rp": 1,
      "minimum_order_total_to_earn_points": 10
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "per_page": 25,
      "current_page": 1,
      "last_page": 1,
      "from": 1,
      "to": 1
    }
  }
}
```

Example error response shape:

```json
{
  "success": false,
  "message": "Unauthorized.",
  "error": {
    "code": "unauthorized",
    "details": {}
  }
}
```

Common platform errors:

* `sp_scope_not_granted`
* `sp_token_scope_missing`
* `legacy_field_not_allowed`
* `query_parameters_not_allowed`
* `invalid_content_type`

Reference: https://docs.warelycorp.com/api-reference/rewards/list-reward-programs

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Headers

- `Authorization` (string, optional)

## Response

### 200

200 OK Example

- `success` (boolean, optional)
- `message` (string, optional)
- `data` (list of SpRewardProgramsListPostResponsesContentApplicationJsonSchemaDataItems, optional)
- `meta` (SpRewardProgramsListPostResponsesContentApplicationJsonSchemaMeta, optional)

## Types

### SpRewardProgramsListPostResponsesContentApplicationJsonSchemaDataItems

- `program_id` (integer, optional)
- `membership_name` (string, optional)
- `amount_for_unit_rp` (integer, optional)
- `minimum_order_total_to_earn_points` (integer, optional)

### SpRewardProgramsListPostResponsesContentApplicationJsonSchemaMeta

- `pagination` (SpRewardProgramsListPostResponsesContentApplicationJsonSchemaMetaPagination, optional)

### SpRewardProgramsListPostResponsesContentApplicationJsonSchemaMetaPagination

- `total` (integer, optional)
- `per_page` (integer, optional)
- `current_page` (integer, optional)
- `last_page` (integer, optional)
- `from` (integer, optional)
- `to` (integer, optional)

## Examples

**Response**

```json
{
  "success": true,
  "message": "OK",
  "data": [
    {
      "program_id": 1,
      "membership_name": "Silver Rewards",
      "amount_for_unit_rp": 1,
      "minimum_order_total_to_earn_points": 10
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "per_page": 25,
      "current_page": 1,
      "last_page": 1,
      "from": 1,
      "to": 1
    }
  }
}
```

**SDK Code**

```python Rewards_listRewardPrograms_example
import requests

url = "https://dev.warelypos.com/api/sp/reward-programs/list"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.json())
```

```javascript Rewards_listRewardPrograms_example
const url = 'https://dev.warelypos.com/api/sp/reward-programs/list';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Rewards_listRewardPrograms_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://dev.warelypos.com/api/sp/reward-programs/list"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Rewards_listRewardPrograms_example
require 'uri'
require 'net/http'

url = URI("https://dev.warelypos.com/api/sp/reward-programs/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Rewards_listRewardPrograms_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://dev.warelypos.com/api/sp/reward-programs/list")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Rewards_listRewardPrograms_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://dev.warelypos.com/api/sp/reward-programs/list', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp Rewards_listRewardPrograms_example
using RestSharp;

var client = new RestClient("https://dev.warelypos.com/api/sp/reward-programs/list");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Rewards_listRewardPrograms_example
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://dev.warelypos.com/api/sp/reward-programs/list")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```