GET /v1/signature/forms

GET

/v1/signature/forms

curl --request GET \
  --url https://api.asap.cool/v1/signature/forms \
  --header 'Authorization: Bearer <token>'

• Production

Authorizations

• api_key
  signature:read
• session

Parameters

Query Parameters

limit

integer | null format: int32

Page size, 1..=100 (defaults to 100).

cursor

string | null

Opaque cursor from a previous page’s meta.next_cursor.

Responses

200

Page of forms (newest first).

Media type application/json

Array<object>

Public projection of a [SignatureForm], including the ready-to-share URL.

object

active

required

Whether the form accepts submissions.

boolean

id

required

Stable identifier.

string format: uuid

slug

required

Public, unguessable slug.

string

source_document_id

required

The fixed document every generated envelope wraps.

string format: uuid

template_id

Optional template applied to the generated envelopes.

string | null format: uuid

title

required

Human title.

string

url

required

Ready-to-share public URL ({frontend_base_url}/sign/forms/{slug}).

string

verification_method

required

Identity-verification method applied to the generated signers.

string

Example ^generated

[
  {
    "active": true,
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "slug": "example",
    "source_document_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "template_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "title": "example",
    "url": "example",
    "verification_method": "example"
  }
]

401

No active org.

Media type application/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object

code

required

Stable machine token (e.g. invalid_credentials).

string

field

Offending request field for validation errors, when known.

string | null

message

required

Human-readable message.

string

Example ^generated

{
  "code": "example",
  "field": "example",
  "message": "example"
}

403

Missing signature:read scope.

Media type application/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object

code

required

Stable machine token (e.g. invalid_credentials).

string

field

Offending request field for validation errors, when known.

string | null

message

required

Human-readable message.

string

Example ^generated

{
  "code": "example",
  "field": "example",
  "message": "example"
}

422

Invalid limit or cursor.

Media type application/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object

code

required

Stable machine token (e.g. invalid_credentials).

string

field

Offending request field for validation errors, when known.

string | null

message

required

Human-readable message.

string

Example ^generated

{
  "code": "example",
  "field": "example",
  "message": "example"
}