Pagination

The pagination.conf file defines default and maximum pagination limits used by Enterprise list endpoints that support limit, offset, and, on some endpoints, sort.

Configuration

pagination.conf
{
  "defaultLimit": 100,
  "maxLimit": 1000
}

Fields

  • defaultLimit: applied when limit is not provided by the client.
  • maxLimit: upper bound accepted for limit.

offset is not configurable — it always defaults to 0 when omitted.

Query parameters

  • limit (integer, optional): number of entries to return. Defaults to defaultLimit; must be greater than 0 and less than or equal to maxLimit.
  • offset (integer, optional): number of entries to skip. Defaults to 0; must be greater than or equal to 0.
  • sort (string, optional): only accepted on endpoints marked Sortable in the table below. Supported values:
    • createdDateTime or createdDateTime- — newest created first (the bare value is shorthand for -, descending)
    • createdDateTime+ — oldest created first (ascending)
    • updatedDateTime or updatedDateTime- — most recently updated first (descending)
    • updatedDateTime+ — least recently updated first (ascending)

    Passing sort on an endpoint that isn't marked Sortable returns 400 Bad Request. When sort is omitted, each endpoint falls back to its own default order, which isn't necessarily insertion order — pass sort explicitly if your client depends on ordering.

The + in createdDateTime+ / updatedDateTime+ must be URL-encoded as %2B. A literal, unencoded + in a query string is decoded as a space by the server, so ?sort=createdDateTime+ pasted directly into a browser or a raw HTTP client is received as "createdDateTime " and rejected with 400 Bad Request. HTTP client libraries that percent-encode query parameters for you (most SDKs, curl --data-urlencode) are unaffected.

Validation behavior

For list endpoints using this pagination contract, the API returns 400 Bad Request when:

  • limit <= 0
  • limit > maxLimit
  • offset < 0
  • limit or offset is not an integer
  • sort is provided on an endpoint that doesn't support it
  • sort is provided with a value outside the supported list above

Endpoint behavior

The following list endpoints support this contract:

EndpointSortable
GET /v1/{target}/resource-api/resources/listNo
GET /v1/{target}/credential-store-service-api/credentials/listYes
GET /v1/{target}/credential-store-service-api/credentials/list-idsNo
GET /v1/{target}/did-store-service-api/didsYes
GET /v1/{target}/did-store-service-api/dids/list-did-idsNo
GET /v1/{target}/kms-service-api/keys/listYes
GET /v1/{target}/x509-store-api/certificatesYes
GET /v1/{target}/x509-store-api/certificates/idsNo
GET /v2/{target}/issuer-service-api/sessionsYes
GET /v1/{target}/verifier2-service-api/sessionsYes
GET /v1/{target}/policy-store-service-api/policies/listNo
GET /v1/{target}/policy-store-service-api/policies/list-idsNo
GET /v1/{target}/credential-status-service-api/status-credential/listNo
GET /v1/{target}/vical-service-api/versions/idsNo

Responses remain arrays (no pagination envelope is added).

See also: List Service Resources and Manage Certificates for worked examples.

Last updated on July 7, 2026