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

# Search Contacts

> Search for contacts by name, email, phone number, or other attributes.



## OpenAPI

````yaml GET /v1/contacts/search
openapi: 3.0.0
info:
  title: Conduit API
  version: 1.0.0
  description: Public API for Conduit.
servers:
  - url: https://api.conduit.ai
    description: Production
security: []
tags:
  - name: meta
    description: Discovery and API metadata endpoints.
  - name: agents
    description: >-
      V2 chat agent configuration, including instructions, skills, triggers, and
      automation behavior.
  - name: contacts
    description: >-
      Contact profile and contact-scoped related resources such as tickets and
      calls.
  - name: workspaces
    description: Workspaces accessible to the current API token.
  - name: escalations
    description: >-
      Chat escalations that require operator review, including message, proposed
      response, and disposition context when available.
  - name: conversations
    description: >-
      Canonical message threads. Use these endpoints to list threads, inspect
      conversation state, read transcripts, and send replies.
  - name: conversation-tags
    description: >-
      Conversation labels, root topics, and subtopics used for classification
      and topic analytics.
  - name: tickets
    description: >-
      Operational queue items tied to conversations, including ticket-scoped
      transcripts and replies.
  - name: calls
    description: Phone call records, transcripts, summaries, and recordings when available.
  - name: reservations
    description: >-
      PMS reservations synced from the workspace's integrations (Hostaway,
      Guesty, Airbnb, etc.), including guest identity, payment status, and stay
      dates.
  - name: appointments
    description: >-
      Scheduled appointments (bookings) backed by the Conduit booking service.
      Exposes allocation context and the upstream booking-service `external_id`.
  - name: helpdesk_tickets
    description: >-
      Helpdesk tickets mirrored from external helpdesk integrations (Zendesk,
      Pylon, Plain), including requester identity and upstream metadata.
  - name: kb
    description: >-
      Knowledge base search and node management. Nodes represent knowledge base
      entries (files or directories), chunks are the indexed retrieval units
      used by search.
  - name: skills
    description: >-
      Workspace agent skills that can be attached to V2 chat agents.
      Sidebar/global-assistant skills are intentionally excluded.
  - name: custom_tools
    description: >-
      Custom code tools: user-authored Python/JavaScript functions executed in a
      sandbox when an agent calls them. Includes a runtimes endpoint describing
      the entrypoint signature, return shape, and available dependencies per
      language.
  - name: inbox_types
    description: >-
      Workspace inbox types. Each id is stable and usable as a message trigger's
      `inboxTypeId` and as the `inbox_type_id` filter on list conversations.
paths:
  /v1/contacts/search:
    get:
      tags:
        - contacts
      summary: Search contacts
      description: >-
        Find contacts by name, last name, email, phone number, WhatsApp number,
        or channel value. Use the returned contact ids with related endpoints
        like `/v1/contacts/{id}/tickets` and `/v1/contacts/{id}/calls`.
      operationId: searchContacts
      parameters:
        - schema:
            type: string
            description: Workspace to query.
            example: j57demo8f8x7c9v0n2q4r6t8y1u3i5o
          required: true
          name: workspace_id
          in: query
        - schema:
            type: string
            description: >-
              Search value. Common lookups include email address, phone number,
              first name, and last name.
            example: joe@gmail.com
          required: true
          name: query
          in: query
        - schema:
            type: string
            enum:
              - any
              - name
              - first_name
              - last_name
              - email
              - phone
              - whatsapp
              - channel
            description: >-
              Field to search. `any` uses heuristics: email-like input searches
              channels, phone-like input searches phone channels, otherwise it
              searches contact metadata.
            example: email
          required: false
          name: field
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 100
          required: false
          name: limit
          in: query
        - schema:
            type: string
          required: false
          name: cursor
          in: query
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
          required: false
          name: archived
          in: query
        - schema:
            type: string
          required: false
          name: inbox_type_id
          in: query
      responses:
        '200':
          description: Contact search results
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        workspace_id:
                          type: string
                        first_name:
                          type: string
                        last_name:
                          type: string
                          nullable: true
                        image_url:
                          type: string
                          nullable: true
                        type:
                          type: string
                          nullable: true
                        inbox_type_id:
                          type: string
                        archived:
                          type: boolean
                        ai_paused:
                          type: boolean
                        last_channel:
                          type: string
                          nullable: true
                        last_message_at:
                          type: string
                          nullable: true
                        last_message_preview:
                          type: string
                          nullable: true
                        created_at:
                          type: string
                        updated_at:
                          type: string
                      required:
                        - id
                        - workspace_id
                        - first_name
                        - last_name
                        - image_url
                        - type
                        - inbox_type_id
                        - archived
                        - ai_paused
                        - last_channel
                        - last_message_at
                        - last_message_preview
                        - created_at
                        - updated_at
                  next_cursor:
                    type: string
                    nullable: true
                  has_more:
                    type: boolean
                required:
                  - data
                  - next_cursor
                  - has_more
                description: Cursor-paginated contacts response.
                example:
                  data:
                    - id: ph77c0dy0mgdpzmqz6tesry8w184002s
                      workspace_id: j57demo8f8x7c9v0n2q4r6t8y1u3i5o
                      first_name: Jane
                      last_name: Doe
                      image_url: null
                      type: null
                      inbox_type_id: guest
                      archived: false
                      ai_paused: false
                      last_channel: unthreaded_email
                      last_message_at: '2026-04-03T03:14:15.000Z'
                      last_message_preview: Can I check in early?
                      created_at: '2026-04-01T17:22:10.000Z'
                      updated_at: '2026-04-03T03:14:15.000Z'
                  next_cursor: page-token
                  has_more: true
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Token
      description: >-
        Conduit API token. Use `Authorization: Bearer <token>`. Read/write
        endpoints require a token with write access.

````