Contract

List all Contracts 🌍

Returns all Contracts. This list is paginated.
Required scopes: contracts:read

get/companies/{companyId}/contracts

Request

Base URL
https://partner-api.payfit.com
Auth
OAuth 2
Authorization codehttps://oauth.payfit.com/authorize
Token URLhttps://oauth.payfit.com/token
Scopescontracts:read
TypeScript
https://skmtc.dev/payfit/apis/partner-api/docs/companies/:companyId/contracts/get.ts
A function with typed inputs. Its response is checked against the schema.

companyIdstring required

The id of the company

nextPageTokenstring

The encoded pagination token

maxResultsstring

Allows to define the maximum number of items to fetch at once. (Max: 50, Default: 10)

includeInProgressContractsstring

Allow to returns the in progress contracts (or in creation)

All active, pending and last year archived contracts

Nov 3, 20264ad2186afd5e Revision changes
- breaking
  the response property //// became nullable for the status