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

# List Attendance

This API functionality captures the checkin & checkout of an employee. This is used in HR-Reception to update the actual checkin /checkout time.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Production with User Token",
    "version": "3-India"
  },
  "servers": [
    {
      "url": "https://in-api.ledgers.cloud/v3"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "name": "x-api-key",
        "in": "header"
      },
      "sec1": {
        "type": "apiKey",
        "name": "api-token",
        "in": "header"
      }
    }
  },
  "security": [
    {
      "sec0": [],
      "sec1": []
    }
  ],
  "paths": {
    "/hr/attendance": {
      "post": {
        "summary": "List Attendance",
        "description": "This API functionality captures the checkin & checkout of an employee. This is used in HR-Reception to update the actual checkin /checkout time.",
        "operationId": "update-checkin-checkout-copy",
        "parameters": [
          {
            "name": "api-token",
            "in": "header",
            "description": "Generate token  from authentication api",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "x-api-key",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "date",
            "in": "query",
            "description": "The date for which attendance data is requested, in YYYY-MM-DD format.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "type",
            "in": "query",
            "description": "Specifies the request type. Default value is 'listAttendance",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "pagination",
            "in": "query",
            "required": true,
            "schema": {
              "items": {
                "properties": {
                  "perpage": {
                    "type": "string",
                    "description": "Number of records to return per page"
                  },
                  "page": {
                    "type": "string",
                    "description": "Current page number to retrieve."
                  },
                  "query": {
                    "type": "string",
                    "description": "Search employee name in the attendance record"
                  }
                },
                "type": "object"
              },
              "type": "array"
            },
            "style": "deepObject",
            "explode": true
          },
          {
            "name": "sort",
            "in": "query",
            "schema": {
              "items": {
                "properties": {
                  "field": {
                    "type": "string",
                    "description": "Used to sort the column (eg:employee_name)"
                  },
                  "sort": {
                    "type": "string",
                    "description": "ASC for ascending and DESC for descending"
                  }
                },
                "type": "object"
              },
              "type": "array"
            },
            "style": "deepObject",
            "explode": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"status\": 1,\n    \"msg\": \"success\",\n    \"data\": [\n        {\n            \"employee_id\": \"8498\",\n            \"employee_name\": \"Afsal A\",\n            \"designation\": \"Accountant\",\n            \"date\": \"2026-04-11 09:00:00\",\n            \"shift\": \"09:00 AM - 06:30 PM\",\n            \"intime\": \"11:16 AM\",\n            \"instatus\": \"Late\",\n            \"outtime\": null,\n            \"outstatus\": \"Still Working\",\n            \"checkin_image\": \"2388758533_2026_04_11_11_16_00_185670.jpg\",\n            \"checkout_image\": null,\n            \"bid\": 1656153249880,\n            \"gid\": 2388758533,\n            \"personalnumber\": 9840750931,\n            \"availability\": \"Inoffice\",\n            \"branch_name\": \"Chennai - Harrington Road\",\n            \"branch\": 1\n        }]}\n"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer",
                      "example": 1,
                      "default": 0
                    },
                    "msg": {
                      "type": "string",
                      "example": "success"
                    },
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "employee_id": {
                            "type": "string",
                            "example": "8498"
                          },
                          "employee_name": {
                            "type": "string",
                            "example": "Afsal A"
                          },
                          "designation": {
                            "type": "string",
                            "example": "Accountant"
                          },
                          "date": {
                            "type": "string",
                            "example": "2026-04-11 09:00:00"
                          },
                          "shift": {
                            "type": "string",
                            "example": "09:00 AM - 06:30 PM"
                          },
                          "intime": {
                            "type": "string",
                            "example": "11:16 AM"
                          },
                          "instatus": {
                            "type": "string",
                            "example": "Late"
                          },
                          "outtime": {},
                          "outstatus": {
                            "type": "string",
                            "example": "Still Working"
                          },
                          "checkin_image": {
                            "type": "string",
                            "example": "2388758533_2026_04_11_11_16_00_185670.jpg"
                          },
                          "checkout_image": {},
                          "bid": {
                            "type": "integer",
                            "example": 1656153249880,
                            "default": 0
                          },
                          "gid": {
                            "type": "integer",
                            "example": 2388758533,
                            "default": 0
                          },
                          "personalnumber": {
                            "type": "integer",
                            "example": 9840750931,
                            "default": 0
                          },
                          "availability": {
                            "type": "string",
                            "example": "Inoffice"
                          },
                          "branch_name": {
                            "type": "string",
                            "example": "Chennai - Harrington Road"
                          },
                          "branch": {
                            "type": "integer",
                            "example": 1,
                            "default": 0
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "The request was unacceptable, often due to missing a required parameter."
                  }
                }
              }
            }
          },
          "401": {
            "description": "401",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"errorCode\": \"E0401\",\n  \"errorMessage\": \"x-API-key or API-token authentication failed. Contact LEDGERS Developer Support.\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "errorCode": {
                      "type": "string",
                      "example": "E0401"
                    },
                    "errorMessage": {
                      "type": "string",
                      "example": "x-API-key or API-token authentication failed. Contact LEDGERS Developer Support."
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "403",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"errorCode\": \"E0403\",\n  \"errorMessage\": \"The API key doesn't have permission to perform the request. Contact LEDGERS Developer Support\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "errorCode": {
                      "type": "string",
                      "example": "E0403"
                    },
                    "errorMessage": {
                      "type": "string",
                      "example": "The API key doesn't have permission to perform the request. Contact LEDGERS Developer Support"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "500",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "Something went wrong on Ledgers end."
                  }
                }
              }
            }
          },
          "501": {
            "description": "501",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "Something went wrong on Ledgers end."
                  }
                }
              }
            }
          },
          "502": {
            "description": "502",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "Something went wrong on Ledgers end."
                  }
                }
              }
            }
          },
          "503": {
            "description": "503",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "Something went wrong on Ledgers end."
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "673ef64e825a22001fb16a5f:69da0c94b0908ac8c2a0678b"
}
```