List Agreements

GET /v1/agreements

List Agreements

cURL

curl --request GET \
  --url https://api.dispersed.com/v1/agreements

import requests

url = "https://api.dispersed.com/v1/agreements"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.dispersed.com/v1/agreements', 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.dispersed.com/v1/agreements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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.dispersed.com/v1/agreements"

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

	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.dispersed.com/v1/agreements")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dispersed.com/v1/agreements")

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

request = Net::HTTP::Get.new(url)

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

200

{
  "data": [
    {
      "version": 123,
      "title": "<string>",
      "effective_date": "2023-11-07T05:31:56Z",
      "content_url": "<string>",
      "object": "agreement",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "uuid": "<string>",
      "document_url": "<string>",
      "document_hash": "<string>",
      "applicable_roles": [],
      "created_by_account_uuid": "<string>"
    }
  ],
  "limit": 123,
  "page": 123,
  "total": 123
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "timestamp": "<string>",
    "details": []
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "timestamp": "<string>",
    "details": []
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "timestamp": "<string>",
    "details": []
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "timestamp": "<string>",
    "details": []
  }
}

Query Parameters

limit · integer

Required range: 1 <= x <= 50

Example:

1

page · integer

Required range: 1 <= x <= 9007199254740991

Example:

1

sort · string

Example:

"created_at OR -created_at"

filter[type] · string

Example:

"TERMS_AND_CONDITIONS,PRIVACY_POLICY"

Response

200

application/json

List of agreements

data · object[] · required

Show child attributes

limit · integer · required

page · integer · required

total · integer · required