Skip to main content
POST
/
distribution-requests
/
list
List distribution requests
curl --request POST \
  --url https://api.example.com/distribution-requests/list \
  --header 'Content-Type: application/json' \
  --data '
{
  "pageInfo": {
    "count": 10,
    "page": 1
  }
}
'
import requests

url = "https://api.example.com/distribution-requests/list"

payload = { "pageInfo": {
"count": 10,
"page": 1
} }
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({pageInfo: {count: 10, page: 1}})
};

fetch('https://api.example.com/distribution-requests/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/distribution-requests/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'pageInfo' => [
'count' => 10,
'page' => 1
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

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

func main() {

url := "https://api.example.com/distribution-requests/list"

payload := strings.NewReader("{\n \"pageInfo\": {\n \"count\": 10,\n \"page\": 1\n }\n}")

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

req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/distribution-requests/list")
.header("Content-Type", "application/json")
.body("{\n \"pageInfo\": {\n \"count\": 10,\n \"page\": 1\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/distribution-requests/list")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"pageInfo\": {\n \"count\": 10,\n \"page\": 1\n }\n}"

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "id": "<string>",
      "type": "<string>",
      "brokerageFirmId": "<string>",
      "productId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pageInfo": {
    "first": true,
    "last": true
  },
  "totalCount": 123,
  "currentPage": 123,
  "totalPages": 123
}

Query Parameters

statuses
enum<string>[]

Status of the distribution request

Available options:
PENDING,
WAITING_FOR_SIGNATURE,
APPROVED,
DENIED,
REVOKED
brokerageFirmId
string

Brokerage firm the request is attached to

productId
string

Product id

Body

application/json
pageInfo
object

the page info

order
object

the sort options

Response

200 - application/json
data
object[]
required

the list of items in the page

pageInfo
object
required

the page info

totalCount
number
required

the total number of items

currentPage
number
required

the current page

totalPages
number
required

the total number of pages