Assignments

List assignments

List the assignments belonging to the authenticated user's current account.

Copy as Markdown Open in ChatGPT Open in Claude

get/v1/assignments

Query parameters

pageinteger
Example:1

Page number.

per-pageinteger
Example:25

Records per page (max 100).

Response

A page of assignments

statusinteger

HTTP status code, mirrored in the body.

messagestring

Human-readable message; empty on success.

Example response

{
  "status": 200,
  "data": [
    {
      "resource": "assignment",
      "id": "615606ef81d199996981dbce",
      "sender_email": "sender@example.com",
      "method": "virtual",
      "signers": [
        {
          "resource": "signer",
          "id": "62d6ee35c7741ca4006b9e11",
          "full_name": "John Signer",
          "email": "john@email.com",
          "whatsapp_phone_number": "+5548999990000",
          "verification_method": "Email",
          "notification_methods": [
            "Email"
          ],
          "step": 1,
          "notification_history": [
            {
              "event": "signature_request",
              "status": "sent",
              "sent_at": "2026-07-07T12:00:00Z"
            }
          ]
        }
      ],
      "items": [
        {
          "page": {
            "id": "615601faf166d6d1d8e7dc30",
            "number": 1,
            "height": 2100,
            "width": 1275,
            "download_url": "https://api.assinafy.com.br/v1/documents/doc1/pages/1a/download"
          }
        }
      ],
      "signing_urls": [
        {
          "url": "https://api.assinafy.com.br/v1/sign/doc1?email=joe@example.com"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.