List Agreement Attachments

GET /agreements/{agreement_ref}/attachments

Returns canonical attachments scoped to the identified agreement.

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/{agreement_ref}/attachments" \
  -H "Authorization: Bearer {token}"

Request

Request Path

agreement_ref

Public agreement reference.

stringrequired

Responses

200 OK

Agreement attachment list.

{
  "data": {
    "attachments": [
      {
        "checksum": "",
        "checksum_algorithm": "",
        "description": "",
        "kind": "file",
        "name": "",
        "ref": "00000000-0000-4000-8000-000000000000",
        "url": ""
      }
    ]
  }
}

data

objectrequired

data.attachments

object[]required

data.attachments[].checksum

stringnullrequired

data.attachments[].checksum_algorithm

stringnullrequired

data.attachments[].description

stringnullrequired

data.attachments[].kind

file | urlrequired

data.attachments[].name

stringrequired

data.attachments[].ref

Public stable resource reference.

string (uuid)required

data.attachments[].url

stringnullrequired

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

404 Not Found

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