---
title: "ApiV1Response"
url: "https://developer.argaam.com/apis/fundamentals-layer-api-production-v1/versions/9efc2daf-927c-4236-8c4b-94837efef50d/schemas/ApiV1Response"
---

> Full API specification: https://developer.argaam.com/apis/fundamentals-layer-api-production-v1/versions/9efc2daf-927c-4236-8c4b-94837efef50d.md

# ApiV1Response

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Fundamentals Layer API
  version: v1.1
servers:
  - url: https://api.argaam.com
    description: Argaam API Gateway (Production)
components:
  schemas:
    ApiV1Meta:
      type: object
      properties:
        page:
          type: integer
          format: int32
        pageSize:
          type: integer
          format: int32
        totalRecords:
          type: integer
          format: int32
        totalPages:
          type: integer
          format: int32
          readOnly: true
        hasNextPage:
          type: boolean
          readOnly: true
        hasPreviousPage:
          type: boolean
          readOnly: true
      additionalProperties: false
    ApiV1RateLimit:
      type: object
      properties:
        limit:
          type: integer
          format: int32
        remaining:
          type: integer
          format: int32
        reset:
          type: string
          format: date-time
      additionalProperties: false
    ApiV1Response:
      type: object
      properties:
        success:
          type: boolean
        apiVersion:
          type: string
          nullable: true
        timestamp:
          type: string
          format: date-time
        requestId:
          type: string
          nullable: true
        data:
          nullable: true
        meta:
          $ref: "#/components/schemas/ApiV1Meta"
        rateLimit:
          $ref: "#/components/schemas/ApiV1RateLimit"
      additionalProperties: false
```