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

# Search Jointl

> Quickly search the connected workspace across authorized people, emails, attributes, companies, tags, job titles, and Flows using the same permissions and relevance ranking as the Jointl UI. An optional source-type filter is applied before ranking. Returns at most 30 top matches and is not an exhaustive list.

Use when: Use for quick entity lookup from a name, email, attribute, company, tag, job title, or Flow phrase; optionally restrict source types before ranking, and use a domain list or analytics operation for complete cohorts. Returns: ranked matches in `sourceRecords`, suggested next operations in `followUpOperations`, result counts, the applied limit, and `exhaustive: false`.



## OpenAPI

````yaml /specs/openapi/jointl-api-v1.openapi.yaml post /api/v1/operations/workspace.search
openapi: 3.1.2
info:
  title: Jointl REST API and OAuth
  version: 1.0.0
  summary: Supported public HTTP contract for Jointl third-party connections.
  description: >-
    HTTP contract for Jointl REST operations, OAuth, and Zapier subscription and
    action endpoints. Jointl does not provide a public sandbox.
  termsOfService: https://join.tl/legal/terms-of-service
  contact:
    name: Jointl Support
    url: https://join.tl
servers:
  - url: https://api.join.tl
    description: Jointl production API
security: []
tags:
  - name: OAuth
    description: OAuth 2.0 and OpenID Connect endpoints.
  - name: Discovery
    description: OAuth resource and issuer discovery.
  - name: Operations
    description: Permission-filtered read operations.
  - name: Actions
    description: Prepare, human approval, and confirmation.
  - name: Zapier
    description: Endpoints restricted to the approved Jointl Zapier app.
paths:
  /api/v1/operations/workspace.search:
    post:
      tags:
        - Operations
      summary: Search Jointl
      description: >-
        Quickly search the connected workspace across authorized people, emails,
        attributes, companies, tags, job titles, and Flows using the same
        permissions and relevance ranking as the Jointl UI. An optional
        source-type filter is applied before ranking. Returns at most 30 top
        matches and is not an exhaustive list.


        Use when: Use for quick entity lookup from a name, email, attribute,
        company, tag, job title, or Flow phrase; optionally restrict source
        types before ranking, and use a domain list or analytics operation for
        complete cohorts. Returns: ranked matches in `sourceRecords`, suggested
        next operations in `followUpOperations`, result counts, the applied
        limit, and `exhaustive: false`.
      operationId: executeWorkspaceSearch
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkspaceSearchInput'
            example:
              query: Ada Example
      responses:
        '200':
          description: Operation completed.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/WorkspaceSearchResult'
                  requestId:
                    type: string
                    description: Request correlation identifier.
                required:
                  - data
                  - requestId
                additionalProperties: false
              example:
                data:
                  exhaustive: false
                  items:
                    - entityId: applicant_example_01
                      entityType: applicant
                      followUpOperations:
                        - input:
                            applicantId: applicant_example_01
                            includeEvidence: true
                          operationId: checks.get
                      label: Ada Example
                      sourceRecords:
                        - applicantId: applicant_example_01
                          companyName: Example Company
                          entityId: applicant_example_01
                          entityType: applicant
                          label: Applicant
                          primary: Software Engineer
                          route: /checks/applicant_example_01
                          statusLabels:
                            - className: new
                              label: New
                              value: new
                  query: Ada Example
                  resultLimit: 30
                  returnedCount: 1
                requestId: request_example_01
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '413':
          $ref: '#/components/responses/TooLarge'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
        '503':
          $ref: '#/components/responses/Unavailable'
      security:
        - JointlOAuth:
            - workspace.read
        - JointlApiKey: []
components:
  schemas:
    WorkspaceSearchInput:
      additionalProperties: false
      properties:
        entityTypes:
          description: >-
            Optional source-type filter applied before ranking. Omit it to
            search every global-search type.
          items:
            enum:
              - applicant
              - employee
              - talent
              - reference
              - flow
              - member
            type: string
          maxItems: 6
          minItems: 1
          type: array
        limit:
          default: 30
          maximum: 30
          minimum: 1
          type: integer
        query:
          description: >-
            Search people, emails, attributes, companies, tags, job titles, and
            Flows.
          maxLength: 120
          minLength: 2
          type: string
      required:
        - query
      type: object
    WorkspaceSearchResult:
      additionalProperties: true
      properties:
        exhaustive:
          type: boolean
        items:
          items:
            additionalProperties: true
            properties:
              entityId:
                type:
                  - string
                  - 'null'
              entityType:
                type: string
              followUpOperations:
                items:
                  additionalProperties: true
                  properties:
                    input:
                      additionalProperties: true
                      type: object
                    operationId:
                      type: string
                  required:
                    - operationId
                    - input
                  type: object
                type: array
              label:
                type: string
              sourceRecords:
                items:
                  additionalProperties: true
                  properties:
                    applicantId:
                      type:
                        - string
                        - 'null'
                    companyName:
                      type:
                        - string
                        - 'null'
                    entityId:
                      type: string
                    entityType:
                      type: string
                    label:
                      type: string
                    primary:
                      type:
                        - string
                        - 'null'
                    route:
                      type:
                        - string
                        - 'null'
                    statusLabels:
                      type: array
                      items:
                        additionalProperties: true
                        type: object
                  required:
                    - entityType
                    - entityId
                  type: object
                type: array
            type: object
          type: array
        query:
          type: string
        resultLimit:
          type: number
        returnedCount:
          type: number
      required:
        - query
        - items
        - returnedCount
        - resultLimit
        - exhaustive
      type: object
    ErrorEnvelope:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
          additionalProperties: false
        requestId:
          type: string
      required:
        - error
        - requestId
      additionalProperties: false
  headers:
    RequestId:
      description: Request correlation identifier.
      schema:
        type: string
    RetryAfter:
      description: Seconds before retrying.
      schema:
        type: integer
        minimum: 1
  responses:
    BadRequest:
      description: Invalid request.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error:
              code: invalid-external-operation-input
              message: The operation input is invalid.
            requestId: request_example_400
    Unauthorized:
      description: Authentication required.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error:
              code: not-authenticated
              message: Authentication is required.
            requestId: request_example_401
    Forbidden:
      description: Insufficient scope or permission.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error:
              code: not-authorized
              message: You are not allowed to perform this action.
            requestId: request_example_403
    NotFound:
      description: The operation or visible record was not found.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error:
              code: not-found
              message: The requested record was not found.
            requestId: request_example_404
    Conflict:
      description: State, replay, or idempotency conflict.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error:
              code: external-action-conflict
              message: The action conflicts with current state.
            requestId: request_example_409
    TooLarge:
      description: Request exceeds one MiB.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error:
              code: request-too-large
              message: The request body is too large.
            requestId: request_example_413
    RateLimited:
      description: Rate limit exceeded.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error:
              code: too-many-requests
              message: Too many requests.
            requestId: request_example_429
    ServerError:
      description: Server error.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error:
              code: internal-error
              message: The request could not be completed.
            requestId: request_example_500
    Unavailable:
      description: Temporarily unavailable or action outcome unknown.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error:
              code: temporarily-unavailable
              message: The service is temporarily unavailable.
            requestId: request_example_503
  securitySchemes:
    JointlOAuth:
      type: oauth2
      description: OAuth access token issued for the REST resource.
      flows:
        authorizationCode:
          authorizationUrl: https://api.join.tl/oauth/authorize
          tokenUrl: https://api.join.tl/oauth/token
          refreshUrl: https://api.join.tl/oauth/token
          scopes:
            openid: Authenticate the Jointl member.
            email: Read the authorized member email claim.
            workspace.read: Read authorized Jointl workspace data.
            workspace.write: Prepare and confirm authorized Jointl changes.
            offline_access: Receive a rotating refresh token.
      x-jointl-resource: https://api.join.tl/api/v1
      x-jointl-pkce-required: S256
    JointlApiKey:
      type: http
      scheme: bearer
      bearerFormat: Jointl personal or service-account API key
      description: >-
        Server-side personal or service credential. Never embed in browser or
        hosted AI clients.

````