---
updatedAt: 2026-04-23T09:12:50.000Z
agentTools:
  projectIndex: https://developers.youtrust.com/llms.txt
---

# Get Invited signers consumption records

Returns the list of Invited signers consumption records.

**🔓 Endpoint access**

* Environments: `production`
* API key scopes: `organization`, `workspace`
* Plans: `plus`, `pro`, `scale`
* Add-ons (for production access): *none*

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "contact": {
      "email": "contact@youtrust.com",
      "name": "Support",
      "url": "https://youtrust.com/contact"
    },
    "description": "Build the best experience of digital signature through your own platform. Increase your conversion rates, leverage your data and reduce your costs with Youtrust API.",
    "license": {
      "name": "proprietary",
      "url": "https://youtrust.com/terms"
    },
    "title": "Public Api v3",
    "version": "3.0"
  },
  "servers": [
    {
      "description": "Sandbox URL",
      "url": "https://api-sandbox.yousign.app/v3"
    },
    {
      "description": "Production URL",
      "url": "https://api.yousign.app/v3"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "tags": [
    {
      "description": "This resource provides tracking of the API usage.",
      "name": "Consumption"
    }
  ],
  "paths": {
    "/consumptions/records/invited_signers": {
      "get": {
        "description": "Returns the list of Invited signers consumption records.",
        "operationId": "get-consumptions-records-invited_signers",
        "parameters": [
          {
            "description": "After cursor (pagination)",
            "in": "query",
            "name": "after",
            "required": false,
            "schema": {
              "minLength": 1,
              "type": "string"
            }
          },
          {
            "description": "The limit of items count to retrieve.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "default": 100,
              "maximum": 100,
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "description": "Filter by `created_at`. Allowed operators: `between`, `before`, `after`.\nFormat: `yyyy-mm-dd`\nExamples:\n  - `created_at[between]=2025-03-02,2025-03-04`\n  - `created_at[after]=2025-03-02`\n",
            "example": {
              "between": [
                "2025-03-02",
                "2025-03-04"
              ],
              "before": [
                "2025-03-02"
              ]
            },
            "explode": true,
            "in": "query",
            "name": "created_at",
            "required": false,
            "schema": {
              "description": "Filter by date of creation.",
              "minProperties": 1,
              "type": "object"
            },
            "style": "deepObject"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/get_consumptions_records_invited_signers_200_response"
                }
              }
            },
            "description": "OK",
            "headers": {
              "RateLimit-Limit": {
                "$ref": "#/components/headers/rateLimit-limit"
              },
              "X-RateLimit-Limit-Hour": {
                "$ref": "#/components/headers/rateLimit-limit-hour"
              },
              "X-RateLimit-Limit-Minute": {
                "$ref": "#/components/headers/rateLimit-limit-minute"
              },
              "RateLimit-Remaining": {
                "$ref": "#/components/headers/rateLimit-remaining"
              },
              "X-RateLimit-Remaining-Hour": {
                "$ref": "#/components/headers/rateLimit-remaining-hour"
              },
              "X-RateLimit-Remaining-Minute": {
                "$ref": "#/components/headers/rateLimit-remaining-minute"
              },
              "RateLimit-Reset": {
                "$ref": "#/components/headers/rateLimit-reset"
              }
            }
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BadRequestResponse"
                }
              }
            },
            "description": "Bad request",
            "headers": {
              "RateLimit-Limit": {
                "$ref": "#/components/headers/rateLimit-limit"
              },
              "X-RateLimit-Limit-Hour": {
                "$ref": "#/components/headers/rateLimit-limit-hour"
              },
              "X-RateLimit-Limit-Minute": {
                "$ref": "#/components/headers/rateLimit-limit-minute"
              },
              "RateLimit-Remaining": {
                "$ref": "#/components/headers/rateLimit-remaining"
              },
              "X-RateLimit-Remaining-Hour": {
                "$ref": "#/components/headers/rateLimit-remaining-hour"
              },
              "X-RateLimit-Remaining-Minute": {
                "$ref": "#/components/headers/rateLimit-remaining-minute"
              },
              "RateLimit-Reset": {
                "$ref": "#/components/headers/rateLimit-reset"
              }
            }
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UnauthorizedResponse"
                }
              }
            },
            "description": "Access unauthorized",
            "headers": {
              "RateLimit-Limit": {
                "$ref": "#/components/headers/rateLimit-limit"
              },
              "X-RateLimit-Limit-Hour": {
                "$ref": "#/components/headers/rateLimit-limit-hour"
              },
              "X-RateLimit-Limit-Minute": {
                "$ref": "#/components/headers/rateLimit-limit-minute"
              },
              "RateLimit-Remaining": {
                "$ref": "#/components/headers/rateLimit-remaining"
              },
              "X-RateLimit-Remaining-Hour": {
                "$ref": "#/components/headers/rateLimit-remaining-hour"
              },
              "X-RateLimit-Remaining-Minute": {
                "$ref": "#/components/headers/rateLimit-remaining-minute"
              },
              "RateLimit-Reset": {
                "$ref": "#/components/headers/rateLimit-reset"
              }
            }
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ForbiddenResponse"
                }
              }
            },
            "description": "Access forbidden",
            "headers": {
              "RateLimit-Limit": {
                "$ref": "#/components/headers/rateLimit-limit"
              },
              "X-RateLimit-Limit-Hour": {
                "$ref": "#/components/headers/rateLimit-limit-hour"
              },
              "X-RateLimit-Limit-Minute": {
                "$ref": "#/components/headers/rateLimit-limit-minute"
              },
              "RateLimit-Remaining": {
                "$ref": "#/components/headers/rateLimit-remaining"
              },
              "X-RateLimit-Remaining-Hour": {
                "$ref": "#/components/headers/rateLimit-remaining-hour"
              },
              "X-RateLimit-Remaining-Minute": {
                "$ref": "#/components/headers/rateLimit-remaining-minute"
              },
              "RateLimit-Reset": {
                "$ref": "#/components/headers/rateLimit-reset"
              }
            }
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotFoundResponse"
                }
              }
            },
            "description": "Resource not found",
            "headers": {
              "RateLimit-Limit": {
                "$ref": "#/components/headers/rateLimit-limit"
              },
              "X-RateLimit-Limit-Hour": {
                "$ref": "#/components/headers/rateLimit-limit-hour"
              },
              "X-RateLimit-Limit-Minute": {
                "$ref": "#/components/headers/rateLimit-limit-minute"
              },
              "RateLimit-Remaining": {
                "$ref": "#/components/headers/rateLimit-remaining"
              },
              "X-RateLimit-Remaining-Hour": {
                "$ref": "#/components/headers/rateLimit-remaining-hour"
              },
              "X-RateLimit-Remaining-Minute": {
                "$ref": "#/components/headers/rateLimit-remaining-minute"
              },
              "RateLimit-Reset": {
                "$ref": "#/components/headers/rateLimit-reset"
              }
            }
          },
          "405": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MethodNotAllowed"
                }
              }
            },
            "description": "This method is not allowed",
            "headers": {
              "RateLimit-Limit": {
                "$ref": "#/components/headers/rateLimit-limit"
              },
              "X-RateLimit-Limit-Hour": {
                "$ref": "#/components/headers/rateLimit-limit-hour"
              },
              "X-RateLimit-Limit-Minute": {
                "$ref": "#/components/headers/rateLimit-limit-minute"
              },
              "RateLimit-Remaining": {
                "$ref": "#/components/headers/rateLimit-remaining"
              },
              "X-RateLimit-Remaining-Hour": {
                "$ref": "#/components/headers/rateLimit-remaining-hour"
              },
              "X-RateLimit-Remaining-Minute": {
                "$ref": "#/components/headers/rateLimit-remaining-minute"
              },
              "RateLimit-Reset": {
                "$ref": "#/components/headers/rateLimit-reset"
              },
              "Retry-After": {
                "$ref": "#/components/headers/retry-after"
              }
            }
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TooManyRequestsResponse"
                }
              }
            },
            "description": "Too Many Requests, please try again later.",
            "headers": {
              "RateLimit-Limit": {
                "$ref": "#/components/headers/rateLimit-limit"
              },
              "X-RateLimit-Limit-Hour": {
                "$ref": "#/components/headers/rateLimit-limit-hour"
              },
              "X-RateLimit-Limit-Minute": {
                "$ref": "#/components/headers/rateLimit-limit-minute"
              },
              "RateLimit-Remaining": {
                "$ref": "#/components/headers/rateLimit-remaining"
              },
              "X-RateLimit-Remaining-Hour": {
                "$ref": "#/components/headers/rateLimit-remaining-hour"
              },
              "X-RateLimit-Remaining-Minute": {
                "$ref": "#/components/headers/rateLimit-remaining-minute"
              },
              "RateLimit-Reset": {
                "$ref": "#/components/headers/rateLimit-reset"
              },
              "Retry-After": {
                "$ref": "#/components/headers/retry-after"
              }
            }
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InternalServerError"
                }
              }
            },
            "description": "Internal Server Error",
            "headers": {
              "RateLimit-Limit": {
                "$ref": "#/components/headers/rateLimit-limit"
              },
              "X-RateLimit-Limit-Hour": {
                "$ref": "#/components/headers/rateLimit-limit-hour"
              },
              "X-RateLimit-Limit-Minute": {
                "$ref": "#/components/headers/rateLimit-limit-minute"
              },
              "RateLimit-Remaining": {
                "$ref": "#/components/headers/rateLimit-remaining"
              },
              "X-RateLimit-Remaining-Hour": {
                "$ref": "#/components/headers/rateLimit-remaining-hour"
              },
              "X-RateLimit-Remaining-Minute": {
                "$ref": "#/components/headers/rateLimit-remaining-minute"
              },
              "RateLimit-Reset": {
                "$ref": "#/components/headers/rateLimit-reset"
              }
            }
          }
        },
        "summary": "Get Invited signers consumption records",
        "tags": [
          "Consumption"
        ]
      }
    }
  },
  "components": {
    "headers": {
      "rateLimit-limit": {
        "description": "The maximum number of requests that the consumer is permitted to make in a given period",
        "schema": {
          "type": "integer"
        }
      },
      "rateLimit-limit-hour": {
        "description": "The maximum number of requests that the consumer is permitted to make in an hour window",
        "schema": {
          "type": "integer"
        }
      },
      "rateLimit-limit-minute": {
        "description": "The maximum number of requests that the consumer is permitted to make in an minute window",
        "schema": {
          "type": "integer"
        }
      },
      "rateLimit-remaining": {
        "description": "The number of requests remaining in the current rate limit window",
        "schema": {
          "type": "integer"
        }
      },
      "rateLimit-remaining-hour": {
        "description": "The number of requests remaining in the current hour rate limit window",
        "schema": {
          "type": "integer"
        }
      },
      "rateLimit-remaining-minute": {
        "description": "The number of requests remaining in the current minute rate limit window",
        "schema": {
          "type": "integer"
        }
      },
      "rateLimit-reset": {
        "description": "The remaining time until the rate limit resets in seconds",
        "schema": {
          "type": "integer"
        }
      },
      "retry-after": {
        "description": "Retry the request after X seconds",
        "schema": {
          "type": "integer"
        }
      }
    },
    "schemas": {
      "Pagination": {
        "description": "Metadata about the response.",
        "properties": {
          "next_cursor": {
            "description": "Token to get the next page of results. If `null`, there are no more pages.\n",
            "minLength": 1,
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "next_cursor"
        ],
        "type": "object"
      },
      "InvitedSignersConsumption": {
        "properties": {
          "created_at": {
            "description": "Creation time of the record",
            "example": "2024-05-01 12:00:00",
            "type": "string"
          },
          "signer_id": {
            "example": "0e8f7f8a-1b2c-4d3e-9f0a-b1c2d3e4f5a6",
            "format": "uuid",
            "type": "string"
          },
          "signer_email": {
            "example": "test@example.com",
            "type": "string"
          },
          "signature_request_id": {
            "example": "6c82bd7a-d7f7-45e0-82f4-b92222567346",
            "format": "uuid",
            "nullable": true,
            "type": "string"
          },
          "signature_request_name": {
            "example": "Signature Name",
            "type": "string"
          },
          "signature_level": {
            "description": "Level of the Signature Request.",
            "enum": [
              "simple_electronic_signature",
              "advanced_electronic_signature",
              "electronic_signature_with_qualified_certificate",
              "qualified_electronic_signature"
            ],
            "example": "simple_electronic_signature",
            "type": "string"
          },
          "sender_id": {
            "example": "0e8f7f8a-1b2c-4d3e-9f0a-b1c2d3e4f5a6",
            "format": "uuid",
            "nullable": true,
            "type": "string"
          },
          "sender_email": {
            "example": "test@example.com",
            "nullable": true,
            "type": "string"
          },
          "source": {
            "description": "Origin of the operation.",
            "example": "app",
            "type": "string"
          },
          "connector": {
            "description": "Signature request origin.",
            "enum": [
              "app",
              "public_api",
              "connector_salesforce_api",
              "hubspot_integration",
              "connector_google_api",
              "connector_zapier_api"
            ],
            "example": "app",
            "nullable": true,
            "type": "string"
          },
          "authentication_key": {
            "description": "Identifier of the key used for the operation.",
            "example": "authkey_live_2x1s3k9p",
            "nullable": true,
            "type": "string"
          },
          "authentication_key_description": {
            "description": "Description of the key used for the operation.",
            "nullable": true,
            "type": "string"
          },
          "external_id": {
            "description": "Optional user-defined identifier.",
            "example": "ext-12345",
            "nullable": true,
            "type": "string"
          },
          "workspace_id": {
            "example": "9b6ed2f3-244f-487a-baa1-bbe4f51c8748",
            "format": "uuid",
            "nullable": true,
            "type": "string"
          },
          "workspace_name": {
            "description": "Name of the workspace.",
            "example": "My workspace",
            "type": "string"
          },
          "signer_fullname": {
            "description": "Full name of the signer.",
            "example": "Jane Doe",
            "type": "string"
          },
          "workspace_external_name": {
            "description": "External name of the workspace.",
            "example": "My workspace",
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "authentication_key",
          "authentication_key_description",
          "connector",
          "created_at",
          "external_id",
          "sender_email",
          "sender_id",
          "signature_level",
          "signature_request_id",
          "signature_request_name",
          "signer_email",
          "signer_fullname",
          "signer_id",
          "source",
          "workspace_external_name",
          "workspace_id",
          "workspace_name"
        ],
        "type": "object"
      },
      "BadRequestResponse": {
        "properties": {
          "type": {
            "type": "string"
          },
          "detail": {
            "type": "string"
          }
        },
        "required": [
          "detail",
          "type"
        ],
        "title": "BadRequestResponse",
        "type": "object"
      },
      "UnauthorizedResponse": {
        "properties": {
          "type": {
            "type": "string"
          },
          "detail": {
            "type": "string"
          }
        },
        "required": [
          "detail",
          "type"
        ],
        "title": "UnauthorizedResponse",
        "type": "object"
      },
      "ForbiddenResponse": {
        "properties": {
          "type": {
            "type": "string"
          },
          "detail": {
            "type": "string"
          }
        },
        "required": [
          "detail",
          "type"
        ],
        "title": "ForbiddenResponse",
        "type": "object"
      },
      "NotFoundResponse": {
        "properties": {
          "type": {
            "type": "string"
          },
          "detail": {
            "type": "string"
          }
        },
        "required": [
          "detail",
          "type"
        ],
        "title": "NotFoundResponse",
        "type": "object"
      },
      "MethodNotAllowed": {
        "properties": {
          "message": {
            "type": "string"
          }
        },
        "required": [
          "message"
        ],
        "title": "MethodNotAllowed",
        "type": "object"
      },
      "TooManyRequestsResponse": {
        "properties": {
          "message": {
            "type": "string"
          }
        },
        "required": [
          "message"
        ],
        "title": "TooManyRequestsResponse",
        "type": "object"
      },
      "InternalServerError": {
        "properties": {
          "type": {
            "example": "about:blank",
            "type": "string"
          },
          "detail": {
            "example": "Something wrong occurred.",
            "type": "string"
          }
        },
        "required": [
          "detail",
          "type"
        ],
        "title": "InternalServerError",
        "type": "object"
      },
      "get_consumptions_records_invited_signers_200_response": {
        "properties": {
          "meta": {
            "$ref": "#/components/schemas/Pagination"
          },
          "data": {
            "items": {
              "$ref": "#/components/schemas/InvitedSignersConsumption"
            },
            "type": "array"
          }
        },
        "required": [
          "data",
          "meta"
        ],
        "type": "object"
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  }
}
```