Get Signature Signees

Retrieve all employees who have been sent a handbook for signing, along with their signing status.

Query

query GetSignatureSignees($handbookId: Int!) {
  getSignatureSignees(handbookId: $handbookId) {
    signees {
      id
      formId
      name
      email
      createdAt
      updatedAt
      signedAt
      signedFileUrl
    }
    total
  }
}

Parameters

Parameter	Type	Required	Description
handbookId	Int!	Yes	The handbook ID to get signees for

Response

{
  "data": {
    "getSignatureSignees": {
      "signees": [
        {
          "id": 1,
          "formId": "abc-123-def",
          "name": "John Doe",
          "email": "[email protected]",
          "createdAt": "2025-01-15T10:00:00Z",
          "updatedAt": "2025-01-15T10:00:00Z",
          "signedAt": "2025-01-16T14:30:00Z",
          "signedFileUrl": "https://firma-server.handbooks.io/signed/abc123.pdf"
        },
        {
          "id": 2,
          "formId": "abc-123-def",
          "name": "Jane Smith",
          "email": "[email protected]",
          "createdAt": "2025-01-15T10:00:00Z",
          "updatedAt": "2025-01-15T10:00:00Z",
          "signedAt": null,
          "signedFileUrl": null
        }
      ],
      "total": 2
    }
  }
}

Examples

Basic Usage

query {
  getSignatureSignees(handbookId: 123) {
    signees {
      name
      email
      signedAt
    }
    total
  }
}

Check Unsigned Employees

Query all signees and filter for those with signedAt: null to find employees who haven't yet signed.

query {
  getSignatureSignees(handbookId: 123) {
    signees {
      name
      email
      signedAt
      formId
    }
    total
  }
}

Error Responses

Handbook Not Found

{
  "errors": [{ "message": "Handbook not found or access denied" }]
}

Subscription Required

{
  "errors": [{ "message": "This operation requires an active subscription. ONE_TIME or unsubscribed handbooks are not supported." }]
}

Notes

• Requires reseller API key authentication
• The handbook must belong to a customer of the authenticated reseller
• Requires an active subscription (SUBSCRIPTION status) — ONE_TIME or unsubscribed handbooks are not supported
• Returns an empty list if no signature requests have been sent
• signedAt is null for employees who haven't signed yet
• signedFileUrl contains the URL to the signed PDF document (only available after signing)
• The formId field is needed when resending signature request reminders