> ## Documentation Index
> Fetch the complete documentation index at: https://direct-api.reap.global/llms.txt
> Use this file to discover all available pages before exploring further.

# List team members

> Required API-key scope: `team_members:read`.

Returns the people on your Business Account team, with their team group and invitation status. Use it to find the `userId` to pass as `cardholderId` when you create a card with [Create card](/api-reference/cards/create-card): only members with `inviteStatus` `approved` can hold cards. Team members are invited and managed in the dashboard. See [Team members](/concepts/team-members).

Team members are invited and managed in the dashboard. See [Managing Your Team](https://support.reap.global/hc/en-us/articles/16170798649743-Managing-Your-Team) in the Help Center.


## OpenAPI

````yaml GET /2026-11-16/team-members
openapi: 3.1.0
info:
  title: Reap Business Account API
  description: >

    # Introduction


    The Reap Business Account API lets you manage cards, spend and Treasury

    funding for your Business Account from your own systems. Every endpoint is

    authenticated with an API key sent in the `x-api-key` header and versioned

    with a date in the URL (`/2026-11-16/...`).


    Guides, concepts and the full setup reference live on the docs site:

    [direct-api.reap.global](https://direct-api.reap.global).



    ## Errors


    All errors share a single JSON envelope:


    ```json

    {
      "statusCode": 400,
      "type": "INVALID_REQUEST_ERROR",
      "code": "SPEND_CAP_TOO_LOW",
      "message": "Spend cap cannot be lower than the amount already spent on this card.",
      "param": "spendCap",
      "requestId": "01H..."
    }

    ```


    - `statusCode`: HTTP status, duplicated in the body.

    - `type`: coarse category, **always present**. Branch on this for
    retry/re-auth decisions.

    - `code`: stable, machine-readable identifier. Present only for
    programmatically-actionable errors.

    - `message`: human-readable explanation, safe to surface to users.

    - `param`: offending field for validation errors (optional).

    - `details`: structured extra context such as validation issues or required
    API-key scopes (optional).

    - `requestId`: correlation id; include it when contacting support
    (optional).


    The specific error codes each endpoint can return are documented on that

    endpoint's responses below.


    ### Error types


    | Type | Description |

    | --- | --- |

    | `INVALID_REQUEST_ERROR` | The request was rejected due to invalid input, a
    missing resource, or a business-rule violation (HTTP 400/404/409/422). |

    | `AUTHENTICATION_ERROR` | Authentication is missing or invalid (HTTP 401).
    |

    | `PERMISSION_ERROR` | The caller is authenticated but not permitted to
    perform the action (HTTP 403). |

    | `RATE_LIMIT_ERROR` | Too many requests; retry after a delay (HTTP 429). |

    | `API_ERROR` | An unexpected error occurred on our side (HTTP 5xx). |

    | `UPSTREAM_ERROR` | An upstream service returned an error (HTTP 502/503). |
  version: '2026-11-16'
  contact: {}
servers:
  - url: https://api.global.direct.reap.global
security: []
tags: []
paths:
  /2026-11-16/team-members:
    get:
      tags:
        - Team members
      summary: List team members
      description: >-
        Required API-key scope: `team_members:read`.


        Returns the people on your Business Account team, with their team group
        and invitation status. Use it to find the `userId` to pass as
        `cardholderId` when you create a card with [Create
        card](/api-reference/cards/create-card): only members with
        `inviteStatus` `approved` can hold cards. Team members are invited and
        managed in the dashboard. See [Team members](/concepts/team-members).
      operationId: listTeamMembers
      parameters:
        - name: page
          required: false
          in: query
          description: >-
            Which page of results to return, starting at 1 (the default). Use it
            with `meta.totalPages` to go through all results.
          schema:
            default: 1
            description: >-
              Which page of results to return, starting at 1 (the default). Use
              it with `meta.totalPages` to go through all results.
            type: integer
            minimum: 1
            maximum: 9007199254740991
        - name: limit
          required: false
          in: query
          description: >-
            How many items to return per page. It must be between 1 and 100
            (default 20).
          schema:
            default: 20
            description: >-
              How many items to return per page. It must be between 1 and 100
              (default 20).
            type: integer
            minimum: 1
            maximum: 100
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TeamMemberList'
              examples:
                teamMembers:
                  summary: Team members
                  value:
                    items:
                      - userId: user_01JZ2Q1J4Y8P7M6N5K3H2G1F0E
                        name: Ada Lovelace
                        email: ada@example.com
                        teamGroupId: group_01JZ2Q1J4Y8P7M6N5K3H2G1F0E
                        teamGroupName: Engineering
                        inviteStatus: approved
                    meta:
                      totalItems: 1
                      itemCount: 1
                      itemsPerPage: 20
                      totalPages: 1
                      currentPage: 1
        '400':
          description: '`BAD_REQUEST`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                BAD_REQUEST:
                  summary: BAD_REQUEST
                  value:
                    statusCode: 400
                    type: INVALID_REQUEST_ERROR
                    message: Bad request.
        '401':
          description: '`UNAUTHORIZED`, `AUTH_CREDENTIAL_MISSING`, `API_KEY_INVALID`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UNAUTHORIZED:
                  summary: UNAUTHORIZED
                  value:
                    statusCode: 401
                    type: AUTHENTICATION_ERROR
                    message: Authentication required.
                AUTH_CREDENTIAL_MISSING:
                  summary: AUTH_CREDENTIAL_MISSING
                  value:
                    statusCode: 401
                    type: AUTHENTICATION_ERROR
                    code: AUTH_CREDENTIAL_MISSING
                    message: Authentication is required.
                API_KEY_INVALID:
                  summary: API_KEY_INVALID
                  value:
                    statusCode: 401
                    type: AUTHENTICATION_ERROR
                    code: API_KEY_INVALID
                    message: API key is invalid.
        '403':
          description: >-
            `FORBIDDEN`, `API_KEY_IP_NOT_ALLOWED`,
            `AUTH_INSUFFICIENT_PERMISSIONS`, `AUTH_METHOD_NOT_ALLOWED`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                FORBIDDEN:
                  summary: FORBIDDEN
                  value:
                    statusCode: 403
                    type: PERMISSION_ERROR
                    message: You do not have permission to perform this action.
                API_KEY_IP_NOT_ALLOWED:
                  summary: API_KEY_IP_NOT_ALLOWED
                  value:
                    statusCode: 403
                    type: PERMISSION_ERROR
                    code: API_KEY_IP_NOT_ALLOWED
                    message: Request IP is not allowed for this API key.
                AUTH_INSUFFICIENT_PERMISSIONS:
                  summary: AUTH_INSUFFICIENT_PERMISSIONS
                  value:
                    statusCode: 403
                    type: PERMISSION_ERROR
                    code: AUTH_INSUFFICIENT_PERMISSIONS
                    message: Insufficient permissions.
                    details:
                      requiredScopes:
                        - <required-scope>
                AUTH_METHOD_NOT_ALLOWED:
                  summary: AUTH_METHOD_NOT_ALLOWED
                  value:
                    statusCode: 403
                    type: PERMISSION_ERROR
                    code: AUTH_METHOD_NOT_ALLOWED
                    message: >-
                      This endpoint does not accept the credential type
                      provided.
        '429':
          description: '`API_KEY_RATE_LIMITED`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                API_KEY_RATE_LIMITED:
                  summary: API_KEY_RATE_LIMITED
                  value:
                    statusCode: 429
                    type: RATE_LIMIT_ERROR
                    code: API_KEY_RATE_LIMITED
                    message: API key rate limit exceeded.
        '500':
          description: '`INTERNAL_ERROR`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                INTERNAL_ERROR:
                  summary: INTERNAL_ERROR
                  value:
                    statusCode: 500
                    type: API_ERROR
                    message: An unexpected error occurred.
        '504':
          description: '`UPSTREAM_TIMEOUT`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                UPSTREAM_TIMEOUT:
                  summary: UPSTREAM_TIMEOUT
                  value:
                    statusCode: 504
                    type: UPSTREAM_ERROR
                    code: UPSTREAM_TIMEOUT
                    message: >-
                      An upstream service did not respond in time. If this
                      request changes data, it may still have been applied, so
                      fetch the resource before you retry.
      security:
        - apiKey: []
components:
  schemas:
    TeamMemberList:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              userId:
                type: string
                description: >-
                  The team member's ID. Pass it as `cardholderId` in [Create
                  card](/api-reference/cards/create-card); this only works when
                  `inviteStatus` is `approved`.
              name:
                type: string
                description: >-
                  The team member's name, or their email address if no name has
                  been set.
              email:
                type: string
                description: >-
                  The team member's email address. Use it to match team members
                  to people in your own systems.
              teamGroupId:
                description: >-
                  The ID of the team group the member belongs to. Null if they
                  aren't in a group, or if their group can't be determined.
                type:
                  - string
                  - 'null'
              teamGroupName:
                description: >-
                  The name of the member's team group, for example
                  `Engineering`. Null if they aren't in a group, or if their
                  group can't be determined.
                type:
                  - string
                  - 'null'
              inviteStatus:
                type: string
                enum:
                  - approved
                  - invited
                  - unresolved
                  - declined
                description: >-
                  Where the member's invitation stands: `approved`, `invited`
                  (invitation sent, not yet accepted), `declined` (invitation
                  declined) or `unresolved` (the invitation hasn't been sent
                  yet, or the member was copied to a new business and still
                  needs to accept). Only `approved` members can hold cards.
            required:
              - userId
              - name
              - email
              - teamGroupId
              - teamGroupName
              - inviteStatus
          description: The team members on this page, one object per person.
        meta:
          type: object
          properties:
            totalItems:
              type: number
              description: How many items match your filters, across all pages.
            itemCount:
              type: number
              description: How many items are on this page.
            itemsPerPage:
              type: number
              description: The page size you asked for with `limit`.
            totalPages:
              type: number
              description: >-
                How many pages there are in total. Keep requesting the next
                `page` until you reach this number.
            currentPage:
              type: number
              description: The page number you're looking at, starting at 1.
          required:
            - totalItems
            - itemCount
            - itemsPerPage
            - totalPages
            - currentPage
          description: >-
            Pagination details, so you know how many results exist and which
            page you're on.
      required:
        - items
        - meta
    ErrorResponse:
      type: object
      properties:
        statusCode:
          type: integer
          minimum: 100
          maximum: 599
          description: The HTTP status code, repeated in the body for convenience.
        type:
          type: string
          enum:
            - INVALID_REQUEST_ERROR
            - AUTHENTICATION_ERROR
            - PERMISSION_ERROR
            - RATE_LIMIT_ERROR
            - API_ERROR
            - UPSTREAM_ERROR
          description: >-
            The broad kind of error, for example `RATE_LIMIT_ERROR`. It's always
            present: use it to decide whether to retry, re-authenticate or fix
            the request.
        code:
          description: >-
            A stable, machine-readable error code, for example
            `CARD_CREATION_REQUIRES_DEPOSIT`. It's present when there's a
            specific action you can take, and each endpoint lists the codes it
            can return.
          type: string
        message:
          type: string
          description: >-
            A plain-English explanation of the error that's safe to show to your
            users.
        param:
          description: >-
            The request field that caused a validation error, for example
            `spendCap`.
          type: string
        details:
          description: >-
            Extra structured information, such as the list of validation issues
            or the API-key scopes your key is missing.
        requestId:
          description: >-
            A unique ID for this request. Include it when you contact Reap
            Support so the team can find it.
          type: string
      required:
        - statusCode
        - type
        - message
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Enter your API key

````

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