---
agentTools:
  projectIndex: https://docs.marbleapi.com/llms.txt
---

# Get Forms

Retrieves Forms for a life.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Public",
    "version": "21.09"
  },
  "servers": [
    {
      "url": "https://api.marbleapi.com"
    }
  ],
  "paths": {
    "/lives/{lifeId}/forms": {
      "get": {
        "tags": [
          "Lives"
        ],
        "summary": "Get Forms",
        "description": "Retrieves Forms for a life.",
        "operationId": "lives-get-forms",
        "parameters": [
          {
            "$ref": "#/components/parameters/apiVersion"
          },
          {
            "name": "lifeId",
            "in": "path",
            "description": "Life Id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "ignoreIncomplete",
            "in": "query",
            "description": "Whether or not to ignore the incomplete form. Defaults to false",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "ignoreArchived",
            "in": "query",
            "description": "Whether or not to ignore the archived form. Defaults to false",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "$ref": "#/components/parameters/limit"
          },
          {
            "$ref": "#/components/parameters/offset"
          }
        ],
        "responses": {
          "200": {
            "description": "OK - Forms retrieved",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "hasMore": {
                      "type": "boolean",
                      "example": true
                    },
                    "limit": {
                      "type": "integer",
                      "default": 10
                    },
                    "offset": {
                      "type": "integer",
                      "default": 0
                    },
                    "items": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/FormSummaryResponse"
                      }
                    }
                  }
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/403Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/404NotFound"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "FormEmbeddedSessionLocationEnum": {
        "type": "string",
        "enum": [
          "AfterLogin",
          "AfterProfile",
          "AfterProviderSearch",
          "AfterAuthorizations"
        ],
        "example": "AfterLogin"
      },
      "FormSummaryResponse": {
        "properties": {
          "id": {
            "type": "string",
            "example": "ac29300a-64d8-4b58-b7e3-a7fcb08456bc"
          },
          "title": {
            "type": "string",
            "example": "Form title goes here"
          },
          "description": {
            "type": "string",
            "example": "Form description goes here"
          },
          "embeddedSessionLocation": {
            "$ref": "#/components/schemas/FormEmbeddedSessionLocationEnum"
          },
          "createdAt": {
            "type": "string",
            "example": "2021-04-23T18:25:43.511Z"
          },
          "completedAt": {
            "type": "string",
            "example": "2021-04-24T18:25:43.511Z"
          },
          "archivedAt": {
            "type": "string",
            "example": "2021-04-25T18:25:43.511Z"
          }
        }
      }
    },
    "securitySchemes": {
      "apiKeyHeader": {
        "type": "apiKey",
        "name": "Api-Key",
        "in": "header"
      },
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "description": "Always required, obtain one using your Client Id and Client Secret"
      }
    },
    "parameters": {
      "apiVersion": {
        "name": "api-version",
        "in": "query",
        "description": "API Version",
        "schema": {
          "type": "string",
          "default": "21.09"
        }
      },
      "limit": {
        "name": "limit",
        "in": "query",
        "description": "Maximum number of items to be returned.",
        "schema": {
          "type": "integer",
          "default": 10
        }
      },
      "offset": {
        "name": "offset",
        "in": "query",
        "description": "Number of items to be skipped to get the next items.",
        "schema": {
          "type": "integer",
          "default": 0
        }
      }
    },
    "responses": {
      "403Forbidden": {
        "description": "Forbidden <br><br>Returned when there are no authorizations for the specific resource."
      },
      "404NotFound": {
        "description": "Resource not found <br><br>Returned when the specific resource could not be found, or does not exist."
      }
    }
  },
  "security": [
    {
      "bearerAuth": [],
      "apiKeyHeader": []
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 99,
      "1": 129,
      "2": 102,
      "3": 174,
      "4": 222,
      "5": 237,
      "6": 125,
      "7": 0,
      "8": 30,
      "9": 225,
      "10": 38,
      "11": 162
    }
  }
}
```