> For the complete documentation index, see [llms.txt](https://docs.umbraco.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.umbraco.com/umbraco-forms/17.latest/developer/working-with-data.md). # Working With Record Data Umbraco Forms includes some helper methods that return records of a given Form, which can be used to output records in your templates using razor. ## Available Methods The methods can be found by injecting the `Umbraco.Forms.Core.Services.IRecordReaderService` interface. These methods are paged, but each one returns the records for an entire Form or Umbraco page. To filter records on the server, use the `IFormRecordSearcher` interface instead. It is described in the [Querying records with a filter](#querying-records-with-a-filter) section below, and supports options such as a submission date range. ### GetApprovedRecordsFromPage ```csharp PagedModel GetApprovedRecordsFromPage(int pageId, int pageNumber, int pageSize) ``` Returns all records with the state set to approved from all Forms on the Umbraco page with the id = `pageId` . ### GetApprovedRecordsFromFormOnPage ```csharp PagedModel GetApprovedRecordsFromFormOnPage(int pageId, Guid formId, int pageNumber, int pageSize) ``` Returns all records with the state set to approved from the Form with the id = `formId` on the Umbraco page with the id = `pageId` as a `PagedModel`. ### GetApprovedRecordsFromForm ```csharp PagedModel GetApprovedRecordsFromForm(Guid formId, int pageNumber, int pageSize) ``` Returns all records with the state set to approved from the Form with the ID = `formId` as a `PagedModel`. ### GetRecordsFromPage ```csharp PagedModel GetRecordsFromPage(int pageId, int pageNumber, int pageSize) ``` Returns all records from all Forms on the Umbraco page with the id = `pageId` as a `PagedModel`. ### GetRecordsFromFormOnPage ```csharp PagedModel GetRecordsFromFormOnPage(int pageId, Guid formId, int pageNumber, int pageSize) ``` Returns all records from the Form with the id = `formId` on the Umbraco page with the id = `pageId` as a `PagedModel`. ### GetRecordsFromForm ```csharp PagedModel GetRecordsFromForm(Guid formId, int pageNumber, int pageSize) ``` Returns all records from the Form with the ID = formId as a `PagedModel`. ## The returned objects All of these methods will return an object of type `PagedModel` so you can iterate through the `Record` objects. The properties available on a `Record` are: ```csharp int Id FormState State DateTime Created DateTime Updated Guid Form string IP int UmbracoPageId string MemberKey Guid UniqueId Dictionary RecordFields ``` In order to access custom Form fields, these are available in the `RecordFields` property. Furthermore there exists an extension method named `ValueAsString` on `Record` in `Umbraco.Forms.Core.Extensions`, such that you can get the value as string given the alias of the field. This extension method handle multi value fields by comma separating the values. E.g. "A, B, C" ## Sample razor script Sample script that is outputting comments using a Form created with the default comment Form template. ```csharp @using Umbraco.Forms.Core.Extensions; @using Umbraco.Forms.Core.Services; @inject IRecordReaderService _recordReaderService;
    @foreach (var record in _recordReaderService.GetApprovedRecordsFromPage(Model.Id, 1, 10).Items) {
  • @record.Created.ToString("dd MMMM yyy") @if(string.IsNullOrEmpty(record.ValueAsString("email"))){ @record.ValueAsString("name") } else{ @record.ValueAsString("name") } said

    @record.ValueAsString("comment")

    • }
``` ## Querying records with a filter The `IRecordReaderService` methods above return all records for a Form or Umbraco page. When you need to query records with server-side filtering, for example, retrieving only the submissions created within a date range, inject the `Umbraco.Forms.Core.Searchers.IFormRecordSearcher` interface instead. This is the same database-level query used by the entries view in the backoffice. The filtering and paging are applied in the query sent to the database, so it does not load every record for the Form into memory. Describe the query by passing a `RecordFilter`. Its main properties are: ```csharp int Skip // Start index (defaults to 0). int Take // Number of records to return (defaults to 20). string? MemberKey // Only records submitted by this member. string SortBy // Column to sort by: "created", "updated" or "state". RecordSorting SortOrder // Sort direction. DateTime StartDate // Only records created on or after this date (UTC). DateTime EndDate // Only records created on or before this date (UTC). string? Filter // Free-text search across the record values. List States // Only records in these states. Leave empty to return all states. List RecordIds // Only records with these specific unique Ids. ``` `StartDate` and `EndDate` filter on the record's created date and are matched in UTC, so provide UTC values. Both dates are optional. If you leave `StartDate` unset, it defaults to a date far in the past. If you leave `EndDate` unset, it defaults to the current time. As a result, you can filter by only a start date or only an end date. The following example retrieves the records for a Form created in the last 24 hours: ```csharp @using System.Linq @using Umbraco.Forms.Core.Models @using Umbraco.Forms.Core.Searchers @inject IFormRecordSearcher _formRecordSearcher @{ var formId = new Guid("a34e0692-6a46-45f2-8b70-4ee0a72e4b0d"); var filter = new RecordFilter { StartDate = DateTime.UtcNow.AddDays(-1), Take = 100, }; EntrySearchResultCollection results = _formRecordSearcher.QueryDataBase(formId, filter); }

@results.TotalNumberOfResults record(s) submitted in the last 24 hours.

    @foreach (EntrySearchResult entry in results.Results) {
  • @entry.Created.ToString("g") - @entry.State
    • }
``` Each `EntrySearchResult` exposes the record metadata (`Id`, `UniqueId`, `State`, `Created`, `Updated`, and so on) together with a `Fields` collection. To read the value of a specific field, match the field's `Alias` in the returned `Schema` to its `Id`, then find the matching entry in `Fields`: ```csharp string GetFieldValue(EntrySearchResultCollection results, EntrySearchResult entry, string alias) { string? fieldId = results.Schema.FirstOrDefault(s => s.Alias == alias)?.Id; return entry.Fields.FirstOrDefault(f => f.FieldId == fieldId)?.Value?.ToString() ?? string.Empty; } ``` ## Loading a Record From a Submitted Form When a form is submitted, the submitted form ID and the saved record ID are stored in the `TempData` so they can be referenced. You can use the FormService and the RecordStorage to get the `Form` and `Record` objects. Here is a sample code for retrieving a record in a view. ``` @using Umbraco.Forms.Core.Models @using Umbraco.Forms.Core.Persistence.Dtos @using Umbraco.Forms.Core.Data.Storage @using Umbraco.Forms.Core.Services @inject IFormService _formService @inject IRecordStorage _recordStorage @inherits UmbracoViewPage @{ Guid formId; Form? form; Guid recordId; Record? record; string submittedEmail; if (Guid.TryParse(TempData["UmbracoFormSubmitted"]?.ToString(), out formId) && Guid.TryParse(TempData["Forms_Current_Record_id"]?.ToString(), out recordId)) { form = _formService.Get(formId); if (form != null && TempData["Forms_Current_Record_id"] != null) { Guid.TryParse(TempData["Forms_Current_Record_id"]?.ToString(), out recordId); record = _recordStorage.GetRecordByUniqueId(recordId, form); submittedEmail = record.GetRecordFieldByAlias("email")?.ValuesAsString(); } } } ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.umbraco.com/umbraco-forms/17.latest/developer/working-with-data.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.