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

# Search PayTag directory



## OpenAPI

````yaml /openapi/partner.openapi.json get /partner/paytag/search
openapi: 3.0.3
info:
  title: Partner API
  version: 1.0.0
  description: OpenAPI spec for Partner Terminal and Transaction API
servers:
  - url: https://staging-api.yourflexpay.com/v2
    description: Staging
  - url: https://sandbox-api.yourflexpay.com/v2
    description: Sandbox
  - url: https://api.yourflexpay.com/v2
    description: Live
security: []
tags:
  - name: Partner Terminal
  - name: Partner Transactions
  - name: Partner PayTag
  - name: Partner Wallet
paths:
  /partner/paytag/search:
    get:
      tags:
        - Partner PayTag
      summary: Search PayTag directory
      parameters:
        - name: q
          in: query
          required: true
          schema:
            type: string
          description: >-
            Identifier prefix to search by tag, email, or phone across the
            unified PayTag directory
      responses:
        '200':
          description: Paginated PayTag directory search results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedDirectoryTagResponse'
              example:
                items:
                  - App: local
                    Tag: janedoe@flex
                    Name: Jane Doe
                    Email: jane@example.com
                    PhoneNumber: '08012345678'
                    ProfileImage: https://example.com/avatar.jpg
                count: 1
                limit: 20
                offset: 0
      security:
        - ClientIdHeader: []
          ApiKeyHeader: []
components:
  schemas:
    PaginatedDirectoryTagResponse:
      type: object
      required:
        - items
        - count
        - limit
        - offset
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DirectoryTag'
        count:
          type: integer
        limit:
          type: integer
        offset:
          type: integer
    DirectoryTag:
      description: >-
        Directory-backed PayTag profile. Results may come from FLEX local tags
        or connected external directory providers.
      type: object
      required:
        - App
        - Tag
        - Name
      properties:
        App:
          type: string
        Tag:
          type: string
        Name:
          type: string
        Email:
          type: string
        PhoneNumber:
          type: string
        ProfileImage:
          type: string
  securitySchemes:
    ClientIdHeader:
      type: apiKey
      in: header
      name: x-client-id
    ApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key

````

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