> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flowengineering.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Search live entities in a project and branch

> Search names and supported field values, or resolve exact Flow and Human IDs. Returns compact matches; use the entity-by-ID endpoint for full values and links. Matches reflect branch-visible state and exclude deleted entities. Indexed text results may be unavailable while the search index warms; exact IDs and empty-query listings remain available. Semantic suggestions, when enabled, follow ordinary matches within the total result limit.



## OpenAPI

````yaml /openapi/customer-api.json get /project/{projectId}/entities/search
openapi: 3.0.0
info:
  contact: {}
  description: >-
    Flow customer API reference. Start with the [quickstart](/api/quickstart)
    and [authentication guide](/api/authentication).
  title: Customer API
  version: 1.0.0
servers:
  - description: Flow API
    url: '{baseUrl}'
    variables:
      baseUrl:
        default: https://backend.branch.flowengineering.com
security: []
tags:
  - name: Automations
  - name: Branches
  - name: Comments
  - name: Convert
  - name: Data Model
  - name: Diagrams
  - name: Entities
  - name: Files
  - name: Import
  - name: Notifications
  - name: Projects
  - name: ReqIF
  - name: ReqIF Import
  - name: Shared Access Grants
  - name: User Groups
  - name: Users
paths:
  /project/{projectId}/entities/search:
    get:
      tags:
        - Entities
      summary: Search live entities in a project and branch
      description: >-
        Search names and supported field values, or resolve exact Flow and Human
        IDs. Returns compact matches; use the entity-by-ID endpoint for full
        values and links. Matches reflect branch-visible state and exclude
        deleted entities. Indexed text results may be unavailable while the
        search index warms; exact IDs and empty-query listings remain available.
        Semantic suggestions, when enabled, follow ordinary matches within the
        total result limit.
      operationId: EntitiesController_searchEntities
      parameters:
        - in: path
          name: projectId
          required: true
          schema:
            type: string
        - description: >-
            Search text or an exact Flow/Human ID. An empty string lists live
            entities. Text searches require an indexable trigram; exact
            identifiers still resolve for shorter queries.
          in: query
          name: query
          required: true
          schema:
            maxLength: 1024
            type: string
        - description: Branch to search. Omit or pass "master" for Base.
          in: query
          name: branch_id
          required: false
          schema:
            maxLength: 256
            type: string
        - description: Restrict matches to this entity category ID.
          in: query
          name: entity_type
          required: false
          schema:
            maxLength: 256
            type: string
        - description: >-
            Maximum total results, including semantic suggestions when enabled.
            Exact identifiers and field matches precede semantic suggestions.
            This is a bounded search, not a paginated export.
          in: query
          name: limit
          required: false
          schema:
            default: 50
            maximum: 100
            minimum: 1
            type: number
        - description: Workspace identifier
          in: header
          name: customer
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/SearchResultDto'
                type: array
          description: ''
          headers:
            X-Flow-Name-Search-Source:
              description: Search-index serving outcome for this request.
              schema:
                type: string
            X-Flow-Semantic-Search:
              description: Semantic search outcome; off when not attempted.
              schema:
                type: string
      security:
        - api-key: []
        - bearer: []
components:
  schemas:
    SearchResultDto:
      properties:
        entity_id:
          type: string
        entity_type:
          type: string
        human_id:
          nullable: true
          type: string
        legacy_human_id:
          nullable: true
          type: string
        match:
          enum:
            - semantic
          type: string
        name:
          type: string
        same_text_count:
          type: number
      required:
        - entity_id
        - name
        - entity_type
        - human_id
        - legacy_human_id
      type: object
  securitySchemes:
    api-key:
      in: header
      name: X-API-Key
      type: apiKey
    bearer:
      bearerFormat: JWT
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.