Menu
GETPOST envelopes/ User APIService tier

List envelopes, or create one with POST. derived from route

URL

  • User APIhttps://contracts.mattering.io/api/user/v1/envelopes/
  • Service tierhttps://contracts.mattering.io/api/internal/envelopes/

Pagination

Accepts limit and offset. The response meta carries total, limit and offset.

Responses

200 bare JSON object (no envelope)

{
  "...": "..."
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
400invalid_recipients
400title_required
400unsupported_field
401unauthorized
404workspace_not_found

Example

curl -X GET "https://contracts.mattering.io/api/user/v1/envelopes/" \
  -H "Authorization: Bearer $MATTERING_API_KEY"

Source: ContractsCore/internal_api.py (internal_api.envelopes)

GET envelopes/{public_id}/ User APIService tier

Read one of the envelopes by id. derived from route

URL

  • User APIhttps://contracts.mattering.io/api/user/v1/envelopes/{public_id}/
  • Service tierhttps://contracts.mattering.io/api/internal/envelopes/{public_id}/

Path parameters

NameType
public_idstr

Responses

200 bare JSON object (no envelope)

{
  "envelope": {
    "public_id": "...",
    "id": "...",
    "title": "...",
    "status": "...",
    "space_id": "...",
    "enforce_signing_order": "...",
    "created_at": "2026-01-01T00:00:00Z",
    "sent_at": "2026-01-01T00:00:00Z",
    "completed_at": "2026-01-01T00:00:00Z",
    "document_count": 0,
    "recipient_count": 0,
    "has_certificate": true,
    "recipients": [
      {
        "public_id": "...",
        "name": "...",
        "email": "...",
        "role": "...",
        "routing_order": "...",
        "status": "...",
        "signed_at": "2026-01-01T00:00:00Z"
      }
    ],
    "contract_document": {
      "public_id": "..."
    }
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
401unauthorized
404not_found

Example

curl -X GET "https://contracts.mattering.io/api/user/v1/envelopes/PUBLIC_ID/" \
  -H "Authorization: Bearer $MATTERING_API_KEY"

Source: ContractsCore/internal_api.py (internal_api.envelope_detail)

POST envelopes/{public_id}/documents/ User APIService tier

Attach a Mattering Files document to a draft packet as a PDF, and place the fields its tags ask for. Response: the document, the fields placed, the tags that matched nobody, and the signers still without a signature field.

URL

  • User APIhttps://contracts.mattering.io/api/user/v1/envelopes/{public_id}/documents/
  • Service tierhttps://contracts.mattering.io/api/internal/envelopes/{public_id}/documents/

Path parameters

NameType
public_idstr

Body keys (JSON)

KeyRequiredDefault
file_idoptional or conditionalnone
place_fieldsoptional or conditionaltrue
roleoptional or conditionalnone

Keys the view reads. A key not in this list is ignored by the view. Where a key is required only for some actions (for example the action dispatch), the description above says which.

Responses

200 bare JSON object (no envelope)

{
  "...": "..."
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
400file_id_required
401unauthorized
404file_not_found
404not_found
409not_editable
502file_unavailable

Example

curl -X POST "https://contracts.mattering.io/api/user/v1/envelopes/PUBLIC_ID/documents/" \
  -H "Authorization: Bearer $MATTERING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "file_id": "...",
  "place_fields": true,
  "role": "..."
}'

Source: ContractsCore/packet_api.py (packet_api.envelope_documents)

GET envelopes/{public_id}/events/ User APIService tier

Read one of the envelopes by id. derived from route

URL

  • User APIhttps://contracts.mattering.io/api/user/v1/envelopes/{public_id}/events/
  • Service tierhttps://contracts.mattering.io/api/internal/envelopes/{public_id}/events/

Path parameters

NameType
public_idstr

Responses

200 bare JSON object (no envelope)

{
  "...": "..."
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
401unauthorized
404not_found

Example

curl -X GET "https://contracts.mattering.io/api/user/v1/envelopes/PUBLIC_ID/events/" \
  -H "Authorization: Bearer $MATTERING_API_KEY"

Source: ContractsCore/internal_api.py (internal_api.envelope_events)

GETPOST envelopes/{public_id}/fields/ User APIService tier

GET: the packet's fields. POST: add fields at explicit coordinates (normalized 0..1, top-left origin, the builder's shape); ``replace`` clears the target document's fields first. Each field names its recipient by number in signing order, email or name.

URL

  • User APIhttps://contracts.mattering.io/api/user/v1/envelopes/{public_id}/fields/
  • Service tierhttps://contracts.mattering.io/api/internal/envelopes/{public_id}/fields/

Path parameters

NameType
public_idstr

Body keys (JSON)

KeyRequiredDefault
document_idoptional or conditionalnone
fieldsoptional or conditionalnone
replaceoptional or conditionalnone

Keys the view reads. A key not in this list is ignored by the view. Where a key is required only for some actions (for example the action dispatch), the description above says which.

Responses

200 bare JSON object (no envelope)

{
  "...": "..."
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
400fields_required
400invalid_fields
401unauthorized
404document_not_found
404not_found
409no_documents
409not_editable

Example

curl -X POST "https://contracts.mattering.io/api/user/v1/envelopes/PUBLIC_ID/fields/" \
  -H "Authorization: Bearer $MATTERING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "document_id": "...",
  "fields": "...",
  "replace": "..."
}'

Source: ContractsCore/packet_api.py (packet_api.envelope_fields)

POST envelopes/{public_id}/send/ User APIService tier

POST to envelopes/{public_id}/send/. derived from route

URL

  • User APIhttps://contracts.mattering.io/api/user/v1/envelopes/{public_id}/send/
  • Service tierhttps://contracts.mattering.io/api/internal/envelopes/{public_id}/send/

Path parameters

NameType
public_idstr

Responses

200 bare JSON object (no envelope)

{
  "ok": true,
  "envelope": {
    "public_id": "...",
    "id": "...",
    "title": "...",
    "status": "...",
    "space_id": "...",
    "enforce_signing_order": "...",
    "created_at": "2026-01-01T00:00:00Z",
    "sent_at": "2026-01-01T00:00:00Z",
    "completed_at": "2026-01-01T00:00:00Z",
    "document_count": 0,
    "recipient_count": 0,
    "has_certificate": true,
    "recipients": [
      {
        "public_id": "...",
        "name": "...",
        "email": "...",
        "role": "...",
        "routing_order": "...",
        "status": "...",
        "signed_at": "2026-01-01T00:00:00Z"
      }
    ],
    "contract_document": {
      "public_id": "..."
    }
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
401unauthorized
404not_found

Example

curl -X POST "https://contracts.mattering.io/api/user/v1/envelopes/PUBLIC_ID/send/" \
  -H "Authorization: Bearer $MATTERING_API_KEY"

Source: ContractsCore/internal_api.py (internal_api.envelope_send)

All Contracts resources
Start Free Explore our Products