Leases
Signatures

List all contracts pending signature

Retrieves the paginated list of all contracts pending signature for the tenant.

Access

This endpoint is for users with the "owner" role in the tenant. It returns all contracts where at least one signer has a PENDING or SIGNING status.

Automatic filtering

  • Only contracts from the authenticated user's tenant are returned (multi-tenant isolation)
  • Contracts with COMPLETED, EXPIRED, or CANCELLED status are excluded
  • Only contracts with at least one pending signer are returned

Returned information

For each contract, you receive:

  • Document information (ID, lease, status, dates, URLs)
  • Complete list of all signers with their individual statuses
  • The URL of the PDF document to sign
  • The URL of the signed PDF (if available)

Pagination

Use limit and offset to paginate results. The total_count field indicates the total number of matching contracts.

get/leases/signatures/pending

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/signatures/pending
  • Auth: HTTP bearer

Query parameters

limitinteger

Maximum number of results per page (default: 50, max: 100)

offsetinteger

Number of results to skip for pagination (default: 0)

Response

Pending contracts list retrieved successfully

total_countinteger required

Total number of pending contracts (all combined, before pagination)

limitinteger required

Maximum number of results per page (value used for the request)

offsetinteger required

Number of skipped results (pagination offset used)

Example response

{
  "contracts": [
    {
      "document_signature_id": "550e8400-e29b-41d4-a716-446655440000",
      "lease_id": "550e8400-e29b-41d4-a716-446655440001",
      "document_type": "LEASE",
      "status": "READY",
      "initiator_type": "proprietaire",
      "created_at": "2024-01-15T10:00:00Z",
      "expires_at": "2024-01-22T10:00:00Z",
      "signers": [
        {
          "signer_type": "PROPRIETAIRE",
          "signer_email": "owner@example.com",
          "signer_phone": "+33612345678",
          "status": "PENDING",
          "expires_at": "2024-01-22T10:00:00Z",
          "first_name": "Jean",
          "last_name": "Dupont"
        },
        {
          "signer_type": "LOCATAIRE",
          "signer_email": "tenant@example.com",
          "signer_phone": "+33612345679",
          "status": "COMPLETED",
          "expires_at": "2024-01-22T10:00:00Z",
          "first_name": "Marie",
          "last_name": "Martin"
        }
      ],
      "media_id": "550e8400-e29b-41d4-a716-446655440002",
      "signed_media_id": "550e8400-e29b-41d4-a716-446655440003",
      "document_url": "https://api.faireplace.com/api/media/serve/550e8400-e29b-41d4-a716-446655440002",
      "signed_pdf_url": "https://api.faireplace.com/api/media/serve/550e8400-e29b-41d4-a716-446655440003"
    }
  ],
  "total_count": 25,
  "limit": 50
}

Changes

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