SWswisscom
Process: read

Get all processes (paginated)

Returns a paginated list of processes.

Supports optional filtering by status, teamId, and validUntilWithin (ISO 8601 duration). The page size is limited to a maximum of 20 items. Sorting is strictly performed on 'createdDate', but the direction (ASC/DESC) can be defined.

get/api/process

Request

Query parameters

status'CREATED' | 'PENDING' | 'COMPLETED' | 'EXPIRED'

Lifecycle states:

  • CREATED – Process object exists; configuration may continue.
  • PENDING – Process released; waiting for signatures..
  • COMPLETED – All required signatures done.
  • EXPIRED – Automatically set when validUntil is reached.
Example:PENDING

Filter by status.

teamIdstring uuid

Filter by team ID.

validUntilWithinstring

Filter by validUntil within the given ISO 8601 duration (e.g. P30D, PT12H).

pageinteger

Zero-based page index (0..N)

sizeinteger

The size of the page to be returned

sortstring[]

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Response

Returns a page of processes.

totalElementsinteger

Deprecated: use page.totalElements instead.

totalPagesinteger

Deprecated: use page.totalPages instead.

numberinteger

Deprecated: use page.number instead.

sizeinteger

Deprecated: use page.size instead.

firstboolean

Deprecated: use page.number == 0 instead.

lastboolean

Deprecated: use page.number == page.totalPages - 1 instead.

Example response

{
  "content": [
    {
      "signatureLevel": "QUALIFIED",
      "initiator": {
        "type": "NON_PERSON",
        "externalIdentifier": "ext-systems_oms-42",
        "name": "Swisscom Sign Orchestrator"
      },
      "invitees": {
        "personalMessage": "Hello, please sign. Thank you!",
        "signers": [
          {
            "type": "SIGNER",
            "firstName": "John",
            "lastName": "Doe",
            "email": "john.doe@example.com",
            "status": "PENDING"
          }
        ]
      },
      "properties": [
        {
          "key": "contractType",
          "value": "NDA"
        },
        {
          "key": "department",
          "value": "Legal"
        }
      ],
      "payload": "{ \"caseId\": \"ABC-42\", \"priority\": \"HIGH\" }",
      "validUntil": "2025-12-31T23:59:59Z"
    }
  ]
}

Changes

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