---
updatedAt: 2026-08-14T00:08:12.000Z
---

# List ID Mapping Status records

Retrieve a paginated list of ID Mapping Status records from the Identity Network. Supports pagination, sorting, filtering, platform selection, searching, and showing only latest entries.

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Identity Network Resources",
    "version": "2.0.0",
    "description": "Buzz API v2"
  },
  "paths": {
    "/id-mapping/status": {
      "get": {
        "operationId": "id_mapping_status_retrieve",
        "description": "Retrieve a paginated list of ID Mapping Status records from the Identity Network. Supports pagination, sorting, filtering, platform selection, searching, and showing only latest entries.",
        "summary": "List ID Mapping Status records",
        "parameters": [
          {
            "in": "query",
            "name": "filter",
            "schema": {
              "type": "string"
            },
            "description": "Filter parameters based on FilterSchema format."
          },
          {
            "in": "query",
            "name": "pagination",
            "schema": {
              "type": "object",
              "additionalProperties": {}
            },
            "description": "Pagination options: { page: number, per_page: number }"
          },
          {
            "in": "query",
            "name": "platform",
            "schema": {
              "type": "string"
            },
            "description": "Platform identifier used for filtering data."
          },
          {
            "in": "query",
            "name": "search",
            "schema": {
              "type": "string"
            },
            "description": "Free-text search, following SearchSchema rules."
          },
          {
            "in": "query",
            "name": "showLatest",
            "schema": {
              "type": "boolean"
            },
            "description": "If true, returns only the most recent status entry per ID."
          },
          {
            "in": "query",
            "name": "sort",
            "schema": {
              "type": "string"
            },
            "description": "Sorting parameters based on SortSchema format."
          }
        ],
        "tags": [
          "Identity Network"
        ],
        "security": [
          {
            "nestSessionAuth": []
          },
          {
            "nestBasicAuth": []
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "id_mapping_status",
                    "page",
                    "per_page",
                    "total",
                    "total_pages"
                  ],
                  "properties": {
                    "id_mapping_status": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id_display_name": {
                            "type": "string"
                          },
                          "status_array": {
                            "type": "string"
                          },
                          "failed_message": {
                            "type": "string"
                          },
                          "total_records": {
                            "type": "integer"
                          },
                          "total_match_rate": {
                            "type": "number"
                          },
                          "received_at": {
                            "type": "string",
                            "format": "date-time"
                          },
                          "status_updated_time": {
                            "type": "string",
                            "format": "date-time"
                          },
                          "is_optout": {
                            "type": "boolean"
                          }
                        }
                      }
                    },
                    "page": {
                      "type": "integer"
                    },
                    "per_page": {
                      "type": "integer"
                    },
                    "total": {
                      "type": "integer"
                    },
                    "total_pages": {
                      "type": "integer"
                    }
                  }
                }
              }
            },
            "description": "List of Id Mapping Status records."
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "nestBasicAuth": {
        "type": "http",
        "scheme": "basic",
        "description": "Form-based Basic Authentication"
      },
      "nestSessionAuth": {
        "type": "http",
        "scheme": "basic",
        "description": "Form-based Basic Authentication"
      }
    }
  },
  "x-explorer-enabled": false,
  "x-samples-languages": [
    "curl",
    "node",
    "ruby",
    "javascript",
    "python",
    "php",
    "java"
  ],
  "servers": [
    {
      "url": "https://{buzz_key}.api.beeswax.com/rest/v2",
      "variables": {
        "buzz_key": {
          "default": "stingersbx",
          "description": "Unique customer ID assigned by the Beeswax"
        }
      }
    }
  ]
}
```