Assignments

List assignments

Changed on

List the workspace's assignments, oldest first. With an OAuth token the workspace is the token's; otherwise pass accountId. Each assignment carries its document_id.

Copy as Markdown Open in ChatGPT Open in Claude

get/v1/assignments

Request

  • Base URL
    https://api.assinafy.com.br
  • URL
    https://api.assinafy.com.br/v1/assignments
  • Auth
    • HTTP bearer
    • or API key in header X-Api-Key

Query parameters

accountIdstring

The workspace ID. Required unless the request uses an OAuth token.

sortstring
Example:-created_at

created_at (default, oldest first), expires_at or id; prefix with - for descending (-created_at, newest first). Unknown values are ignored.

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",
      "document_id": "615601fab04c0a3147bb1246",
      "created_at": "2026-06-03T03:54:16Z",
      "sender_email": "sender@example.com",
      "method": "virtual",
      "signers": [
        {
          "resource": "signer",
          "id": "62d6ee35c7741ca4006b9e11",
          "full_name": "John Signer",
          "email": "john@email.com",
          "whatsapp_phone_number": "+5548999990000",
          "government_id": "39053344705",
          "verification_method": "Email",
          "notification_methods": [
            "Email"
          ],
          "step": 1,
          "identity_verification_status": "InReview",
          "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

  • f7da81a5567eRevision changes
    • breaking

      the response property /// became nullable for the status

  • dda5f0d393cbRevision changes
    • info

      added the new optional query request parameter accountId

    • info

      added the new optional query request parameter sort

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status