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

# List Members

> Lists members.



## OpenAPI

````yaml /api-reference/ops/openapi.json get /api/v1/ops/members
openapi: 3.0.0
info:
  title: OABUS OPS API
  description: OABUS API
  version: '1.0'
  contact: {}
servers: []
security: []
tags: []
paths:
  /api/v1/ops/members:
    get:
      tags:
        - Member
      summary: List Members
      description: Lists members.
      operationId: listMembers
      parameters:
        - name: limit
          required: false
          in: query
          schema:
            default: 10
            description: Items per page
            example: 10
            type: number
        - name: page
          required: false
          in: query
          schema:
            default: 1
            description: Page number
            example: 1
            type: number
        - name: filter
          required: false
          in: query
          schema:
            description: |-
              Generic filter that matches against
              - name
              - email
            example: Maria
            type: string
        - name: createdAt
          required: false
          in: query
          schema:
            description: Created at range
            example: '>=2024-01-01;<=2024-12-31'
            type: string
        - name: roleId
          required: false
          in: query
          schema:
            type: string
            format: uuid
            description: Role identifier
            example: 0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a
        - name: status
          required: false
          in: query
          schema:
            type: string
            enum:
              - ACTIVE
              - REVOKED
            description: Membership status
            example: ACTIVE
        - name: sortBy
          required: false
          in: query
          schema:
            default: createdAt
            description: Field to sort by
            example: createdAt
            type: string
            enum:
              - createdAt
              - updatedAt
        - name: sortOrder
          required: false
          in: query
          schema:
            default: desc
            description: Sort order
            example: desc
            type: string
            enum:
              - asc
              - desc
        - name: fields
          required: false
          in: query
          description: >-
            Comma-separated list of fields to include in the response. Supports
            dot notation for nested projection (e.g.
            `id,name,user.email,trips.route.id`). Unknown fields are silently
            dropped.
          schema:
            type: string
      responses:
        '200':
          $ref: '#/components/responses/ListMembers200Response'
        '400':
          $ref: '#/components/responses/ListMembers400Response'
        '401':
          $ref: '#/components/responses/ListMembers401Response'
        '403':
          $ref: '#/components/responses/ListMembers403Response'
        '500':
          $ref: '#/components/responses/ListMembers500Response'
      security:
        - bearer: []
        - bearer: []
components:
  responses:
    ListMembers200Response:
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: array
                items:
                  type: object
                  properties:
                    membershipId:
                      type: string
                      format: uuid
                      description: Membership identifier
                      example: 0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a
                    userId:
                      type: string
                      format: uuid
                      description: User identifier
                      example: 0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a
                    organizationId:
                      description: Organization identifier
                      example: 0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a
                      nullable: true
                      type: string
                      format: uuid
                    roleId:
                      type: string
                      format: uuid
                      description: Role identifier
                      example: 0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a
                    status:
                      type: string
                      enum:
                        - ACTIVE
                        - REVOKED
                      description: Membership status
                      example: ACTIVE
                    revokedBy:
                      description: Revoked by
                      example: null
                      nullable: true
                      type: string
                      format: uuid
                    createdBy:
                      description: Created by
                      example: null
                      nullable: true
                      type: string
                      format: uuid
                    updatedBy:
                      description: Updated by
                      example: null
                      nullable: true
                      type: string
                      format: uuid
                    user:
                      type: object
                      properties:
                        avatar:
                          description: Avatar object key
                          example: >-
                            users/0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a/avatar/0195e7b2-4a3c-7d3e-9f4a-2c6b8d0e1f3b.png
                          nullable: true
                          type: string
                        email:
                          nullable: true
                          description: Email address
                          example: maria@example.com
                        name:
                          type: string
                          description: Full name
                          example: Maria Silva
                        phoneDdi:
                          description: International dialing code
                          example: '55'
                        phoneIso:
                          description: Phone ISO country code
                          example: BR
                        phoneNumber:
                          description: Phone number without country code
                          example: '99999999999'
                        userId:
                          type: string
                          format: uuid
                          description: User identifier
                          example: 0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a
                      required:
                        - name
                        - phoneDdi
                        - phoneIso
                        - phoneNumber
                        - userId
                      additionalProperties: false
                      description: User
                    role:
                      type: object
                      properties:
                        roleId:
                          type: string
                          format: uuid
                          description: Role identifier
                          example: 0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a
                        organizationId:
                          description: Organization identifier
                          example: 0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a
                          nullable: true
                          type: string
                          format: uuid
                        type:
                          type: string
                          enum:
                            - INTERNAL
                            - ENVIRONMENT
                            - ORGANIZATION
                          description: Role type
                          example: ORGANIZATION
                        name:
                          type: string
                          description: Role name
                          example: Administrador
                        description:
                          description: Role description
                          example: Acesso total à organização
                          nullable: true
                          type: string
                        permissions:
                          type: array
                          items:
                            type: string
                            enum:
                              - read:profile
                              - update:profile
                              - read:organization
                              - create:organization
                              - update:organization
                              - delete:organization
                              - read:role
                              - create:role
                              - update:role
                              - delete:role
                              - read:member
                              - create:member
                              - update:member
                              - delete:member
                              - read:employee
                              - create:employee
                              - update:employee
                              - read:cooperative
                              - read:user
                              - update:user
                              - read:benefit_category
                              - create:benefit_category
                              - update:benefit_category
                              - delete:benefit_category
                              - read:benefit_request
                              - update:benefit_request
                              - read:benefit_document
                              - update:benefit_document
                              - read:benefit_usage_history
                              - read:invite
                              - create:invite
                              - delete:invite
                              - read:audit
                              - read:support_case
                              - create:support_case
                              - update:support_case
                              - read:export
                              - create:export
                              - update:export
                              - read:notification
                              - update:notification
                              - delete:notification
                              - read:vehicle
                              - create:vehicle
                              - update:vehicle
                              - delete:vehicle
                              - read:seat-type
                              - read:driver
                              - create:driver
                              - update:driver
                              - delete:driver
                              - read:driver_transport_operator
                              - update:driver_transport_operator
                              - read:vehicle_transport_operator
                              - update:vehicle_transport_operator
                              - read:point
                              - create:point
                              - update:point
                              - delete:point
                              - read:transport_operator
                              - create:transport_operator
                              - update:transport_operator
                              - approve:transport_operator
                              - block:transport_operator
                              - reject:transport_operator
                              - unblock:transport_operator
                              - delete:transport_operator
                              - read:route
                              - create:route
                              - update:route
                              - delete:route
                              - read:route_approval
                              - update:route_approval
                              - approve:route_approval
                              - reject:route_approval
                              - read:transport_operator_route
                              - create:transport_operator_route
                              - update:transport_operator_route
                              - approve:transport_operator_route
                              - reject:transport_operator_route
                              - suspend:transport_operator_route
                              - reactivate:transport_operator_route
                              - read:transport_operator_route_policy
                              - create:transport_operator_route_policy
                              - update:transport_operator_route_policy
                              - delete:transport_operator_route_policy
                              - read:trip
                              - create:trip
                              - update:trip
                              - delete:trip
                              - read:trip_schedule
                              - create:trip_schedule
                              - update:trip_schedule
                              - delete:trip_schedule
                              - create:trip_event
                              - read:trip_review
                              - update:trip_review
                              - read:checkout
                              - read:order
                              - create:order
                              - update:order
                              - read:ticket
                              - create:ticket
                              - update:ticket
                              - delete:ticket
                              - read:payment
                              - read:cash_settlement
                              - update:cash_settlement
                              - read:cooperative_payment_settings
                              - update:cooperative_payment_settings
                              - read:transport_operator_subsidy_settlement
                              - update:transport_operator_subsidy_settlement
                              - approve:transport_operator_subsidy_settlement
                              - mark_paid:transport_operator_subsidy_settlement
                              - reject:transport_operator_subsidy_settlement
                              - read:balance
                              - read:receivable
                              - read:transfer
                              - create:transfer
                              - read:company_credit_account
                              - read:company_credit_purchase
                              - create:company_credit_purchase
                              - read:credit_grant
                              - create:credit_grant
                              - update:credit_grant
                              - read:webhook
                              - retry:webhook
                            description: Assignable permission identifier
                            example: create:trip
                          description: Granted permissions
                          example:
                            - read:trip
                            - create:trip
                        createdBy:
                          description: Creator user identifier
                          example: 0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a
                          nullable: true
                          type: string
                          format: uuid
                        createdAt:
                          type: string
                          format: date-time
                          description: Created at
                          example: '2026-01-01T00:00:00.000Z'
                        updatedBy:
                          description: Updater user identifier
                          example: 0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a
                          nullable: true
                          type: string
                          format: uuid
                        updatedAt:
                          type: string
                          format: date-time
                          description: Updated at
                          example: '2026-01-01T00:00:00.000Z'
                        deletedBy:
                          description: Remover user identifier
                          example: null
                          nullable: true
                          type: string
                          format: uuid
                        deletedAt:
                          description: Deleted at
                          example: null
                          nullable: true
                          type: string
                          format: date-time
                      required:
                        - roleId
                        - organizationId
                        - type
                        - name
                        - permissions
                        - createdAt
                        - updatedAt
                      additionalProperties: false
                      description: Role
                    revokedAt:
                      description: Revoked at
                      example: null
                      nullable: true
                      type: string
                      format: date-time
                    createdAt:
                      type: string
                      format: date-time
                      description: Created at
                      example: '2026-01-01T00:00:00.000Z'
                    updatedAt:
                      type: string
                      format: date-time
                      description: Updated at
                      example: '2026-01-01T00:00:00.000Z'
                  required:
                    - membershipId
                    - userId
                    - organizationId
                    - roleId
                    - status
                    - user
                    - role
                    - createdAt
                    - updatedAt
                  additionalProperties: false
                  description: Member
              meta:
                type: object
                properties:
                  limit:
                    type: number
                    description: Items per page
                    example: 10
                  page:
                    type: number
                    description: Current page
                    example: 1
                  totalItems:
                    type: number
                    description: Total items
                    example: 100
                  totalPages:
                    type: number
                    description: Total pages
                    example: 10
                required:
                  - limit
                  - page
                  - totalItems
                  - totalPages
                additionalProperties: false
            required:
              - data
              - meta
            additionalProperties: false
            description: List members
      description: OK
    ListMembers400Response:
      content:
        application/json:
          example:
            errors:
              - message: required
                path: name
            message: Bad Request Error
            statusCode: 400
          schema:
            properties:
              message:
                type: string
              statusCode:
                enum:
                  - 400
                type: number
              errors:
                items:
                  properties:
                    message:
                      type: string
                    path:
                      type: string
                  required:
                    - message
                    - path
                  type: object
                type: array
            required:
              - message
              - statusCode
            type: object
      description: Bad Request Error
    ListMembers401Response:
      content:
        application/json:
          example:
            message: Missing or invalid access token
            statusCode: 401
          schema:
            properties:
              message:
                type: string
              statusCode:
                enum:
                  - 401
                type: number
            required:
              - message
              - statusCode
            type: object
      description: Unauthorized
    ListMembers403Response:
      content:
        application/json:
          example:
            message: Insufficient permissions
            statusCode: 403
          schema:
            properties:
              message:
                type: string
              statusCode:
                enum:
                  - 403
                type: number
            required:
              - message
              - statusCode
            type: object
      description: Forbidden
    ListMembers500Response:
      content:
        application/json:
          example:
            message: Internal Server Error
            statusCode: 500
          schema:
            properties:
              message:
                type: string
              statusCode:
                enum:
                  - 500
                type: number
            required:
              - message
              - statusCode
            type: object
      description: Internal Server Error
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````