Skip to main content

Get Signature Requests - Paginated

GET 
/v3/applications/:appId/envs/:appEnv/signature-requests

This endpoint retrieves all signature requests for a given application and environment.

Request​

Path Parameters

    appId stringrequired

    The application identifier which is used to identify the application used.

    Example: appId_XXXX-XXXX-XXXX-XXXX-XXXX
    appEnv stringrequired

    Possible values: [DEVELOPMENT, STAGING, PRODUCTION]

    The execution environment of the application where request are executed.

Query Parameters

    page integer

    The page number to return.

Responses​

Paginated signature requests.

Schema

    signatureRequests

    object[]

    required

    An array of signature requests, each represented by an IgnisignSignatureRequest_WithDocName object.

  • Array [

    • _id string

    The unique identifier of the signature request.

    appId appId (string)required

    The application identifier which is used to identify the application used.

    appEnv IGNISIGN_APPLICATION_ENV (string)required

    Possible values: [DEVELOPMENT, STAGING, PRODUCTION]

    The execution environment of the application where request are executed.

    signatureProfileId stringrequired

    The identifier of the signature profile associated with the signature request.

    title string

    The title of the signature request.

    description string

    The description or details about the signature request.

    expirationDate date-time

    The expiration date of the signature request.

    expirationDateIsActivated boolean

    Indicates whether the expiration date is activated for the signature request.

    status IGNISIGN_SIGNATURE_REQUEST_STATUS (string)required

    Possible values: [DRAFT, WAITING_DOCUMENTS, WAITING_DOCUMENTS_GENERATION, READY, IN_PROGRESS, COMPLETED, EXPIRED, FAILED, CANCELLED, PROCESSING]

    Represents the current status of a signature request in the Ignisign application.

    language IGNISIGN_SIGNATURE_LANGUAGES (string)

    Possible values: [EN, FR, DE]

    Represents the languages for signatures supported by a signature profile.

    documentIds string[]

    An array of document identifiers associated with the signature request.

    externalId string

    An optional external identifier that can be used to reference the signature request from external systems.

    diffusionMode IGNISIGN_SIGNATURE_REQUEST_DIFFUSION_MODE (string)

    Possible values: [WHEN_READY, SCHEDULED]

    Represents the diffusion mode of a signature request.

    • WHEN_READY : The signature request will be sent to the signer as soon it is ready to be signed. This is the default value.
      I.E: If there are no document request, the signature request will be sent to the signer as soon as the signature request is PUBLISHED.
      If there are document request, the signature request will be sent to the signer as soon as all the document request are have been completed.
    • SCHEDULED : The signature request will be sent to the signer at a specific date. This date is specified in the diffusionDate field
    diffusionDate date-time

    The date when the signature request is to be diffused.

    signerIds string[]

    An array of signer identifiers associated with the signature request.

    signedBy string[]

    An array of identifiers of the signers who have signed the signature request.

    _createdAt date-time

    The date and time when the signature request was created.

    creatorId string

    The unique identifier of the user who created the signature request.

    docFileName string

    The name of the document associated with the signature request.

    docLabel string

    The label or title of the document associated with the signature request.

    initialSignatureRequestId string

    If the signature request has been created from a signature profile with the individualizeRequests option activated, this field will contain the identifier of the initial signature request which it has been generated.

    signersAsApprover string[]

    the ids of signers that will be approvers

    recipients string[]

    the emails of signers that will receive a copy of the signed document

  • ]

    • paginationData

    object

    required

    The pagination data for the list of signature requests.

    total numberrequired

    The total number of signature requests.

    page numberrequired

    The current page number in the pagination.

    nbEventsPerPage numberrequired

    The number of signature request events per page.

Loading...