---
title: "Get Entity"
url: "https://console.9fin.com/apis/entity-service/versions/31d9cce8-3ddc-42cd-b266-372482fbb0e1/operations/get_entity_v0_entity__nf_id__get"
---

> Full API specification: https://console.9fin.com/apis/entity-service/versions/31d9cce8-3ddc-42cd-b266-372482fbb0e1.md

# Get Entity

`GET` `/v0/entity/{nf_id}`

Operation ID: `get_entity_v0_entity__nf_id__get`

Returns a single Entity. Allows for supplying a single entity nf_id to get data about it.

## Path parameters

- `nf_id` (string, required)

## Responses

- `200` - Successful Response
- `400` - Bad request (e.g. invalid cursor).
- `422` - Request validation failed (e.g. unknown query parameter).
- `500` - Unexpected server error.
- `503` - Service unavailable (e.g. database down).

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: 9fin Entity API
  version: 0.5.0
servers:
  - description: Production environment
    url: https://api.9fin.com
paths:
  /v0/entity/{nf_id}:
    get:
      description: |-
        Returns a single Entity.
        Allows for supplying a single entity nf_id to get data about it.
      operationId: get_entity_v0_entity__nf_id__get
      parameters:
        - in: path
          name: nf_id
          required: true
          schema:
            title: Nf Id
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EntityResponse"
          description: Successful Response
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
          description: Bad request (e.g. invalid cursor).
        "422":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
          description: Request validation failed (e.g. unknown query parameter).
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/InternalServerErrorResponse"
          description: Unexpected server error.
        "503":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
          description: Service unavailable (e.g. database down).
      security:
        - HTTPBearer: []
      summary: Get Entity
      tags:
        - entity
security:
  - HTTPBearer: []
components:
  schemas:
    EntityResponse:
      description: Public-facing subset of an entity.
      properties:
        active_flag:
          anyOf:
            - type: boolean
            - type: "null"
          title: Active Flag
        alias:
          anyOf:
            - items:
                type: string
              type: array
            - type: "null"
          title: Alias
        cik:
          anyOf:
            - type: integer
            - type: "null"
          title: Cik
        country_ref_name:
          anyOf:
            - type: string
            - type: "null"
          title: Country Ref Name
        coverage_region:
          anyOf:
            - items:
                type: string
              type: array
            - type: "null"
          title: Coverage Region
        created_at:
          format: date-time
          title: Created At
          type: string
        description:
          anyOf:
            - type: string
            - type: "null"
          title: Description
        industry_ref_code:
          anyOf:
            - type: string
            - type: "null"
          title: Industry Ref Code
        modified_at:
          format: date-time
          title: Modified At
          type: string
        nf_id:
          title: Nf Id
          type: string
        roles:
          items:
            type: string
          title: Roles
          type: array
        street_name:
          anyOf:
            - type: string
            - type: "null"
          title: Street Name
        website:
          anyOf:
            - type: string
            - type: "null"
          title: Website
      required:
        - nf_id
        - roles
        - website
        - description
        - street_name
        - country_ref_name
        - industry_ref_code
        - cik
        - active_flag
        - alias
        - coverage_region
        - created_at
        - modified_at
      title: EntityResponse
      type: object
    ErrorResponse:
      description: Client-facing error envelope.
      examples:
        - error_code: invalid_cursor
          message: The supplied cursor could not be decoded.
          trace_id: 202bde256c7d446f9623efdc96286c5d
        - error_code: service_unavailable
          message: Database is not available
          trace_id: c2416d52c6d14c8e831aad792407442c
        - details:
            - field: limit
              message: Input should be less than or equal to 100
          error_code: validation_error
          message: Request validation failed
          trace_id: 5cc0f4dd4a0a4b7fa0b3b0f2b4f9a1c7
      properties:
        details:
          anyOf:
            - items:
                $ref: "#/components/schemas/ErrorDetail"
              type: array
            - type: "null"
          title: Details
        error_code:
          title: Error Code
          type: string
        message:
          title: Message
          type: string
        trace_id:
          anyOf:
            - type: string
            - type: "null"
          title: Trace Id
      required:
        - error_code
        - message
      title: ErrorResponse
      type: object
    InternalServerErrorResponse:
      properties:
        error_code:
          examples:
            - internal_server_error
          title: Error Code
          type: string
        message:
          examples:
            - An unexpected error occurred.
          title: Message
          type: string
        trace_id:
          anyOf:
            - type: string
            - type: "null"
          examples:
            - e7dfd20231374d308f04655eb0538be4
          title: Trace Id
      required:
        - error_code
        - message
        - trace_id
      title: InternalServerErrorResponse
      type: object
    ErrorDetail:
      description: One field-level problem within an error response.
      properties:
        field:
          examples:
            - limit
          title: Field
          type: string
        message:
          examples:
            - Input should be less than or equal to 100
          title: Message
          type: string
      required:
        - field
        - message
      title: ErrorDetail
      type: object
  securitySchemes:
    HTTPBearer:
      bearerFormat: JWT
      scheme: bearer
      type: http
```