List Forms On A Project
list_forms_on_a_projectRetrieve a paginated list of all forms for a project. Filter by ID, privacy, creator, template, or search to find specific forms.
Instructions
Return a list of all Forms from a specified Project. Use this to enumerate Forms when you need a paginated overview, to find IDs, or to filter by query parameters. Returns a paginated JSON array of Forms. Use page and per_page to control pagination; the response includes pagination metadata. Required parameters: project_id. Procore API (v1.1): Project Management > Forms. Endpoint: GET /rest/v1.1/projects/{project_id}/forms
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | URL path parameter — unique identifier for the project. | |
| page | No | Query string parameter — page number for paginated results (default: 1) | |
| per_page | No | Query string parameter — number of items per page (default: 100, max: 100) | |
| filters__id | No | Query string parameter — return item(s) with the specified IDs. | |
| filters__private | No | Query string parameter — if true, returns only item(s) with a `private` status. | |
| filters__created_by_id | No | Query string parameter — returns item(s) created by the specified User IDs. | |
| filters__form_template_id | No | Query string parameter — array of Form Template IDs. Return item(s) associated with the specified Form Template IDs. | |
| filters__search | No | Query string parameter — returns item(s) matching the specified search query string. | |
| filters__created_at | No | Query string parameter — return item(s) created within the specified ISO 8601 datetime range. Formats: `YYYY-MM-DD`...`YYYY-MM-DD` - Date `YYYY-MM-DDTHH:MM:SSZ`...`YYYY-MM-DDTHH:MM:SSZ` - DateTime with UTC Offset `YYYY-MM-... | |
| filters__updated_at | No | Query string parameter — return item(s) last updated within the specified ISO 8601 datetime range. Formats: `YYYY-MM-DD`...`YYYY-MM-DD` - Date `YYYY-MM-DDTHH:MM:SSZ`...`YYYY-MM-DDTHH:MM:SSZ` - DateTime with UTC Offset `YYY... | |
| sort | No | Query string parameter — sort order for results. Prefix with '-' for descending order |