> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Forms

> Archive provider for the list of forms (the form table). Backs the Forms

## "Forms"

This provider name is implemented by the class <see cref="T:SuperOffice.CRM.ArchiveLists.FormsProvider">SuperOffice.CRM.ArchiveLists.FormsProvider</see> inside NetServer's SODatabase assembly.

Archive provider for the list of forms (the form table). Backs the Forms
pane's flat tabs — Recent (via <see cref="T:SuperOffice.CRM.ArchiveLists.FormsHistoryExtender" />'s
historyRank), My forms (registeredBy) and Active forms (formActive) — and,
as a sub-provider, the folder-aware <see cref="T:SuperOffice.CRM.ArchiveLists.FormsAndFoldersProvider" />.

No restriction on form.type is applied here: the type is exposed as the
filter-only <see cref="F:SuperOffice.CRM.ArchiveLists.FormExtenderBase.ColFormType" /> column so the Forms
pane can ask for Normal forms and the Form-templates pane for Templates,
both from this one provider.

## Supported Entities

| Name   | Description |
| ------ | ----------- |
| "form" | Form        |

## Supported Columns

| Name                                  | Restriction | Description                                                                                | OrderBy |
| ------------------------------------- | ----------- | ------------------------------------------------------------------------------------------ | ------- |
| getAllRows                            | bool        | GetAll: Get all rows of archive - use with care, you may be fetching the whole database    |         |
| getNoRows                             | bool        | GetNone: Do not get any rows from the archive                                              |         |
| formId                                | int         | ID: Form ID                                                                                | x       |
| formName                              | string      | Name: Form name                                                                            | x       |
| formDescription                       | string      | Description: Form description                                                              | x       |
| formThumbnail                         | *None*      | Thumbnail: Form thumbnail                                                                  |         |
| formFolderId                          | int         | Hierarchy ID: Foreign key to hierarchy table                                               | x       |
| formActive                            | int         | Active: Active                                                                             | x       |
| formType                              | int         | Form name: Form name                                                                       | x       |
| formSubmissionCount                   | *None*      | Form submissions: List of form submissions                                                 |         |
| updatedBy                             | associate   | Updated by: The user who last updated the data                                             | x       |
| updatedDate                           | date        | Updated: The date/time the data was last updated in UTC.                                   | x       |
| registeredBy                          | associate   | Registered by: The user who registered the data                                            | x       |
| registeredDate                        | date        | Registered date: The date/time the data was registered in UTC.                             | x       |
| registeredByFullName                  | associate   | Registered by - Full name: The user who registered the data                                | x       |
| type                                  | *None*      | Type: Displays the type of an activity                                                     |         |
| sortName                              | *None*      |                                                                                            | x       |
| emailFlow/emailFlowId                 | int         | E-mail flow ID: The database ID of the e-mail flow                                         | x       |
| emailFlow/emailFlowHierarchyId        | int         | Hierarchy ID: Foreign key to hierarchy table                                               | x       |
| emailFlow/shipmentType                | listAny     | Mailing type: Mailing type this e-mail flow represents                                     | x       |
| emailFlow/overrideConsentSubscription | bool        | Override consent: Should consent subscriptions be overridden for this flow?                | x       |
| emailFlow/thumbnail                   | *None*      | Thumbnail                                                                                  |         |
| emailFlow/mediumThumbnail             | *None*      | Thumbnail                                                                                  |         |
| emailFlow/workflowId                  | int         | Flow id: Id of a flow definition                                                           | x       |
| emailFlow/workflowName                | string      | Name: Name of the flow definition                                                          | x       |
| emailFlow/workflowDescription         | string      | Description: Description of flow definition                                                | x       |
| emailFlow/workflowDefinitionStatus    | listAny     | Status: Status of the flow definition                                                      | x       |
| emailFlow/workflowDefinitionStatusId  | listAny     | Status: Status of the flow definition                                                      | x       |
| emailFlow/jumpToFinish                | bool        | Jump to finish: Should participant jump to finish when the goals are met?                  | x       |
| emailFlow/startOnlyOnce               | bool        | Start only once: Should the participant enter the flow only once?                          | x       |
| emailFlow/workflowEnrolledCount       | *None*      | Enrolled: How many times has a participant entered this flow?                              |         |
| emailFlow/workflowInProgressCount     | *None*      | In progress: How many participants are in progress                                         |         |
| emailFlow/workflowCompletedCount      | *None*      | Completed: How many participants are completed                                             |         |
| emailFlow/workflowSucceededCount      | *None*      | Succeeded: How many participants have successfully completed the flow (goal criteria met)? |         |
| emailFlow/workflowSuccessRate         | *None*      | Success rate: Success rate, based on goals criteria met                                    |         |
| emailFlow/updatedBy                   | associate   | Updated by: The user who last updated the data                                             | x       |
| emailFlow/updatedDate                 | date        | Updated: The date/time the data was last updated in UTC.                                   | x       |
| emailFlow/registeredBy                | associate   | Registered by: The user who registered the data                                            | x       |
| emailFlow/registeredDate              | date        | Registered date: The date/time the data was registered in UTC.                             | x       |
| historyRank                           | int         | Rank: Rank of list item, if available                                                      | x       |

## Sample

```http! theme={null}
GET /api/v1/archive/Forms?$select=emailFlow/emailFlowId,registeredDate,emailFlow/overrideConsentSubscription
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: sv

```

See also: <see cref="T:SuperOffice.CRM.Services.IArchiveAgent">IArchiveAgent</see>.


## Related topics

- [form](/en/api/mdo-providers/reference/form.md)
- [Forms](/en/automation/crmscript/howto/marketing/forms.md)
- [Work with forms](/en/marketing/forms/learn/index.md)
- [Publish forms](/en/marketing/forms/learn/publish.md)
- [form table](/en/database/tables/form.md)
- [FormsAndFolders](/en/api/archive-providers/reference/formsandfolders.md)