REST API Reference

DEVELOPERS · API REFERENCE

API Reference

The AllSign REST API exposes 77 operations across 12 resource types. All data on this page is generated from the OpenAPI spec.

Getting Started Changelog

Specifications

API spec — YAML

API spec — JSON

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.

Terminology

Operations

A unique combination of an HTTP method and a path — for example, GET /agreements/{ref}. Each operation maps to a single resource action: read, create, update, or delete.

API Operations

ACTORS

Get Actor Self

GET /actors/self

Returns the bearer-authenticated actor identity resolved for the current API request.

ACTORS

Replace Actor Avatar

PUT /actors/self/avatar

Stores avatar media for the bearer-authenticated actor and returns the updated actor representation.

ACTORS

Delete Actor Avatar

DELETE /actors/self/avatar

Deletes avatar media for the bearer-authenticated actor and returns the updated actor representation.

ACTORS

Get Actor Avatar Content

GET /actors/self/avatar/content

Returns the binary avatar media content for the bearer-authenticated actor.

AGREEMENTS

List Agreements

GET /agreements

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

AGREEMENTS

Create Agreement

POST /agreements

Creates a canonical agreement owned by the authenticated actor.

AGREEMENTS

Get Agreement

GET /agreements/{agreement_ref}

Returns a canonical agreement identified by agreement reference.

AGREEMENTS

Update Agreement

PUT /agreements/{agreement_ref}

Updates a canonical agreement identified by agreement reference.

AGREEMENTS

Delete Agreement

DELETE /agreements/{agreement_ref}

Deletes a canonical agreement and returns its final representation.

AGREEMENTS

Create Agreement Rejection

POST /agreements/{agreement_ref}/rejections

Records a rejection event for the referenced agreement and returns the final agreement representation.

AGREEMENTS

Create Agreement Cancellation

POST /agreements/{agreement_ref}/cancellations

Records a cancellation event for the referenced agreement and returns the final agreement representation.

AGREEMENTS

Create Agreement Copy

POST /agreements/{agreement_ref}/copies

Creates a canonical agreement copy from the referenced agreement and returns the copied agreement representation.

AGREEMENTS

Create Template From Agreement

POST /agreements/{agreement_ref}/templates

Creates a canonical template from the referenced agreement and returns the new template representation.

AGREEMENTS

Create Agreement Section

POST /agreements/{agreement_ref}/sections

Creates a canonical section under the identified agreement.

AGREEMENTS

Update Section

PUT /sections/{section_ref}

Updates a canonical section identified by section reference.

AGREEMENTS

Create Section Copy

POST /sections/{section_ref}/copies

Creates a canonical copy of the identified section and returns the copied section representation.

AGREEMENTS

Create Section Placement

POST /sections/{section_ref}/placements

Repositions a canonical section and returns the updated section representation.

AGREEMENTS

Delete Section

DELETE /sections/{section_ref}/placements

Deletes a canonical section and returns its final representation.

AGREEMENTS

Create Agreement Term

POST /agreements/{agreement_ref}/terms

Creates a canonical term under the identified agreement, optionally nested under a section.

AGREEMENTS

Update Term

PUT /terms/{term_ref}

Updates a canonical term identified by term reference.

AGREEMENTS

Delete Term

DELETE /terms/{term_ref}

Deletes a canonical term and returns its final representation.

AGREEMENTS

Create Term Copy

POST /terms/{term_ref}/copies

Creates a canonical copy of the identified term and returns the copied term representation.

AGREEMENTS

Create Term Condition

POST /terms/{term_ref}/conditions

Updates the canonical negotiability condition of a term and returns the updated term representation.

AGREEMENTS

Create Term Placement

POST /terms/{term_ref}/placements

Repositions a canonical term and returns the updated term representation.

ATTACHMENTS

List Agreement Attachments

GET /agreements/{agreement_ref}/attachments

Returns canonical attachments scoped to the identified agreement.

ATTACHMENTS

Create Agreement Attachment

POST /agreements/{agreement_ref}/attachments

Creates a canonical attachment scoped to the identified agreement.

ATTACHMENTS

Update Attachment

PUT /attachments/{attachment_ref}

Updates canonical attachment metadata identified by attachment reference.

ATTACHMENTS

Delete Attachment

DELETE /attachments/{attachment_ref}

Deletes canonical attachment metadata and returns its final representation.

COMMENTS

List Agreement Comments

GET /agreements/{agreement_ref}/comments

Returns a paginated canonical comment collection scoped to an agreement.

COMMENTS

Create Agreement Comment

POST /agreements/{agreement_ref}/comments

Creates a canonical comment scoped directly to an agreement.

COMMENTS

List Section Comments

GET /sections/{section_ref}/comments

Returns a paginated canonical comment collection scoped to a section.

COMMENTS

Create Section Comment

POST /sections/{section_ref}/comments

Creates a canonical comment scoped to a section.

COMMENTS

List Term Comments

GET /terms/{term_ref}/comments

Returns a paginated canonical comment collection scoped to a term.

COMMENTS

Create Term Comment

POST /terms/{term_ref}/comments

Creates a canonical comment scoped to a term and optionally pinned to the current revision.

COMMENTS

Update Comment

PUT /comments/{comment_ref}

Updates a canonical comment identified by comment reference.

COMMENTS

Delete Comment

DELETE /comments/{comment_ref}

Deletes a canonical comment and returns its final representation.

CONTACTS

List Contacts

GET /contacts

Returns a paginated canonical contact collection owned by the authenticated actor.

CONTACTS

Create Contact

POST /contacts

Creates a canonical contact owned by the authenticated actor.

CONTACTS

Get Contact

GET /contacts/{contact_ref}

Returns a canonical contact identified by contact reference.

CONTACTS

Update Contact

PUT /contacts/{contact_ref}

Updates a canonical contact identified by contact reference.

CONTACTS

Delete Contact

DELETE /contacts/{contact_ref}

Deletes a canonical contact and returns its final representation.

CONTACTS

Replace Contact Avatar

PUT /contacts/{contact_ref}/avatar

Stores avatar media for a canonical contact identified by contact reference.

CONTACTS

Delete Contact Avatar

DELETE /contacts/{contact_ref}/avatar

Deletes avatar media for a canonical contact identified by contact reference.

CONTACTS

Get Contact Avatar Content

GET /contacts/{contact_ref}/avatar/content

Returns the binary avatar media content for a canonical contact identified by contact reference.

DECISIONS

List Term Decisions

GET /terms/{term_ref}/decisions

Returns a paginated canonical decision collection scoped to a term.

DECISIONS

Create Term Decision

POST /terms/{term_ref}/decisions

Creates a canonical decision for the current revision of the identified term.

IMPORTS

Import Agreement

POST /agreements/imports

Creates a canonical agreement by importing a canonical document payload.

IMPORTS

Import Template

POST /templates/imports

Creates a canonical template by importing a canonical document payload.

PARTICIPANTS

List Agreement Participants

GET /agreements/{agreement_ref}/participants

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

PARTICIPANTS

Create Agreement Participant

POST /agreements/{agreement_ref}/participants

Creates an agreement participant invitation or an active agent participant for the identified agreement.

PARTICIPANTS

Create Agreement Participant Self

POST /agreements/{agreement_ref}/participants/self

Creates a canonical active participant for the authenticated actor on the identified agreement.

PARTICIPANTS

Update Participant

PUT /participants/{participant_ref}

Updates the canonical role assignment for an identified agreement participant.

PARTICIPANTS

Delete Participant

DELETE /participants/{participant_ref}

Deletes a canonical participant and returns its final representation.

PARTICIPANTS

Create Invitation Accept

POST /invitations/{invitation_ref}/accepts

Accepts the identified invitation and returns the activated participant representation.

PARTICIPANTS

Create Invitation Reject

POST /invitations/{invitation_ref}/rejects

Rejects the identified invitation and returns the rejected invitation reference.

REVISIONS

List Term Revisions

GET /terms/{term_ref}/revisions

Returns a paginated canonical revision collection scoped to a term.

REVISIONS

Create Term Revision

POST /terms/{term_ref}/revisions

Creates a canonical revision proposal for the identified term and records its accepting decision.

SETTINGS

Get Actor Settings

GET /settings

Returns notification preferences and security context for the bearer-authenticated actor.

SETTINGS

Update Actor Settings

PUT /settings

Updates notification preferences for the bearer-authenticated actor and returns the current settings view.

SIGNING

Get Agreement Protocol

GET /agreements/{agreement_ref}/protocols

Returns the current signing state and the single valid next action for the identified agreement.

SIGNING

Create Protocol Authentication

POST /protocols/{agreement_ref}/authentications

Creates the current signing authentication transition for the identified agreement protocol.

SIGNING

Create Protocol Rcp Assignment

POST /protocols/{agreement_ref}/rcp/assignments

Creates the reciprocal confirmation requirements for the identified agreement protocol.

SIGNING

Create Protocol Rcp Confirmation

POST /protocols/{agreement_ref}/rcp/confirmations

Confirms the current reciprocal confirmation challenge for the identified agreement protocol.

SIGNING

Create Agreement Signature

POST /agreements/{agreement_ref}/signatures

Attempts to create the actor's agreement signature and returns either the created signature or a verification challenge.

SIGNING

Create Verification Confirmation

POST /verifications/{verification_ref}/confirmations

Completes the current signing-related verification challenge identified by verification reference.

TEMPLATES

List Templates

GET /templates

Returns a paginated canonical template collection owned by the authenticated actor.

TEMPLATES

Create Template

POST /templates

Creates a canonical template owned by the authenticated actor.

TEMPLATES

Get Template

GET /templates/{template_ref}

Returns a canonical template identified by template reference.

TEMPLATES

Update Template

PUT /templates/{template_ref}

Updates a canonical template identified by template reference.

TEMPLATES

Delete Template

DELETE /templates/{template_ref}

Deletes a canonical template and returns a success confirmation.

TEMPLATES

Create Template Copy

POST /templates/{template_ref}/copies

Creates a canonical template copy from the referenced template and returns the copied template representation.

TEMPLATES

Create Agreement From Template

POST /templates/{template_ref}/agreements

Creates a canonical agreement from the referenced template and returns the new agreement representation.

TEMPLATES

Create Template Section

POST /templates/{template_ref}/sections

Creates a canonical section under the identified template.

TEMPLATES

Create Template Term

POST /templates/{template_ref}/terms

Creates a canonical term under the identified template, optionally nested under a section.

TEMPLATES

List Template Attachments

GET /templates/{template_ref}/attachments

Returns canonical attachments scoped to the identified template.

TEMPLATES

Create Template Attachment

POST /templates/{template_ref}/attachments

Creates a canonical attachment scoped to the identified template.

TEMPLATES

Get Template Content

GET /templates/{template_ref}/content

Returns the canonical document content compiled from the identified template.

Get notified when the API changes