List Blocklist Items

Retrieve a list of paginated blocklist entries.

Required API key scope

• Orders

GET /blocklists

List Blocklist Items

cURL

curl --request GET \
  --url https://api.loopreturns.com/api/v1/blocklists \
  --header 'X-Authorization: <api-key>'

import requests

url = "https://api.loopreturns.com/api/v1/blocklists"

headers = {"X-Authorization": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'X-Authorization': '<api-key>'}};

fetch('https://api.loopreturns.com/api/v1/blocklists', 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.loopreturns.com/api/v1/blocklists",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.loopreturns.com/api/v1/blocklists"

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

	req.Header.Add("X-Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.loopreturns.com/api/v1/blocklists")
  .header("X-Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.loopreturns.com/api/v1/blocklists")

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

request = Net::HTTP::Get.new(url)
request["X-Authorization"] = '<api-key>'

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

200

{
  "data": [
    {
      "id": 123,
      "value": "<string>",
      "secondary_value": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "links": [
    {
      "url": "<string>",
      "label": "<string>",
      "active": true
    }
  ],
  "next_page_url": "<string>",
  "current_page": 123,
  "from": "<string>",
  "first_page_url": "<string>",
  "last_page": "<string>",
  "last_page_url": "<string>",
  "path": "<string>",
  "per_page": 123,
  "prev_page_url": "<string>",
  "to": 123,
  "total": 123
}

{
  "errors": "<string>"
}

Authorizations

X-Authorization · string · header · required

Response

200

application/json

Success

data · object[]

The data for each entry in the blocklist.

Show child attributes

links · object[]

Show child attributes

next_page_url · string | null

The link to the next page of paginated results.

Example:

"https://api.loopreturns.com/api/v1/blocklists?page=2"

current_page · integer

The identifier associated with the current page.

Example:

1

from · string | null

The number of the first blocklist entry on the page.

Example:

1

first_page_url · string | null

The link to the first page of paginated results.

Example:

"https://api.loopreturns.com/api/v1/blocklists?page=1"

last_page · string | null

The identifier associated with the last page.

Example:

2

last_page_url · string | null

The link to the last page of paginated results.

Example:

"https://api.loopreturns.com/api/v1/blocklists?page=2"

path · string | null

The endpoint's path.

Example:

"https://api.loopreturns.com/api/v1/blocklists"

per_page · integer

The number of blocklist entries per page.

Example:

15

prev_page_url · string | null

The link to the previous page of paginated results.

to · integer | null

The number of the last blocklist entry on the page.

Example:

15

total · integer

The total number of blocklist entries returned.

Example:

20