Get canonical entity metadata

GET /v1/entities/{id}

Returns the canonical entity envelope for an ent_{n} or numeric id, following merge redirects. For organization and product entities, callers with Recommendations API access (a Pro+ plan) also receive a recommendations_summary commercial-intelligence rollup when a brand profile exists.

Parameters

Name	Location	Description
id (required)	path	Entity id, ent_{n} or the numeric id. Merged ids follow their redirect.

Responses

200 Success

{
  "description": "Success",
  "headers": {
    "X-Request-Id": {
      "$ref": "#/components/headers/X-Request-Id"
    },
    "X-Arcmira-Version": {
      "$ref": "#/components/headers/X-Arcmira-Version"
    },
    "RateLimit-Limit": {
      "$ref": "#/components/headers/RateLimit-Limit"
    },
    "RateLimit-Remaining": {
      "$ref": "#/components/headers/RateLimit-Remaining"
    },
    "RateLimit-Reset": {
      "$ref": "#/components/headers/RateLimit-Reset"
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/EntityDetailResponse"
      }
    }
  }
}

400 InvalidRequest

{
  "$ref": "#/components/responses/InvalidRequest"
}

401 AuthenticationError

{
  "$ref": "#/components/responses/AuthenticationError"
}

402 QuotaExceeded

{
  "$ref": "#/components/responses/QuotaExceeded"
}

403 PermissionError

{
  "$ref": "#/components/responses/PermissionError"
}

404 NotFound

{
  "$ref": "#/components/responses/NotFound"
}

429 RateLimited

{
  "$ref": "#/components/responses/RateLimited"
}

500 ServerError

{
  "$ref": "#/components/responses/ServerError"
}

Operation definition

{
  "tags": [
    "Entities"
  ],
  "operationId": "get_entity",
  "summary": "Get canonical entity metadata",
  "description": "Returns the canonical entity envelope for an ent_{n} or numeric id, following merge redirects. For organization and product entities, callers with Recommendations API access (a Pro+ plan) also receive a recommendations_summary commercial-intelligence rollup when a brand profile exists.",
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "parameters": [
    {
      "schema": {
        "type": "string",
        "description": "Entity id, ent_{n} or the numeric id. Merged ids follow their redirect."
      },
      "required": true,
      "description": "Entity id, ent_{n} or the numeric id. Merged ids follow their redirect.",
      "name": "id",
      "in": "path"
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "headers": {
        "X-Request-Id": {
          "$ref": "#/components/headers/X-Request-Id"
        },
        "X-Arcmira-Version": {
          "$ref": "#/components/headers/X-Arcmira-Version"
        },
        "RateLimit-Limit": {
          "$ref": "#/components/headers/RateLimit-Limit"
        },
        "RateLimit-Remaining": {
          "$ref": "#/components/headers/RateLimit-Remaining"
        },
        "RateLimit-Reset": {
          "$ref": "#/components/headers/RateLimit-Reset"
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/EntityDetailResponse"
          }
        }
      }
    },
    "400": {
      "$ref": "#/components/responses/InvalidRequest"
    },
    "401": {
      "$ref": "#/components/responses/AuthenticationError"
    },
    "402": {
      "$ref": "#/components/responses/QuotaExceeded"
    },
    "403": {
      "$ref": "#/components/responses/PermissionError"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    },
    "429": {
      "$ref": "#/components/responses/RateLimited"
    },
    "500": {
      "$ref": "#/components/responses/ServerError"
    }
  }
}