---
agentTools:
  projectIndex: https://tyms.readme.io/llms.txt
---

# Get Journals

Retrieves the details of all previously created journals.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Tyms (Sandbox)",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://staging-api.tyms.io/api/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "name": "secret-key",
        "in": "header",
        "x-default": "sk_2938310299229"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/journals": {
      "get": {
        "summary": "Get Journals",
        "description": "Retrieves the details of all previously created journals.",
        "operationId": "get-journals",
        "parameters": [
          {
            "name": "secret-key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"status\": \"success\",\n  \"message\": \"Journals retrieved successfully\",\n  \"data\": {\n    \"current_page\": 1,\n    \"data\": [\n      {\n        \"uuid\": \"a220b6e7e1954bf48e8ba1b0daa578ae\",\n        \"description\": \"Sales\",\n        \"date\": \"2023-08-31T14:49:05.000000Z\",\n        \"currency\": \"NGN\",\n        \"items\": [\n          {\n            \"uuid\": \"d001d327b4884f5cb7766c33b063c121\",\n            \"description\": \"Sales\",\n            \"category\": \"Selling, general, and administrative expenses\",\n            \"debit\": 0,\n            \"credit\": 1000,\n            \"currency\": \"NGN\"\n          },\n          {\n            \"uuid\": \"153eda1a34194d308aa280a6cbba5b19\",\n            \"description\": \"Cash\",\n            \"category\": \"Cash\",\n            \"debit\": 1000,\n            \"credit\": 0,\n            \"currency\": \"NGN\"\n          }\n        ]\n      },\n\n      {\n        \"uuid\": \"7c5cdec4abed483a88c1e999bb6b6c6f\",\n        \"description\": \"Sales\",\n        \"date\": \"2023-08-31T13:50:38.000000Z\",\n        \"currency\": \"NGN\",\n        \"items\": [\n          {\n            \"uuid\": \"d001d327b4884f5cb7766c33b063c121\",\n            \"description\": \"Sales\",\n            \"category\": \"Selling, general, and administrative expenses\",\n            \"debit\": 0,\n            \"credit\": 1000,\n            \"currency\": \"NGN\"\n          },\n          {\n            \"uuid\": \"153eda1a34194d308aa280a6cbba5b19\",\n            \"description\": \"Cash\",\n            \"category\": \"Cash\",\n            \"debit\": 1000,\n            \"credit\": 0,\n            \"currency\": \"NGN\"\n          }\n        ]\n      }\n    ],\n    \"first_page_url\": \"http://127.0.0.1:8000/api/v1/journals?page=1\",\n    \"from\": 1,\n    \"last_page\": 1,\n    \"last_page_url\": \"http://127.0.0.1:8000/api/v1/journals?page=1\",\n    \"links\": [\n      {\n        \"url\": null,\n        \"label\": \"« Previous\",\n        \"active\": false\n      },\n      {\n        \"url\": \"http://127.0.0.1:8000/api/v1/journals?page=1\",\n        \"label\": \"1\",\n        \"active\": true\n      },\n      {\n        \"url\": null,\n        \"label\": \"Next »\",\n        \"active\": false\n      }\n    ],\n    \"next_page_url\": null,\n    \"path\": \"http://127.0.0.1:8000/api/v1/journals\",\n    \"per_page\": 100,\n    \"prev_page_url\": null,\n    \"to\": 5,\n    \"total\": 5\n  }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "success"
                    },
                    "message": {
                      "type": "string",
                      "example": "Journals retrieved successfully"
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "current_page": {
                          "type": "integer",
                          "example": 1,
                          "default": 0
                        },
                        "data": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "uuid": {
                                "type": "string",
                                "example": "a220b6e7e1954bf48e8ba1b0daa578ae"
                              },
                              "description": {
                                "type": "string",
                                "example": "Sales"
                              },
                              "date": {
                                "type": "string",
                                "example": "2023-08-31T14:49:05.000000Z"
                              },
                              "currency": {
                                "type": "string",
                                "example": "NGN"
                              },
                              "items": {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "uuid": {
                                      "type": "string",
                                      "example": "d001d327b4884f5cb7766c33b063c121"
                                    },
                                    "description": {
                                      "type": "string",
                                      "example": "Sales"
                                    },
                                    "category": {
                                      "type": "string",
                                      "example": "Selling, general, and administrative expenses"
                                    },
                                    "debit": {
                                      "type": "integer",
                                      "example": 0,
                                      "default": 0
                                    },
                                    "credit": {
                                      "type": "integer",
                                      "example": 1000,
                                      "default": 0
                                    },
                                    "currency": {
                                      "type": "string",
                                      "example": "NGN"
                                    }
                                  }
                                }
                              }
                            }
                          }
                        },
                        "first_page_url": {
                          "type": "string",
                          "example": "http://127.0.0.1:8000/api/v1/journals?page=1"
                        },
                        "from": {
                          "type": "integer",
                          "example": 1,
                          "default": 0
                        },
                        "last_page": {
                          "type": "integer",
                          "example": 1,
                          "default": 0
                        },
                        "last_page_url": {
                          "type": "string",
                          "example": "http://127.0.0.1:8000/api/v1/journals?page=1"
                        },
                        "links": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "url": {},
                              "label": {
                                "type": "string",
                                "example": "« Previous"
                              },
                              "active": {
                                "type": "boolean",
                                "example": false,
                                "default": true
                              }
                            }
                          }
                        },
                        "next_page_url": {},
                        "path": {
                          "type": "string",
                          "example": "http://127.0.0.1:8000/api/v1/journals"
                        },
                        "per_page": {
                          "type": "integer",
                          "example": 100,
                          "default": 0
                        },
                        "prev_page_url": {},
                        "to": {
                          "type": "integer",
                          "example": 5,
                          "default": 0
                        },
                        "total": {
                          "type": "integer",
                          "example": 5,
                          "default": 0
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "66af161f6f18be002a6dc48f:653bb45bf22a78002488994f"
}
```