---
updatedAt: 2025-06-05T21:48:40.000Z
agentTools:
  projectIndex: https://docs.cloudloop.com/llms.txt
---

# Search Agreements

Retrieve listing of all Agreements filterable by Status and/or Plan

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "cloudloop",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.cloudloop.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "query",
        "name": "token"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/Certus/DoSearchAgreements": {
      "get": {
        "summary": "Search Agreements",
        "description": "Retrieve listing of all Agreements filterable by Status and/or Plan",
        "operationId": "search-agreements",
        "parameters": [
          {
            "name": "status",
            "in": "query",
            "description": "Optional",
            "schema": {
              "type": "string",
              "enum": [
                "ENACTED",
                "EXPIRED"
              ]
            }
          },
          {
            "name": "plan",
            "in": "query",
            "description": "Optional",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"agreements\": [\n    {\n      \"enactedAt\": \"2023-01-17T00:00:00\",\n      \"expiryBehaviour\": \"RENEW\",\n      \"expiryAt\": \"2023-11-16T23:59:59\",\n      \"name\": \"8e2b45da-9bc0-441d-ae2c-8accc2b3cba7\",\n      \"overflown\": false,\n      \"id\": \"MOVdRorbmlwqkNBpoEJYPZvxaXpzjLgK\",\n      \"overflownAt\": null,\n      \"plan\": \"MOVdRorbmlwqkNBpoEJYPZvxaXpzjLgK\",\n      \"account\": \"yJGjpPobLlmOdaEVPnAKYzNMgwVZkrRe\",\n      \"overflowBehaviour\": \"SUSPEND\",\n      \"status\": \"ENACTED\"\n    }\n  ]\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "agreements": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "enactedAt": {
                            "type": "string",
                            "example": "2023-01-17T00:00:00"
                          },
                          "expiryBehaviour": {
                            "type": "string",
                            "example": "RENEW"
                          },
                          "expiryAt": {
                            "type": "string",
                            "example": "2023-11-16T23:59:59"
                          },
                          "name": {
                            "type": "string",
                            "example": "8e2b45da-9bc0-441d-ae2c-8accc2b3cba7"
                          },
                          "overflown": {
                            "type": "boolean",
                            "example": false,
                            "default": true
                          },
                          "id": {
                            "type": "string",
                            "example": "MOVdRorbmlwqkNBpoEJYPZvxaXpzjLgK"
                          },
                          "overflownAt": {},
                          "plan": {
                            "type": "string",
                            "example": "MOVdRorbmlwqkNBpoEJYPZvxaXpzjLgK"
                          },
                          "account": {
                            "type": "string",
                            "example": "yJGjpPobLlmOdaEVPnAKYzNMgwVZkrRe"
                          },
                          "overflowBehaviour": {
                            "type": "string",
                            "example": "SUSPEND"
                          },
                          "status": {
                            "type": "string",
                            "example": "ENACTED"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```