This API uses OAuth 2 for more information.
Security Scheme Type | OAuth2 |
---|---|
authorizationCode OAuth Flow | Authorization URL: https://login.monax.io/oauth/authorize?audience="monax-api" Token URL: https://login.monax.io/oauth/token Scopes: |
implicit OAuth Flow | Authorization URL: https://login.monax.io/oauth/authorize?audience="monax-api" Scopes: |
clientCredentials OAuth Flow | Token URL: https://login.monax.io/oauth/token?audience="monax-api" Scopes: |
password OAuth Flow | Token URL: https://login.monax.io/oauth/token?audience="monax-api" Scopes: |
Returns list of agreements (on+off chain) the requesting user is allowed access to, and additional relevant data.
createdAt | string (AgreementListDateQuery) Example: createdAt={"range":["2020-01-01", "2020-02-01"],"outsideRange":false} When was the agreement created at? |
departmentId | string Example: departmentId=387B8541B0AEAFD802B07CA63408BB7ABA67C1CE91D6534EFA4B64BB7754DE2F Optionally filter results by the department that manages the agreement |
effectiveDate | string (AgreementListDateQuery) Example: effectiveDate={"range":["2020-01-01", "2020-02-01"],"outsideRange":false} When was the effective date of the agreement? |
expirationDate | string (AgreementListDateQuery) Example: expirationDate={"range":["2020-01-01", "2020-02-01"],"outsideRange":false} When was the expiration date of the agreement? |
limit | number Example: limit=10 The maximum amount of the agreements to return |
name | string Optionally filter results by the name of the agreement |
offset | number Example: offset=10 How many agreements to skip before returning the agreements |
renewalDate | string (AgreementListDateQuery) Example: renewalDate={"range":["2020-01-01", "2020-02-01"],"outsideRange":false} When was the renewal date of the agreement? |
sortColumn | string (AgreementListSortColumn) Enum: "name" "createdAt" What field to order the agreements on |
sortDirection | string (SortDirection) Enum: "asc" "desc" The sort direction |
statuses | string Optionally filter results by the agreement status with JSON array of agreement statuses to include. |
withExpiry | string Example: withExpiry=true Optionally filter results presence of an expiration date |
withRenewal | string Example: withRenewal=true Optionally filter results presence of a renewal date |
withSignatures | string Example: withSignatures=true Optionally filter results presence of an effective date |
object (AgreementActors) Data of the entities associated with the agreement. (Ex the assignees of any pending tasks.) | |
Array of objects (AgreementListItem) List of both on-chain and draft agreements the requesting user is authorized to read. Authorized users include:
| |
totalAgreements | number The total number of agreements exclusive of the paging limit |
{- "agreements": [
- {
- "id": "string",
- "address": "string",
- "name": "string",
- "createdAt": "string",
- "status": -1,
- "pendingInternalActionBy": [
- "string"
], - "pendingExternalActionBy": [
- "string"
], - "task": {
- "type": "activity",
- "name": "string",
- "detail": "string",
- "isIndividual": true,
- "redirectURL": "string",
- "createdAt": 0
}
}
], - "totalAgreements": 0,
- "actors": {
- "users": {
- "property1": {
- "address": "string",
- "userid": "string",
- "name": "string",
- "email": "string"
}, - "property2": {
- "address": "string",
- "userid": "string",
- "name": "string",
- "email": "string"
}
}, - "organizations": {
- "property1": {
- "address": "string",
- "name": "string",
- "isIndividual": true
}, - "property2": {
- "address": "string",
- "name": "string",
- "isIndividual": true
}
}
}
}
Agreement information for a single agreement
Notes:
401
.404
.address required | string Example: 16830871DE9CD69AEBB9920ABA59E88B9923B324 Address of the agreement requesting |
meta | boolean Include the metadata under the |
required | object (AgreementActors) Data of the entities associated with the agreement. (Ex the assignees of any pending tasks.) |
required | object (Agreement) An agreement has the following fields |
{- "agreement": {
- "address": "string",
- "archetype": "string",
- "name": "string",
- "createdAt": 0,
- "creator": "string",
- "owner": "string",
- "ownerScope": [
- "string"
], - "attachmentsFileReference": "string",
- "privateParametersFileReference": "string",
- "signaturesFileReference": "string",
- "isPrivate": true,
- "legalState": 0,
- "creatorDisplayName": "string",
- "ownerDisplayName": "string",
- "requester": {
- "address": "string",
- "organizationAddress": "string",
- "isOwner": true,
- "isRepresentative": true,
- "isViewer": true,
- "mayActAsParty": "string"
}, - "isParty": true,
- "isCreator": true,
- "isOwner": true,
- "parties": [
- {