> ## 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 Credit Grants

> Lists credit grants.



## OpenAPI

````yaml /api-reference/customer/openapi.json get /api/v1/customer/credit-grants
openapi: 3.0.0
info:
  title: OABUS Customer API
  description: OABUS API
  version: '1.0'
  contact: {}
servers: []
security: []
tags: []
paths:
  /api/v1/customer/credit-grants:
    get:
      tags:
        - CreditGrant
      summary: List Credit Grants
      description: Lists credit grants.
      operationId: listCreditGrants
      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: companyId
          required: false
          in: query
          schema:
            type: string
            format: uuid
        - name: status
          required: false
          in: query
          schema:
            type: string
            enum:
              - ACTIVE
              - SUSPENDED
              - EXPIRED
              - CONSUMED
              - CANCELED
        - name: sortBy
          required: false
          in: query
          schema:
            default: createdAt
            description: Field to sort by
            example: createdAt
            type: string
            enum:
              - createdAt
              - expiresAt
              - availableAmount
        - 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/ListCreditGrants200Response'
        '400':
          $ref: '#/components/responses/ListCreditGrants400Response'
        '401':
          $ref: '#/components/responses/ListCreditGrants401Response'
        '500':
          $ref: '#/components/responses/ListCreditGrants500Response'
      security:
        - bearer: []
components:
  responses:
    ListCreditGrants200Response:
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: array
                items:
                  type: object
                  properties:
                    creditGrantId:
                      type: string
                      format: uuid
                    companyCreditAccountId:
                      type: string
                      format: uuid
                    organizationId:
                      type: string
                      format: uuid
                    companyId:
                      type: string
                      format: uuid
                    customerId:
                      type: string
                      format: uuid
                    grantedByUserId:
                      nullable: true
                      type: string
                      format: uuid
                    code:
                      type: string
                    reason:
                      nullable: true
                      type: string
                    amount:
                      type: integer
                    availableAmount:
                      type: integer
                    reservedAmount:
                      type: integer
                    usedAmount:
                      type: integer
                    status:
                      type: string
                      enum:
                        - ACTIVE
                        - SUSPENDED
                        - EXPIRED
                        - CONSUMED
                        - CANCELED
                    createdBy:
                      nullable: true
                      type: string
                      format: uuid
                    updatedBy:
                      nullable: true
                      type: string
                      format: uuid
                    deletedBy:
                      nullable: true
                      type: string
                      format: uuid
                    startsAt:
                      nullable: true
                      type: string
                      format: date-time
                    expiresAt:
                      nullable: true
                      type: string
                      format: date-time
                    canceledAt:
                      nullable: true
                      type: string
                      format: date-time
                    consumedAt:
                      nullable: true
                      type: string
                      format: date-time
                    createdAt:
                      type: string
                      format: date-time
                    updatedAt:
                      type: string
                      format: date-time
                    deletedAt:
                      nullable: true
                      type: string
                      format: date-time
                  required:
                    - creditGrantId
                    - companyCreditAccountId
                    - organizationId
                    - companyId
                    - customerId
                    - code
                    - amount
                    - availableAmount
                    - reservedAmount
                    - usedAmount
                    - status
                    - createdAt
                    - updatedAt
                  additionalProperties: false
                  description: Credit grant
              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 credit grants
      description: OK
    ListCreditGrants400Response:
      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
    ListCreditGrants401Response:
      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
    ListCreditGrants500Response:
      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

````