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

# Get Team Members

> Retrieves a paginated list of team members for the business.

Retrieve a paginated list of team members for your business. Filter by status or search by name and email.

## Example Request

```bash theme={null}
curl -X GET "https://api.rolla.xyz/api/v1/external/teams/members?page=1&pageSize=10&status=active" \
  -H "X-API-Key: your_api_key_here"
```

## Query Parameters

| Parameter  | Type    | Description                              |
| ---------- | ------- | ---------------------------------------- |
| `page`     | integer | Page number (default: 1)                 |
| `pageSize` | integer | Results per page (default: 10, max: 100) |
| `search`   | string  | Search by name or email                  |
| `status`   | string  | Filter by status: `active`, `inactive`   |

## Example Response

```json theme={null}
{
  "status": 200,
  "success": true,
  "message": "Team members retrieved successfully",
  "data": {
    "members": [
      {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "email": "jane@example.com",
        "fullname": "Jane Doe",
        "role": "initiator",
        "role_id": "c3d4e5f6-7890-abcd-ef12-34567890abcd",
        "status": "active",
        "invite_status": "accepted",
        "is_owner": false,
        "joined_at": "2024-01-10T08:00:00.000Z"
      }
    ],
    "pagination": {
      "page": 1,
      "pageSize": 10,
      "total": 3
    }
  }
}
```

<Note>
  The `role` field returns the role name — one of `business_owner`, `business_admin`, `initiator`, or `approver`. The former `collaborator` value is now returned as `initiator`. If you string-match on role names, map `"collaborator"` to `"initiator"` and add an `"approver"` branch. See [Get Available Roles](/api-reference/endpoint/teams/roles) for the full role reference.
</Note>


## OpenAPI

````yaml GET /teams/members
openapi: 3.1.0
info:
  title: Rolla Developer API
  description: >-
    API for programmatic transaction management on the Rolla platform. Monetary
    `amount` fields use the smallest unit of the referenced currency unless an
    endpoint says otherwise (e.g. NGN = kobo, USD = cents, where **100 cents =
    USD 1.00**).
  version: 1.0.0
servers:
  - url: https://api.rolla.xyz/api/v1/external
    description: Production server
security:
  - apiKeyAuth: []
paths:
  /teams/members:
    get:
      summary: Get Team Members
      description: Retrieves a paginated list of team members for the business.
      operationId: getTeamMembers
      parameters:
        - name: page
          in: query
          description: 'Page number (default: 1)'
          schema:
            type: integer
            default: 1
            minimum: 1
        - name: pageSize
          in: query
          description: 'Results per page (default: 10, max: 100)'
          schema:
            type: integer
            default: 10
            minimum: 1
            maximum: 100
        - name: search
          in: query
          description: Search by name or email
          schema:
            type: string
        - name: status
          in: query
          description: Filter by member status
          schema:
            type: string
            enum:
              - active
              - inactive
      responses:
        '200':
          description: Team members retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Team members retrieved successfully
                  data:
                    type: object
                    properties:
                      members:
                        type: array
                        items:
                          $ref: '#/components/schemas/TeamMember'
                      pagination:
                        $ref: '#/components/schemas/Pagination'
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    TeamMember:
      type: object
      properties:
        userId:
          type: string
          format: uuid
          description: Member user identifier
        email:
          type: string
          format: email
          description: Member email address
        fullname:
          type: string
          description: Member full name
        role:
          type: string
          enum:
            - business_owner
            - business_admin
            - initiator
            - approver
          description: >-
            Assigned role name. The former `collaborator` value is now returned
            as `initiator`.
        status:
          type: string
          enum:
            - active
            - inactive
            - pending
          description: Member status
        created_at:
          type: string
          format: date-time
          description: Date member was added
    Pagination:
      type: object
      properties:
        page:
          type: integer
          description: Current page number
        pageSize:
          type: integer
          description: Results per page
        total:
          type: integer
          description: Total number of results
    Error:
      type: object
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your Rolla API key

````