---
title: "Retrieve a catalog entry"
url: "https://real-estate-agency.apim.eu/apis/agent-catalog/versions/fa44b0ce-8be5-4345-b3ca-97adeccf8c16/operations/getCatalogEntry"
---

> Full API specification: https://real-estate-agency.apim.eu/apis/agent-catalog/versions/fa44b0ce-8be5-4345-b3ca-97adeccf8c16.md

# Retrieve a catalog entry

`GET` `/catalog-entries/{entryId}`

Operation ID: `getCatalogEntry`

Returns status, metadata and the compliance-disclosure report.

## Path parameters

- `entryId` (string, required) - Identifier of the catalog entry.

## Responses

- `200` - Catalog entry
- `401` - Key is missing, revoked or invalid
- `404` - The catalog entry doesn't exist

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Agent Catalog
  version: 1.0.0
servers:
  - url: https://api.nexora.example/v1
    description: Production
  - url: https://sandbox.api.nexora.example/v1
    description: Sandbox
paths:
  /catalog-entries/{entryId}:
    parameters:
      - $ref: "#/components/parameters/CatalogEntryId"
    get:
      tags:
        - Catalog Entries
      summary: Retrieve a catalog entry
      description: Returns status, metadata and the compliance-disclosure report.
      operationId: getCatalogEntry
      responses:
        "200":
          description: Catalog entry
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CatalogEntry"
        "401":
          $ref: "#/components/responses/NotAuthenticated"
        "404":
          $ref: "#/components/responses/NotFound"
security:
  - apiKey: []
components:
  parameters:
    CatalogEntryId:
      name: entryId
      in: path
      required: true
      description: Identifier of the catalog entry.
      schema:
        type: string
        example: entry_4d9b2e
  schemas:
    CatalogEntry:
      type: object
      properties:
        id:
          type: string
          example: entry_4d9b2e
        agent_id:
          type: string
          example: agt_8f2c1a
        template_id:
          type: string
          example: tpl_standard
        target_team:
          $ref: "#/components/schemas/TargetTeam"
        status:
          $ref: "#/components/schemas/CatalogEntryStatus"
        record_url:
          type: string
          format: uri
          description: "Only set once `status: completed`. The link is valid for 24 hours."
          example: https://api.nexora.example/v1/catalog-entries/entry_4d9b2e/record
        pages:
          type: integer
          description: Page count of the generated record.
          example: 4
        disclosures:
          $ref: "#/components/schemas/DisclosureReport"
        created_at:
          type: string
          format: date-time
          example: 2026-08-20T09:41:12Z
        completed_at:
          type: string
          format: date-time
          nullable: true
          example: 2026-08-20T09:41:20Z
    TargetTeam:
      type: string
      description: Audience the entry is written for.
      enum:
        - engineering
        - product
        - support
        - sales-ops
        - compliance-legal
        - open
      default: open
    CatalogEntryStatus:
      type: string
      description: Lifecycle of a catalog entry.
      enum:
        - in_progress
        - completed
        - published
        - withdrawn
        - failed
      example: completed
    DisclosureReport:
      type: object
      description: Result of the compliance-disclosure check.
      properties:
        complete:
          type: boolean
          example: false
        missing:
          type: array
          items:
            $ref: "#/components/schemas/ErrorDetail"
    Error:
      type: object
      description: Uniform error format across all Nexora AI APIs.
      required:
        - code
        - message
      properties:
        code:
          type: string
          example: compliance_disclosure_missing
        message:
          type: string
          example: Compliance disclosures from the certification are missing for
            publication.
        details:
          type: array
          items:
            $ref: "#/components/schemas/ErrorDetail"
    ErrorDetail:
      type: object
      properties:
        field:
          type: string
          example: compliance_certification.valid_until
        reason:
          type: string
          example: missing
  responses:
    NotAuthenticated:
      description: Key is missing, revoked or invalid
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Error"
          example:
            code: not_authenticated
            message: The API key is invalid or has been revoked.
            details: []
    NotFound:
      description: The catalog entry doesn't exist
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Error"
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: apikey
      description: |
        Every call carries an API key in the `apikey` header. You generate the
        key in the Nexora AI portal under "My Apps"; it's shown exactly once.

        Each key has the scopes it's allowed to use attached to it. If one is
        missing, the API responds with `403` and `code: "scope_missing"`; the
        missing scope is in `details[].field`.
```