Monax logo
Documentation Powered by ReDoc

Monax API (v1)

Download OpenAPI specification:Download

Monax: [email protected] URL: https://monax.io/docs License: Apache-2.0 Terms of Service
Happy Contracting!

Getting Started

We are pleased you have joined the Marmot-y movement.

Authentication

BearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

OAuth2

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:

          Agreements

          List agreements.

          Returns list of agreements (on+off chain) the requesting user is allowed access to, and additional relevant data.

          Authorizations:
          BearerAuthOAuth2
          query Parameters
          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

          Responses

          Response Schema: application/json
          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:

          • agreement owners
          • agreement parties (for on-chain agreements)
          • include an organization + team(s) to which the authenticated user belongs in its signatories Agreements list will be sorted in descending order of creation of the agreement
          totalAgreements
          number

          The total number of agreements exclusive of the paging limit

          Response samples

          Content type
          application/json
          {
          • "agreements": [
            ],
          • "totalAgreements": 0,
          • "actors": {
            }
          }

          Retrieve agreement.

          Agreement information for a single agreement

          Notes:

          • If the password provided is incorrect or a hoard reference which does not exist was passed to the posted Agreement this get will return a 401.
          • If the agreement was not authored by the logged in user or one of their organizations, or if its signatories does not include the logged in user or one of their organizations, this will return a 404.
          Authorizations:
          BearerAuthOAuth2
          path Parameters
          address
          required
          string
          Example: 16830871DE9CD69AEBB9920ABA59E88B9923B324

          Address of the agreement requesting

          query Parameters
          meta
          boolean

          Include the metadata under the meta key of each of this agreement's archetypes's documents

          Responses

          Response Schema: application/json
          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

          Response samples

          Content type
          application/json
          {
          • "agreement": {