Namirial · Schema

EnvelopeFindRequest

The request model for searching envelopes.

CompanyDigital TrustE-SignatureIdentity VerificationDigital IdentityTrust ServicesCompliance

Properties

Name Type Description
StartDate string If set, filter for envelopes which were sent after the start date. A datetime in the format RFC 3339, section 5.6, 'date-Time' (e.g. 2017-07-21T17:32:28Z).
EndDate string If set, filter for envelopes which were sent before the end date. A datetime in the format RFC 3339, section 5.6, 'date-Time' (e.g. 2017-07-21T17:32:28Z).
SearchText string If set, the given text is searched in following fields: envelope name and description notification subject and message sender email address, given name and surname recipient email address, given name
Status string If set, envelopes in the given status are matched.
InStatusSinceDays integer If set, envelopes having the given status for the specified days are matched. It must be combined with Status.
SenderEmail string If set, envelopes sent by the user with the given email address are matched.
CompletedByRecipientWithEmail string If set, envelopes containing a completed activity, belonging to a recipient with the given email address, are matched.
RecipientEmail string If set, envelopes containing a recipient with the given email address are matched.
WaitingForRecipientWithEmail string If set, envelopes waiting for the recipient with the given email address are matched.
EnvelopeBulkParentId string If set, envelopes belonging to the given BulkParent envelope are matched.
View JSON Schema on GitHub

JSON Schema

namirial-envelope-find-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/namirial/json-schema/namirial-envelope-find-request-schema.json",
  "title": "EnvelopeFindRequest",
  "description": "The request model for searching envelopes.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/namirial-envelope-api-openapi.yml#/components/schemas/EnvelopeFindRequest",
  "type": "object",
  "properties": {
    "StartDate": {
      "format": "date-time",
      "description": "If set, filter for envelopes which were sent after the start date.\nA datetime in the format RFC 3339, section 5.6, 'date-Time' (e.g. 2017-07-21T17:32:28Z).",
      "maxLength": 30,
      "minLength": 20,
      "type": "string"
    },
    "EndDate": {
      "format": "date-time",
      "description": "If set, filter for envelopes which were sent before the end date.\nA datetime in the format RFC 3339, section 5.6, 'date-Time' (e.g. 2017-07-21T17:32:28Z).",
      "maxLength": 30,
      "minLength": 20,
      "type": "string"
    },
    "SearchText": {
      "description": "If set, the given text is searched in following fields:\nenvelope name and description\nnotification subject and message \nsender email address, given name and surname  \nrecipient email address, given name and surname\nNote: Using this search option is very resource intensive! It might take very long.",
      "maxLength": 500,
      "minLength": 0,
      "type": "string"
    },
    "Status": {
      "description": "If set, envelopes in the given status are matched.",
      "enum": [
        "Canceled",
        "Completed",
        "Expired",
        "Rejected",
        "ActionRequired",
        "WaitingForOthers",
        "ExpiringSoon",
        "Active"
      ],
      "type": "string"
    },
    "InStatusSinceDays": {
      "description": "If set, envelopes having the given status for the specified days are matched.\nIt must be combined with Status.",
      "type": "integer"
    },
    "SenderEmail": {
      "description": "If set, envelopes sent by the user with the given email address are matched.",
      "maxLength": 250,
      "minLength": 0,
      "type": "string"
    },
    "CompletedByRecipientWithEmail": {
      "description": "If set, envelopes containing a completed activity, belonging to a recipient with the given email address, are matched.",
      "maxLength": 250,
      "minLength": 0,
      "type": "string"
    },
    "RecipientEmail": {
      "description": "If set, envelopes containing a recipient with the given email address are matched.",
      "maxLength": 250,
      "minLength": 0,
      "type": "string"
    },
    "WaitingForRecipientWithEmail": {
      "description": "If set, envelopes waiting for the recipient with the given email address are matched.",
      "maxLength": 250,
      "minLength": 0,
      "type": "string"
    },
    "EnvelopeBulkParentId": {
      "description": "If set, envelopes belonging to the given BulkParent envelope are matched.",
      "maxLength": 36,
      "minLength": 36,
      "type": "string"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/namirial-envelope-find-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.