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

# Search companies and people

> Search active companies and people in one workspace.



## OpenAPI

````yaml /openapi/public-v1.json get /api/v1/workspaces/{workspaceSlug}/relationships/search
openapi: 3.1.0
info:
  description: Stable external API for relationship lookup and meeting intelligence.
  title: Floral Public API
  version: 1.0.0
servers:
  - description: Production
    url: https://app.floral.so
security: []
tags:
  - description: Search across active companies and people.
    name: Search
  - description: Create, list, inspect, update, archive, and restore companies.
    name: Companies
  - description: Create, list, inspect, update, archive, and restore people.
    name: People
  - description: Read active public custom-field definitions.
    name: Custom fields
  - description: Search normalized Danish company-register facts.
    name: Company registry
  - description: Generate, list, and inspect meeting briefings.
    name: Briefings
  - description: List, inspect, annotate, and approve meeting summaries.
    name: Summaries
paths:
  /api/v1/workspaces/{workspaceSlug}/relationships/search:
    get:
      tags:
        - Search
      summary: Search companies and people
      description: Search active companies and people in one workspace.
      operationId: searchRelationshipsV1
      parameters:
        - description: Slug of the workspace pinned to the credential.
          example: acme-nordic
          in: path
          name: workspaceSlug
          required: true
          schema:
            maxLength: 100
            minLength: 1
            pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
            type: string
        - in: query
          description: Case-insensitive company or person search text.
          example: Acme
          name: q
          required: true
          schema:
            type: string
            minLength: 3
            maxLength: 200
        - in: query
          description: Maximum combined matches to return.
          example: 8
          name: limit
          required: false
          schema:
            default: 8
            type: integer
            maximum: 20
            minimum: 1
        - description: >-
            Optional caller-generated correlation ID. Floral returns the
            effective value in X-Request-ID.
          example: 550e8400-e29b-41d4-a716-446655440000
          in: header
          name: X-Request-ID
          required: false
          schema:
            maxLength: 128
            minLength: 1
            type: string
      responses:
        '200':
          content:
            application/json:
              example:
                companies:
                  - email: hello@acme-nordic.example
                    id: 42
                    industry: Design
                    lifecycleStage: PROSPECT
                    name: Acme Nordic
                    organizationNumber: '12345678'
                    phone: +45 33 12 34 56
                    type: company
                people:
                  - companyId: 42
                    companyName: Acme Nordic
                    email: ada@acme-nordic.example
                    id: 84
                    lifecycleStage: PROSPECT
                    mobile: +45 20 11 22 33
                    name: Ada Jensen
                    phone: +45 33 12 34 56
                    title: Operations director
                    type: person
              schema:
                $ref: '#/components/schemas/RelationshipSearchResponse'
          description: Successful response
          headers:
            X-Content-Type-Options:
              description: Always nosniff for JSON API responses.
              schema:
                const: nosniff
                type: string
            X-RateLimit-Limit:
              description: Maximum requests in the current rate-limit window.
              schema:
                minimum: 1
                type: integer
            X-RateLimit-Remaining:
              description: Requests remaining in the current rate-limit window.
              schema:
                minimum: 0
                type: integer
            X-Request-ID:
              description: Stable request or idempotent replay correlation ID.
              schema:
                minLength: 1
                type: string
        '400':
          content:
            application/json:
              example:
                error:
                  code: INVALID_INPUT
                  message: The request contains invalid values.
                  requestId: 550e8400-e29b-41d4-a716-446655440000
              schema:
                allOf:
                  - $ref: '#/components/schemas/ApiErrorResponse'
                properties:
                  error:
                    properties:
                      code:
                        enum:
                          - INVALID_INPUT
                        type: string
                    required:
                      - code
                    type: object
                type: object
          description: 'Stable errors: INVALID_INPUT'
          headers:
            X-Content-Type-Options:
              description: Always nosniff for JSON API responses.
              schema:
                const: nosniff
                type: string
            X-RateLimit-Limit:
              description: Maximum requests in the current rate-limit window.
              schema:
                minimum: 1
                type: integer
            X-RateLimit-Remaining:
              description: Requests remaining in the current rate-limit window.
              schema:
                minimum: 0
                type: integer
            X-Request-ID:
              description: Stable request or idempotent replay correlation ID.
              schema:
                minLength: 1
                type: string
        '401':
          content:
            application/json:
              example:
                error:
                  code: UNAUTHENTICATED
                  message: A valid bearer credential is required.
                  requestId: 550e8400-e29b-41d4-a716-446655440000
              schema:
                allOf:
                  - $ref: '#/components/schemas/ApiErrorResponse'
                properties:
                  error:
                    properties:
                      code:
                        enum:
                          - UNAUTHENTICATED
                        type: string
                    required:
                      - code
                    type: object
                type: object
          description: 'Stable errors: UNAUTHENTICATED'
          headers:
            X-Content-Type-Options:
              description: Always nosniff for JSON API responses.
              schema:
                const: nosniff
                type: string
            X-RateLimit-Limit:
              description: Maximum requests in the current rate-limit window.
              schema:
                minimum: 1
                type: integer
            X-RateLimit-Remaining:
              description: Requests remaining in the current rate-limit window.
              schema:
                minimum: 0
                type: integer
            X-Request-ID:
              description: Stable request or idempotent replay correlation ID.
              schema:
                minLength: 1
                type: string
            WWW-Authenticate:
              description: Bearer authentication challenge.
              example: Bearer realm="floral-api"
              schema:
                type: string
        '403':
          content:
            application/json:
              example:
                error:
                  code: FORBIDDEN
                  message: The credential does not grant this operation.
                  requestId: 550e8400-e29b-41d4-a716-446655440000
              schema:
                allOf:
                  - $ref: '#/components/schemas/ApiErrorResponse'
                properties:
                  error:
                    properties:
                      code:
                        enum:
                          - FORBIDDEN
                        type: string
                    required:
                      - code
                    type: object
                type: object
          description: 'Stable errors: FORBIDDEN'
          headers:
            X-Content-Type-Options:
              description: Always nosniff for JSON API responses.
              schema:
                const: nosniff
                type: string
            X-RateLimit-Limit:
              description: Maximum requests in the current rate-limit window.
              schema:
                minimum: 1
                type: integer
            X-RateLimit-Remaining:
              description: Requests remaining in the current rate-limit window.
              schema:
                minimum: 0
                type: integer
            X-Request-ID:
              description: Stable request or idempotent replay correlation ID.
              schema:
                minLength: 1
                type: string
        '404':
          content:
            application/json:
              example:
                error:
                  code: NOT_FOUND
                  message: The resource was not found.
                  requestId: 550e8400-e29b-41d4-a716-446655440000
              schema:
                allOf:
                  - $ref: '#/components/schemas/ApiErrorResponse'
                properties:
                  error:
                    properties:
                      code:
                        enum:
                          - NOT_FOUND
                          - FEATURE_DISABLED
                        type: string
                    required:
                      - code
                    type: object
                type: object
          description: 'Stable errors: NOT_FOUND, FEATURE_DISABLED'
          headers:
            X-Content-Type-Options:
              description: Always nosniff for JSON API responses.
              schema:
                const: nosniff
                type: string
            X-RateLimit-Limit:
              description: Maximum requests in the current rate-limit window.
              schema:
                minimum: 1
                type: integer
            X-RateLimit-Remaining:
              description: Requests remaining in the current rate-limit window.
              schema:
                minimum: 0
                type: integer
            X-Request-ID:
              description: Stable request or idempotent replay correlation ID.
              schema:
                minLength: 1
                type: string
        '429':
          content:
            application/json:
              example:
                error:
                  code: RATE_LIMITED
                  message: Too many requests. Retry shortly.
                  requestId: 550e8400-e29b-41d4-a716-446655440000
              schema:
                allOf:
                  - $ref: '#/components/schemas/ApiErrorResponse'
                properties:
                  error:
                    properties:
                      code:
                        enum:
                          - RATE_LIMITED
                        type: string
                    required:
                      - code
                    type: object
                type: object
          description: 'Stable errors: RATE_LIMITED'
          headers:
            X-Content-Type-Options:
              description: Always nosniff for JSON API responses.
              schema:
                const: nosniff
                type: string
            X-RateLimit-Limit:
              description: Maximum requests in the current rate-limit window.
              schema:
                minimum: 1
                type: integer
            X-RateLimit-Remaining:
              description: Requests remaining in the current rate-limit window.
              schema:
                minimum: 0
                type: integer
            X-Request-ID:
              description: Stable request or idempotent replay correlation ID.
              schema:
                minLength: 1
                type: string
            Retry-After:
              description: Seconds until the current limit resets.
              schema:
                minimum: 1
                type: integer
        '500':
          content:
            application/json:
              example:
                error:
                  code: INTERNAL_ERROR
                  message: An unexpected error occurred.
                  requestId: 550e8400-e29b-41d4-a716-446655440000
              schema:
                allOf:
                  - $ref: '#/components/schemas/ApiErrorResponse'
                properties:
                  error:
                    properties:
                      code:
                        enum:
                          - INTERNAL_ERROR
                        type: string
                    required:
                      - code
                    type: object
                type: object
          description: 'Stable errors: INTERNAL_ERROR'
          headers:
            X-Content-Type-Options:
              description: Always nosniff for JSON API responses.
              schema:
                const: nosniff
                type: string
            X-RateLimit-Limit:
              description: Maximum requests in the current rate-limit window.
              schema:
                minimum: 1
                type: integer
            X-RateLimit-Remaining:
              description: Requests remaining in the current rate-limit window.
              schema:
                minimum: 0
                type: integer
            X-Request-ID:
              description: Stable request or idempotent replay correlation ID.
              schema:
                minLength: 1
                type: string
      security:
        - bearerAuth: []
      x-codeSamples:
        - label: cURL
          lang: Shell
          source: |-
            curl --request GET \
              --url 'https://app.floral.so/api/v1/workspaces/acme-nordic/relationships/search?limit=8&q=Acme' \
              --header 'Authorization: Bearer $FLORAL_TOKEN'
components:
  schemas:
    RelationshipSearchResponse:
      $schema: https://json-schema.org/draft/2020-12/schema
      type: object
      properties:
        companies:
          maxItems: 20
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                const: company
              id:
                type: integer
                exclusiveMinimum: 0
                maximum: 9007199254740991
              name:
                type: string
              organizationNumber:
                type: string
              email:
                anyOf:
                  - type: string
                  - type: 'null'
              phone:
                anyOf:
                  - type: string
                  - type: 'null'
              industry:
                anyOf:
                  - type: string
                  - type: 'null'
              lifecycleStage:
                anyOf:
                  - type: string
                    enum:
                      - LEAD
                      - PROSPECT
                      - CUSTOMER
                      - CHURNED
                  - type: 'null'
            required:
              - type
              - id
              - name
              - organizationNumber
              - email
              - phone
              - industry
              - lifecycleStage
            additionalProperties: false
        people:
          maxItems: 20
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                const: person
              id:
                type: integer
                exclusiveMinimum: 0
                maximum: 9007199254740991
              name:
                type: string
              email:
                type: string
              phone:
                anyOf:
                  - type: string
                  - type: 'null'
              mobile:
                anyOf:
                  - type: string
                  - type: 'null'
              title:
                anyOf:
                  - type: string
                  - type: 'null'
              companyId:
                anyOf:
                  - type: integer
                    exclusiveMinimum: 0
                    maximum: 9007199254740991
                  - type: 'null'
              companyName:
                anyOf:
                  - type: string
                  - type: 'null'
              lifecycleStage:
                anyOf:
                  - type: string
                    enum:
                      - LEAD
                      - PROSPECT
                      - CUSTOMER
                      - CHURNED
                  - type: 'null'
            required:
              - type
              - id
              - name
              - email
              - phone
              - mobile
              - title
              - companyId
              - companyName
              - lifecycleStage
            additionalProperties: false
      required:
        - companies
        - people
      additionalProperties: false
    ApiErrorResponse:
      additionalProperties: false
      properties:
        error:
          additionalProperties: false
          properties:
            code:
              enum:
                - CONFLICT
                - FEATURE_DISABLED
                - FORBIDDEN
                - IDEMPOTENCY_CONFLICT
                - INTERNAL_ERROR
                - INVALID_INPUT
                - INVALID_STATE
                - NOT_FOUND
                - PRECONDITION_REQUIRED
                - RATE_LIMITED
                - UNAUTHENTICATED
                - VERSION_CONFLICT
              type: string
            message:
              minLength: 1
              type: string
            requestId:
              maxLength: 128
              minLength: 1
              type: string
          required:
            - code
            - message
            - requestId
          type: object
      required:
        - error
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: Floral PAT
      description: Authenticate with a workspace-pinned Floral personal access token.
      scheme: bearer
      type: http

````