List Agreements

GET /agreements

Returns a paginated canonical agreement collection visible to the authenticated actor.

Conventions

Authentication

All endpoints require a Bearer token. Pass it in the Authorization header as Bearer <token>. Tokens are issued from the API settings page in your workspace.

Base URL

All paths are relative to https://api.allsign.app. The spec includes full paths; strip the base when constructing requests.

Versioning

The current version is 0.1.0. Breaking changes are documented in the Changelog and announced before taking effect.

Specification

The API follows OpenAPI Specification 3.x. All documentation on this page is generated directly from the spec.

Example

Bash

curl "https://api.allsign.app/agreements" \
  -H "Authorization: Bearer {token}"

Parameters

Query

page

One-based page number.

integer = 1optional

page_size

Maximum number of records returned per page.

integer = 20optional

search

Filters agreements by canonical searchable fields.

stringoptional

Responses

200 OK

Paginated agreement list.

{
  "data": {
    "agreements": [
      {
        "description": "",
        "intent": "",
        "name": "",
        "ref": "00000000-0000-4000-8000-000000000000",
        "status": ""
      }
    ]
  }
}

data

Standard paginated collection metadata.

objectrequired

data.agreements

object[]required

data.agreements[].description

stringnullrequired

data.agreements[].intent

stringrequired

data.agreements[].name

stringrequired

data.agreements[].ref

Public stable resource reference.

string (uuid)required

data.agreements[].status

stringrequired

401 Unauthorized

{
  "error": {
    "code": "",
    "message": "",
    "request_id": "",
    "status": 1
  }
}

error

objectrequired

error.code

stringrequired

error.message

stringrequired

error.request_id

stringrequired

error.status

integerrequired

error.fields

object[]optional