> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.coperniq.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.coperniq.io/_mcp/server.

# List Forms

GET https://api.coperniq.io/v1/forms

Retrieve a paginated list of forms across every project and opportunity in your company, including forms on account work orders.
Field values are not included; fetch them with `GET /forms/{form_id}`.

Supports:

* Pagination (`page_size`, `page`)
* Date filtering (`updated_after`, `updated_before`)
* Filtering by `project_id`, `opportunity_id`, `account_id`, `work_order_id`, `template_id` and `status`
* Sorting by `updated_at` or `created_at` (`order_by`, `order`), oldest updated first by default

**Note:** Archiving a form doesn't update its `updatedAt`, so `updated_after` doesn't pick up archive changes.

Reference: https://docs.coperniq.io/api-reference/forms/list-forms

## Authentication

- `x-api-key` header (required) — API Key authentication via header

## Request

### Query parameters

- `page_size` (integer, optional, default: 20) — Number of items per page (max 100)
- `page` (integer, optional, default: 1) — Page number (1-based)
- `updated_after` (FormsGetParametersUpdatedAfter, optional) — Only return forms updated after this timestamp (ISO 8601). Archiving a form doesn't update its `updatedAt`, so `updated_after` doesn't pick up archive changes.
- `updated_before` (FormsGetParametersUpdatedBefore, optional) — Only return forms updated before this timestamp (ISO 8601). Must not be earlier than `updated_after`.
- `project_id` (integer, optional) — Only return forms on this project. Use only one of `project_id`, `opportunity_id` or `account_id`.
- `opportunity_id` (integer, optional) — Only return forms on this opportunity. Use only one of `project_id`, `opportunity_id` or `account_id`.
- `account_id` (integer, optional) — Only return forms on this account's work orders (forms can't be added to an account directly). Use only one of `project_id`, `opportunity_id` or `account_id`.
- `work_order_id` (integer, optional) — Only return forms attached to this work order
- `template_id` (integer, optional) — Only return forms created from this form template
- `status` (enum, optional) — Only return forms with this status
  - Allowed values: `UNASSIGNED`, `ASSIGNED`, `REVIEW`, `CHANGES_REQUESTED`, `COMPLETED`, `CANCELLED`
- `include_archived` (boolean, optional, default: false) — Include forms whose file is archived. By default archived forms are excluded.
- `order_by` (enum, optional, default: updated_at) — Field to sort by. Ties are broken by form id so pages never overlap.
  - Allowed values: `updated_at`, `created_at`
- `order` (enum, optional, default: asc) — Sort direction. Defaults to oldest first.
  - Allowed values: `asc`, `desc`

## Response

### 200

List of forms

- `list of FormListItem`

## Errors

### 400 Bad Request Error

Invalid request

- `message` (string, optional)
- `code` (enum, optional)
  - Allowed values: `GRAPHQL_ERROR`
- `field` (string, optional) — Field that caused the validation error (if applicable)

### 401 Unauthorized Error

Authentication failed

- `message` (string, optional)
- `code` (enum, optional)
  - Allowed values: `GRAPHQL_ERROR`

### 500 Internal Server Error

Internal server error

- `message` (string, optional)
- `code` (enum, optional)
  - Allowed values: `GRAPHQL_ERROR`

### 502 Bad Gateway Error

Bad Gateway — downstream GraphQL service returned errors

- `message` (string, required) — Summary of the downstream service failure
- `code` (enum, required)
  - Allowed values: `GRAPHQL_ERROR`

## Types

### FormsGetParametersUpdatedAfter

- string
- string

### FormsGetParametersUpdatedBefore

- string
- string

### FormListItem

Form summary returned by `GET /forms`. Fetch field values with `GET /forms/{form_id}`.

- `id` (integer, required) — Form identifier
- `name` (string, required, nullable) — Form name
- `templateId` (integer, required, nullable) — The form template this form was created from
- `projectId` (integer, required, nullable) — The project the form is on; null if it's on an opportunity or account
- `opportunityId` (integer, required, nullable) — The opportunity the form is on; null otherwise
- `accountId` (integer, required, nullable) — The account whose work order the form is on; null otherwise
- `workOrderId` (integer, required, nullable) — The work order the form is attached to; null if it isn't on a work order
- `status` (enum, required, nullable)
  - Allowed values: `UNASSIGNED`, `ASSIGNED`, `REVIEW`, `CHANGES_REQUESTED`, `COMPLETED`, `CANCELLED`
- `isCompleted` (boolean, required)
- `completedAt` (string, required, nullable)
- `isArchived` (boolean, required) — Whether the form's file is archived. Only `true` when `include_archived=true`.
- `createdAt` (string, required)
- `updatedAt` (string, required) — When the form last changed, including answer edits. Archiving a form doesn't update its `updatedAt`, so `updated_after` doesn't pick up archive changes.

## Examples

**Response**

```json
[
  {
    "id": 48211,
    "name": "Site Survey",
    "templateId": 912,
    "projectId": 10452,
    "opportunityId": null,
    "accountId": null,
    "workOrderId": 88310,
    "status": "COMPLETED",
    "isCompleted": true,
    "completedAt": "2026-11-02T17:04:11.000Z",
    "isArchived": false,
    "createdAt": "2026-10-30T15:20:00.000Z",
    "updatedAt": "2026-11-02T17:04:11.000Z"
  },
  {
    "id": 48230,
    "name": "Permit Checklist",
    "templateId": 915,
    "projectId": null,
    "opportunityId": 10460,
    "accountId": null,
    "workOrderId": null,
    "status": "ASSIGNED",
    "isCompleted": false,
    "completedAt": null,
    "isArchived": false,
    "createdAt": "2026-11-01T09:12:45.000Z",
    "updatedAt": "2026-11-03T08:41:02.000Z"
  }
]
```

**SDK Code**

```python Forms_listForms_example
import requests

url = "https://api.coperniq.io/v1/forms"

querystring = {"updated_after":"2026-11-01T00:00:00Z"}

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript Forms_listForms_example
const url = 'https://api.coperniq.io/v1/forms?updated_after=2026-11-01T00%3A00%3A00Z';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Forms_listForms_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.coperniq.io/v1/forms?updated_after=2026-11-01T00%3A00%3A00Z"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Forms_listForms_example
require 'uri'
require 'net/http'

url = URI("https://api.coperniq.io/v1/forms?updated_after=2026-11-01T00%3A00%3A00Z")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java Forms_listForms_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.coperniq.io/v1/forms?updated_after=2026-11-01T00%3A00%3A00Z")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php Forms_listForms_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.coperniq.io/v1/forms?updated_after=2026-11-01T00%3A00%3A00Z', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Forms_listForms_example
using RestSharp;

var client = new RestClient("https://api.coperniq.io/v1/forms?updated_after=2026-11-01T00%3A00%3A00Z");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Forms_listForms_example
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.coperniq.io/v1/forms?updated_after=2026-11-01T00%3A00%3A00Z")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```