Ometria · Schema

FieldForgetRequestPage

A page of field forget requests.

CompanyRetailCustomer Data PlatformArtificial IntelligenceMarketing

Properties

Name Type Description
requests array The list of paginated objects.
offset integer The offset value applied for pagination.
page_size integer The actual number of objects in the current page.
total_count integer The total number of field forget requests for the account.
View JSON Schema on GitHub

JSON Schema

ometria-field-forget-request-page-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/ometria/json-schema/ometria-field-forget-request-page-schema.json",
  "title": "FieldForgetRequestPage",
  "description": "A page of field forget requests.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/ometria-field-forget-email-phone-erasure-api-openapi.yml#/components/schemas/FieldForgetRequestPage",
  "type": "object",
  "properties": {
    "requests": {
      "type": "array",
      "description": "The list of paginated objects.",
      "items": {
        "$ref": "#/$defs/FieldForgetRequest"
      }
    },
    "offset": {
      "type": "integer",
      "description": "The offset value applied for pagination."
    },
    "page_size": {
      "type": "integer",
      "description": "The actual number of objects in the current page."
    },
    "total_count": {
      "type": "integer",
      "description": "The total number of field forget requests for the account."
    }
  },
  "$defs": {
    "FieldForgetRequest": {
      "type": "object",
      "description": "Describes a field forget request and its status",
      "properties": {
        "id": {
          "type": "string",
          "description": "The request ID"
        },
        "profile_hash": {
          "type": "string",
          "description": "The profile hash of the profile the request was filed for (eg 27f4-f0b281-00003039)."
        },
        "status": {
          "type": "string",
          "description": "Current state of the request. `pending`: accepted and queued. `in_progress`: being processed. Terminal states: `completed` (the requested fields were erased), `aborted_sole_identifier` (refused and nothing changed, because erasing the fields would have left the profile with no other identifier Ometria can match on), `not_found` (the profile did not exist when processed), `failed` (an error occurred; resubmit to retry).",
          "enum": [
            "pending",
            "in_progress",
            "completed",
            "aborted_sole_identifier",
            "failed",
            "not_found"
          ]
        },
        "fields": {
          "type": "array",
          "description": "The fields requested, sorted alphabetically and deduplicated.",
          "items": {
            "type": "string",
            "description": "A field that can be forgotten. This list is the set supported by the service and is kept in sync via the service's own spec test.",
            "enum": [
              "email",
              "phone"
            ]
          }
        },
        "source": {
          "type": "object",
          "description": "Where the request originated.",
          "properties": {
            "origin": {
              "type": "string",
              "description": "`api` for requests filed through this API, `app` for requests filed from the Ometria app.",
              "enum": [
                "app",
                "api"
              ]
            },
            "api_request_id": {
              "type": [
                "string",
                "null"
              ],
              "description": "Identifies the `POST /field-forget` call that filed this request. If you sent an `X-Request-ID` header on that call, this is its value, so you can correlate the request with your own logs; otherwise Ometria generates one. `null` for requests filed from the Ometria app."
            }
          }
        },
        "timestamp_created": {
          "type": "string",
          "description": "Date and time of request being filed. Following ISO 8601 dateTime format with timezone offset _YYYY-MM-DDThh:mm:ss+Z_.",
          "format": "date-time"
        },
        "timestamp_completed": {
          "type": [
            "string",
            "null"
          ],
          "description": "Date and time of request reaching a terminal status. Following ISO 8601 dateTime format with timezone offset _YYYY-MM-DDThh:mm:ss+Z_. `null` while the request is `pending` or `in_progress`.",
          "format": "date-time"
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/ometria-field-forget-request-page"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.