Skip to main content
GET
/
agreements
List agreements
curl --request GET \
  --url https://sandbox-api.finpace.example/v1/agreements \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "agreementId": "agr_01JQ9KQ2TX9H3FXA84W2T44GM6",
      "partyId": "<string>",
      "productCode": "SME.CA.STANDARD",
      "status": "draft",
      "agreementType": "current-account",
      "effectiveFrom": "2023-12-25",
      "effectiveTo": "2023-12-25",
      "signedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "pageSize": 50,
    "nextPageToken": "eyJvZmZzZXQiOjUwfQ=="
  }
}

Authorizations

Authorization
string
header
required

OAuth 2.0 with client credentials for machine integrations and authorization code for delegated user sessions.

Headers

X-Request-Id
string

Caller-generated correlation identifier used for tracing.

Maximum string length: 80

Query Parameters

partyId
string
status
string
pageSize
integer
default:50

Maximum number of records to return.

Required range: 1 <= x <= 200
pageToken
string

Opaque continuation token returned by a previous page.

Response

200 - application/json

Agreements returned

items
object[]
pagination
object