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

# Find members of your organization by name or email

> Pass exactly one of `q` or `email`. `email` is an exact match, ignoring case, and answers at most one member. Every word of `q` must appear in the member's display name, first name or last name, in any order, ignoring case and accents (`zoe` finds `Zoë`); punctuation is compared as stored. Ordered by display name. Removed memberships are left out and locked ones carry their status. Each response is capped at `limit` rows with no cursor, which bounds a response and not what a key can learn: repeated searches can list your whole member directory, and your organization key is allowed to.



## OpenAPI

````yaml https://api.develop.fourdos.dev/openapi/partner.json get /v1/users
openapi: 3.1.0
info:
  title: 4D OS Partner API
  version: 0.1.0
  description: >-
    REST API for 4D OS partners. Authenticate with your organization API key:
    `Authorization: Bearer <key>`.


    Requests and responses are JSON with `snake_case` field names. Errors share
    one envelope: `{ "error": { "code", "status", "message", "details"? } }`.


    Mutating endpoints that declare it accept an `Idempotency-Key` header so
    retries are safe.


    Bulk-migrating members? See the [Migrating to 4D
    guide](https://docs.fourdos.dev/walkthroughs/migrate-existing-members) for
    the canonical import schema, a worked example, and the `/v1/imports`
    sequence.
servers:
  - url: https://api.develop.fourdos.dev
security:
  - partnerApiKey: []
tags:
  - name: Users
    description: Create, read, and manage users and their org membership
  - name: Imports
    description: Bulk member import jobs (staging → validate → commit)
  - name: API keys
    description: Issue, list, and revoke server-side organization API keys
  - name: Modules
    description: >-
      Publish private modules, install visible modules, and manage their
      credentials
  - name: Ingest
    description: Receive signed native events from an installed module
  - name: Engagement
    description: Browser event tracking (publishable keys) and tracking-key management
  - name: Revenue
    description: Report sales and refunds for the club's revenue dashboards
  - name: Ad delivery
    description: Fill a club site's ad slots, for anonymous or signed-in fans
  - name: Ad entries
    description: Fans entering a sponsor's draw, reported by the club's backend
paths:
  /v1/users:
    get:
      tags:
        - Users
      summary: Find members of your organization by name or email
      description: >-
        Pass exactly one of `q` or `email`. `email` is an exact match, ignoring
        case, and answers at most one member. Every word of `q` must appear in
        the member's display name, first name or last name, in any order,
        ignoring case and accents (`zoe` finds `Zoë`); punctuation is compared
        as stored. Ordered by display name. Removed memberships are left out and
        locked ones carry their status. Each response is capped at `limit` rows
        with no cursor, which bounds a response and not what a key can learn:
        repeated searches can list your whole member directory, and your
        organization key is allowed to.
      operationId: searchMembers
      parameters:
        - name: q
          in: query
          required: false
          description: >-
            A name: 2 to 100 characters, at most 5 words. Required unless
            `email` is given.
          schema:
            type: string
            minLength: 2
            maxLength: 100
        - name: email
          in: query
          required: false
          description: >-
            An exact email address, compared ignoring case. Required unless `q`
            is given.
          schema:
            type: string
            format: email
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 50
            default: 20
      responses:
        '200':
          description: The matching members
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemberSearchPage'
        '401':
          description: Authentication is required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No organization in the caller's scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    MemberSearchPage:
      type: object
      properties:
        members:
          type: array
          items:
            $ref: '#/components/schemas/MemberSearchResult'
        has_more:
          type: boolean
          description: >-
            True when more members match than `limit` returned. There is no
            cursor: narrow the query instead.
      required:
        - members
        - has_more
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            status:
              type: integer
            message:
              type: string
            details:
              type: object
              additionalProperties: true
          required:
            - code
            - status
            - message
      required:
        - error
    MemberSearchResult:
      type: object
      properties:
        id:
          type: string
          description: The user id, as `GET /v1/users/{userId}` takes it.
        display_name:
          type:
            - string
            - 'null'
        first_name:
          type:
            - string
            - 'null'
        last_name:
          type:
            - string
            - 'null'
        membership:
          type: object
          properties:
            id:
              type: string
            external_id:
              type:
                - string
                - 'null'
            status:
              type: string
              enum:
                - active
                - locked
            joined_at:
              type: string
              format: date-time
          required:
            - id
            - external_id
            - status
            - joined_at
      required:
        - id
        - display_name
        - first_name
        - last_name
        - membership
  securitySchemes:
    partnerApiKey:
      type: http
      scheme: bearer
      description: >-
        Organization API key (`org_...`) sent as `Authorization: Bearer <key>`.
        Keys are scoped to one organization; every request operates within that
        tenant.

````

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