{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Reference subpackage_accounts subpackage_records API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "subpackage_records",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get records",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.x.flatfile.com/v1/sheets/:sheetId/records",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "sheetId",
                "value": "",
                "type": "path",
                "description": "ID of sheet"
              },
              {
                "name": "versionId",
                "value": "",
                "type": "query",
                "description": "Deprecated, use `commitId` instead."
              },
              {
                "name": "commitId",
                "value": "",
                "type": "query"
              },
              {
                "name": "sinceVersionId",
                "value": "",
                "type": "query",
                "description": "Deprecated, use `sinceCommitId` instead."
              },
              {
                "name": "sinceCommitId",
                "value": "",
                "type": "query"
              },
              {
                "name": "sortField",
                "value": "",
                "type": "query"
              },
              {
                "name": "sortDirection",
                "value": "",
                "type": "query"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query"
              },
              {
                "name": "filterField",
                "value": "",
                "type": "query",
                "description": "Name of field by which to filter records"
              },
              {
                "name": "searchValue",
                "value": "",
                "type": "query"
              },
              {
                "name": "searchField",
                "value": "",
                "type": "query"
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "The Record Ids param (ids) is a list of record ids that can be passed to several record endpoints allowing the user to identify specific records to INCLUDE in the query, or specific records to EXCLUDE, depending on whether or not filters are being applied. When passing a query param that filters the record dataset, such as 'searchValue', or a 'filter' of 'valid' | 'error' | 'all', the 'ids' param will EXCLUDE those records from the filtered results. For basic queries that do not filter the dataset, passing record ids in the 'ids' param will limit the dataset to INCLUDE just those specific records. Maximum of 100 allowed."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of records to return in a page (default 10,000)"
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Based on pageSize, which page of records to return (Note - numbers start at 1)"
              },
              {
                "name": "includeCounts",
                "value": "",
                "type": "query",
                "description": "**DEPRECATED** Use GET /sheets/:sheetId/counts"
              },
              {
                "name": "includeLength",
                "value": "",
                "type": "query",
                "description": "The length of the record result set, returned as counts.total"
              },
              {
                "name": "includeLinks",
                "value": "",
                "type": "query",
                "description": "If true, linked records will be included in the results. Defaults to false."
              },
              {
                "name": "includeMessages",
                "value": "",
                "type": "query",
                "description": "Include error messages, defaults to false."
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "A list of field keys to include in the response. If not provided, all fields will be included."
              },
              {
                "name": "for",
                "value": "",
                "type": "query",
                "description": "if \"for\" is provided, the query parameters will be pulled from the event payload"
              },
              {
                "name": "q",
                "value": "",
                "type": "query",
                "description": "An FFQL query used to filter the result set"
              }
            ]
          },
          "docs": "Returns records from a sheet in a workbook"
        },
        {
          "info": {
            "name": "Insert records",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.x.flatfile.com/v1/sheets/:sheetId/records",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "sheetId",
                "value": "",
                "type": "path",
                "description": "ID of sheet"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Adds records to a workbook sheet"
        },
        {
          "info": {
            "name": "Update records",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.x.flatfile.com/v1/sheets/:sheetId/records",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "sheetId",
                "value": "",
                "type": "path",
                "description": "ID of sheet"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates existing records in a workbook sheet"
        },
        {
          "info": {
            "name": "Delete records",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.x.flatfile.com/v1/sheets/:sheetId/records",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "sheetId",
                "value": "",
                "type": "path",
                "description": "ID of sheet"
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "A list of record IDs to delete. Maximum of 100 allowed."
              }
            ]
          },
          "docs": "Deletes records from a workbook sheet"
        },
        {
          "info": {
            "name": "Get record Indices",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.x.flatfile.com/v1/sheets/:sheetId/records/indices",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "sheetId",
                "value": "",
                "type": "path",
                "description": "ID of sheet"
              },
              {
                "name": "commitId",
                "value": "",
                "type": "query"
              },
              {
                "name": "sinceCommitId",
                "value": "",
                "type": "query"
              },
              {
                "name": "sortField",
                "value": "",
                "type": "query"
              },
              {
                "name": "sortDirection",
                "value": "",
                "type": "query"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query"
              },
              {
                "name": "filterField",
                "value": "",
                "type": "query",
                "description": "Name of field by which to filter records"
              },
              {
                "name": "searchValue",
                "value": "",
                "type": "query"
              },
              {
                "name": "searchField",
                "value": "",
                "type": "query"
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "List of record IDs to include in the query. Limit 100."
              },
              {
                "name": "q",
                "value": "",
                "type": "query",
                "description": "An FFQL query used to filter the result set"
              }
            ]
          },
          "docs": "Returns indices of records from a sheet in a workbook"
        },
        {
          "info": {
            "name": "Finds and replaces field values matching search criteria\n",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.x.flatfile.com/v1/sheets/:sheetId/find-replace",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "sheetId",
                "value": "",
                "type": "path",
                "description": "ID of sheet"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query"
              },
              {
                "name": "filterField",
                "value": "",
                "type": "query",
                "description": "Name of field by which to filter records"
              },
              {
                "name": "searchValue",
                "value": "",
                "type": "query"
              },
              {
                "name": "searchField",
                "value": "",
                "type": "query"
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "The Record Ids param (ids) is a list of record ids that can be passed to several record endpoints allowing the user to identify specific records to INCLUDE in the query, or specific records to EXCLUDE, depending on whether or not filters are being applied. When passing a query param that filters the record dataset, such as 'searchValue', or a 'filter' of 'valid' | 'error' | 'all', the 'ids' param will EXCLUDE those records from the filtered results. For basic queries that do not filter the dataset, passing record ids in the 'ids' param will limit the dataset to INCLUDE just those specific records"
              },
              {
                "name": "q",
                "value": "",
                "type": "query",
                "description": "An FFQL query used to filter the result set"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Searches for all values that match the 'find' value (globally or for a specific field via 'fieldKey') and replaces them with the 'replace' value. Wrap 'find' value in double quotes for exact match (\"\"). Returns a commitId for the updated records"
        },
        {
          "info": {
            "name": "Bulk update records with field values\n",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.x.flatfile.com/v1/sheets/:sheetId/records/bulk-update",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "sheetId",
                "value": "",
                "type": "path",
                "description": "ID of sheet"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query"
              },
              {
                "name": "filterField",
                "value": "",
                "type": "query",
                "description": "Name of field by which to filter records"
              },
              {
                "name": "searchValue",
                "value": "",
                "type": "query"
              },
              {
                "name": "searchField",
                "value": "",
                "type": "query"
              },
              {
                "name": "sortField",
                "value": "",
                "type": "query"
              },
              {
                "name": "sortDirection",
                "value": "",
                "type": "query"
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "The Record Ids param (ids) is a list of record ids that can be passed to several record endpoints allowing the user to identify specific records to INCLUDE in the query, or specific records to EXCLUDE, depending on whether or not filters are being applied. When passing a query param that filters the record dataset, such as 'searchValue', or a 'filter' of 'valid' | 'error' | 'all', the 'ids' param will EXCLUDE those records from the filtered results. For basic queries that do not filter the dataset, passing record ids in the 'ids' param will limit the dataset to INCLUDE just those specific records"
              },
              {
                "name": "q",
                "value": "",
                "type": "query",
                "description": "An FFQL query used to filter the result set"
              },
              {
                "name": "silent",
                "value": "",
                "type": "query",
                "description": "Whether to suppress events for this bulk update"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates multiple records at once with the same field values based on filter criteria. This is similar to a SQL UPDATE statement where you can update specific fields for all records matching certain conditions."
        }
      ]
    }
  ],
  "bundled": true
}