Get Agreement

GET /v1/agreements/{uuid}

Get Agreement

cURL

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

import requests

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

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.dispersed.com/v1/agreements/{uuid}', 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/{uuid}",
  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/{uuid}"

	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/{uuid}")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "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>"
}

{
  "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": []
  }
}

Path Parameters

uuid · string<uuid> · required

Response

200

application/json

Agreement details

type · enum<string> · required

Available options: PRIVACY_POLICY, TERMS_AND_CONDITIONS

version · integer · required

title · string · required

effective_date · string<date-time> | null · required

content_url · string · required

object · enum<string> · required

Available options: agreement

created_at · string<date-time> | null · required

updated_at · string<date-time> | null · required

uuid · string | null

document_url · string | null

document_hash · string | null

applicable_roles · enum<string>[]

Available options: ADMIN, NODE_OPERATOR, OPS, SERVICE_CONSUMER, STAFF

created_by_account_uuid · string | null