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

# Search contacts

> Search the subscriber's contacts.

### Business context

Read path backing partner dashboards and reconciliation flows.
Requires the `fmg.contacts.read` scope.


## OpenAPI

````yaml /spec/openapi-merged.yaml get /fmg/contact/contacts
openapi: 3.1.0
info:
  title: FMG Connect API
  version: 1.0.0
  description: |
    Partner-facing API for FMG Connect. Authenticate with OAuth 2.1
    (see the **OAuth Integration Guide**), then call these endpoints with
    a Bearer access token.

    Endpoints annotated by Product carry a **Business context** section and
    an `x-business-context` field.
servers:
  - url: https://connect.fmgsuite.com/v1
    description: Current environment
security: []
tags:
  - name: fmg contact
paths:
  /fmg/contact/contacts:
    get:
      tags:
        - fmg contact
      summary: Search contacts
      description: |
        Search the subscriber's contacts.

        ### Business context

        Read path backing partner dashboards and reconciliation flows.
        Requires the `fmg.contacts.read` scope.
      parameters:
        - schema:
            type: integer
            minimum: 1
            default: 1
          required: false
          name: page
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
          required: false
          name: pageSize
          in: query
        - schema:
            type: string
            enum:
              - fullName
              - email
              - emailStatus
              - groupCount
              - source
              - dateTimeCreated
          required: false
          name: sortBy
          in: query
        - schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
          required: false
          name: sortDirection
          in: query
        - schema:
            type: string
          required: false
          name: keyword
          in: query
        - schema:
            type: string
          required: false
          name: name
          in: query
        - schema:
            type: string
          required: false
          name: emailExact
          in: query
        - schema:
            type: string
          required: false
          name: phoneExact
          in: query
        - schema:
            type: integer
            exclusiveMinimum: 0
          required: false
          name: groupId
          in: query
        - schema:
            type: integer
            exclusiveMinimum: 0
          required: false
          name: excludedGroupId
          in: query
        - schema:
            type: boolean
          required: false
          name: excludeCrmLinkedContacts
          in: query
        - schema:
            type: array
            items:
              type: integer
              exclusiveMinimum: 0
          required: false
          name: contactIds
          in: query
      responses:
        '200':
          description: Paginated contacts.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactListResponse'
        '400':
          description: 'invalid request or version mismatch. Retryable: false.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: 'unauthorized. Retryable: false.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: 'forbidden. Retryable: false.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: 'not found. Retryable: false.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '413':
          description: 'payload too large. Retryable: false.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '415':
          description: 'unsupported media type. Retryable: false.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: 'rate limited. Retryable: true.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: 'internal error. Retryable: true.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '502':
          description: 'downstream unavailable. Retryable: true.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '504':
          description: 'downstream timeout. Retryable: true.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      security:
        - StytchBearer:
            - fmg.contacts.read
          ApiKey: []
components:
  schemas:
    ContactListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/FmgContactSummary'
        pageInfo:
          $ref: '#/components/schemas/PageInfo'
      required:
        - data
        - pageInfo
      additionalProperties: false
    Problem:
      type: object
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        instance:
          type: string
        code:
          type: string
          enum:
            - invalid_request
            - unauthorized
            - forbidden
            - not_found
            - version_mismatch
            - rate_limited
            - payload_too_large
            - unsupported_media_type
            - downstream_timeout
            - downstream_unavailable
            - internal_error
          description: >-
            invalid_request: HTTP 400, retryable=false; unauthorized: HTTP 401,
            retryable=false; forbidden: HTTP 403, retryable=false; not_found:
            HTTP 404, retryable=false; version_mismatch: HTTP 400,
            retryable=false; rate_limited: HTTP 429, retryable=true;
            payload_too_large: HTTP 413, retryable=false;
            unsupported_media_type: HTTP 415, retryable=false;
            downstream_timeout: HTTP 504, retryable=true;
            downstream_unavailable: HTTP 502, retryable=true; internal_error:
            HTTP 500, retryable=true
        traceId:
          type: string
        retryable:
          type: boolean
        details: {}
      required:
        - type
        - title
        - status
        - detail
        - instance
        - code
        - traceId
        - retryable
    FmgContactSummary:
      type: object
      properties:
        contactId:
          type: integer
        identifier:
          type: string
        fullName:
          type:
            - string
            - 'null'
        firstName:
          type:
            - string
            - 'null'
        lastName:
          type:
            - string
            - 'null'
        email:
          type:
            - string
            - 'null'
        emailStatus:
          type:
            - string
            - 'null'
        emailAddressDisposition:
          type: integer
        status:
          type:
            - string
            - 'null'
        source:
          type: integer
        sourceText:
          type:
            - string
            - 'null'
        groupCount:
          type: integer
        groupNames:
          type:
            - array
            - 'null'
          items:
            type: string
        remoteContactId:
          type:
            - string
            - 'null'
        remoteContactUrl:
          type:
            - string
            - 'null'
        isCrmLinkedContact:
          type: boolean
        dateTimeCreated:
          type: string
          minLength: 1
      additionalProperties: false
    PageInfo:
      type: object
      properties:
        page:
          type: integer
          minimum: 1
        pageSize:
          type: integer
          minimum: 1
          maximum: 200
        sortDirection:
          type:
            - string
            - 'null'
          enum:
            - asc
            - desc
            - null
        sortBy:
          type:
            - string
            - 'null'
        totalRecord:
          type: integer
          minimum: 0
      required:
        - page
        - pageSize
        - totalRecord
  securitySchemes:
    StytchBearer:
      type: oauth2
      description: OAuth 2.1 access tokens issued by Stytch Connected Apps.
      flows:
        authorizationCode:
          authorizationUrl: https://api.stytch.com/v1/public/oauth2/authorize
          tokenUrl: https://api.stytch.com/v1/public/oauth2/token
          scopes:
            fmg.contacts.read: Read FMG Suite contacts and contact groups.
            fmg.contacts.write: Create, update, and delete FMG Suite contacts and groups.
        clientCredentials:
          tokenUrl: https://api.stytch.com/v1/public/oauth2/token
          scopes:
            fmg.contacts.read: Read FMG Suite contacts and contact groups.
            fmg.contacts.write: Create, update, and delete FMG Suite contacts and groups.
    ApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API usage-plan key. Required on every request, sent as the `x-api-key`
        header.

````