Skip to main content
GET
/
v1
/
agreements
List Agreements
curl --request GET \
  --url https://api.dispersed.com/v1/agreements
{
  "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
}

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

List of agreements

​
data
object[]
required
​
limit
integer
required
​
page
integer
required
​
total
integer
required