Jisr OpenAPI

https://openapi.jisr.net/
Admin
Jisr OpenAPI provides an API specification for integrating with JISR services, covering...
Tokens:41,438
Snippets:90
Trust Score:9.2
Update:1 year ago
Show doc for...
Tokens:
Raw
### API Request Example (HTTP)

Source: https://openapi.jisr.net/v1/jisr_be/public/openapis

This snippet demonstrates an example HTTP GET request to the nationalities endpoint. It includes necessary headers such as 'slug', 'api-version', and 'Access-Token', as well as query parameters for pagination ('page' and 'rpp').

```http
GET /websites/openapi_jisr_net/nationalities?page=1&rpp=20 HTTP/1.1
Host: api.jisr.net
slug: example-slug
api-version: 1.0
Access-Token: YOUR_ACCESS_TOKEN
```

--------------------------------

### API Success Response Example (Leave Summary)

Source: https://openapi.jisr.net/v1/jisr_be/public/openapis

This example demonstrates a successful API response containing leave summary data for employees. It includes details like employee code, leave type, and various balance figures.

```json
{
  "data": {
    "leaves_summary": [
      {
        "employee_code": 9,
        "id": "0b7c8400-5039-4ab4-8662-541826055c25",
        "leave_days": 30,
        "leave_type": "Annual",
        "manual_balance_adjustment": 0,
        "opening_balance": 0,
        "pending": 15.5,
        "previous_year_balance": 10,
        "total_reserved_balances": 0,
        "unpaid_leave_deduction": 0,
        "used": 0,
        "year_end_balance": 40
      },
      {
        "employee_code": 8,
        "id": "9b44bc55-4c3e-4279-b6ba-2b59787666da",
        "leave_days": 30,
        "leave_type": "Annual",
        "manual_balance_adjustment": 0,
        "opening_balance": 0,
        "pending": 15.5,
        "previous_year_balance": 10,
        "total_reserved_balances": 0,
        "unpaid_leave_deduction": 0,
        "used": 0,
        "year_end_balance": 40
      }
    ]
  }
}
```

--------------------------------

### Example JSON Response for Locations

Source: https://openapi.jisr.net/v1/jisr_be/public/openapis

This is an example of a successful JSON response when requesting locations. It confirms the operation's success, includes a null message, and provides a data object. The data object contains a list of locations, each with an 'id', 'address_en', and 'address_ar'. Pagination details like 'current_page', 'next_page', 'per_page', 'previous_page', 'total_entries', and 'total_pages' are also included.

```json
{
  "success": true,
  "message": null,
  "data": {
    "locations": [
      {
        "id": 6598,
        "address_en": "CR- Kharj",
        "address_ar": "CR- Kharj"
      },
      {
        "id": 736,
        "address_en": "ALEEM",
        "address_ar": "Ø£Ù„ÙŠÙ…"
      },
      {
        "id": 1190,
        "address_en": "test",
        "address_ar": "ÙØØµ"
      },
      {
        "id": 6564,
        "address_en": "CR- Head office",
        "address_ar": "Ø¹Ø±Ø¨ÙŠ "
      }
    ],
    "pagination": {
      "current_page": 1,
      "next_page": null,
      "per_page": 20,
      "previous_page": null,
      "total_entries": 9,
      "total_pages": 1
    }
  }
}
```

--------------------------------

### List Accrual Transactions - JSON Response Example

Source: https://openapi.jisr.net/v1/jisr_be/public/openapis

This snippet shows an example of a successful JSON response when listing accrual transactions. It includes details about the pay period and a list of employees with their accrual information.

```json
{
  "success": true,
  "message": null,
  "data": {
    "pay_period": "2023-01-01 - 2023-01-31",
    "employees": [
      {
        "accrual": {
          "amount": 27123.29,
          "downgrade_amount": 0,
          "has_vacation_days": false,
          "vacation_days": 0
        },
        "business_unit": null,
        "code": "895478215882",
        "country": null,
        "full_name_ar": "Ù…Ø±Ø§Ø¯",
        "full_name_en": "Morad Aljibly",
        "gosi_info": {
          "gosi_number": "60001234",
          "name_i18n": " 1 Al-salem"
        },
        "grade": null,
        "id": "b07874d9-6026-4e87-a78d-db5ad71ef198",
        "is_active": true,
        "payment_type": "Cash",
        "payment_type_i18n": "Cash",
        "status": "active"
      }
    ]
  }
}
```

--------------------------------

### Accrual Transactions Response Example (JSON)

Source: https://openapi.jisr.net/v1/jisr_be/public/openapis

This snippet provides a JSON example of a successful response from the List Accrual Transactions endpoint. It includes success status, a message field, data containing pay period details, a list of employees with their accrual information, and pagination details.

```JSON
{
  "success": true,
  "message": null,
  "data": {
    "pay_period": "",
    "employees": [
      {
        "id": "",
        "code": "",
        "full_name_en": "",
        "full_name_ar": "",
        "is_active": true,
        "status": "",
        "payment_type": "",
        "payment_type_i18n": "",
        "business_unit": null,
        "grade": null,
        "country": null,
        "gosi_info": {
          "name_i18n": "",
          "gosi_number": ""
        },
        "accrual": {
          "amount": 0,
          "downgrade_amount": 0,
          "vacation_days": 0,
          "has_vacation_days": true
        }
      }
    ],
    "pagination": {
      "total_pages": 0,
      "per_page": 0,
      "total_entries": 0
    }
  }
}
```

--------------------------------

### New Employee Record Example

Source: https://openapi.jisr.net/v1/jisr_be/public/openapis

This snippet represents a newly added employee record, showing initial data points and a placeholder for job title information. It illustrates the structure for new entries.

```YAML
- full_name_ar: New Employee
  full_name_en: New Employee
  gender: 
  id: 35b0b925-1d17-4bdf-9e11-4e01f2e8d783
  is_active: false
  is_invited: false
  job_title:
    id: 
    name_ar: 
    name_en: 
  joining_date: '2022-01-15'
  last_active_time: The employee has never logged in to his account
  line_manager:
    full_name: 
    guid: 
  location:
    id: 12020
    name_ar: Al Haram

```

--------------------------------

### Show Employee Financial Info GET Request

Source: https://openapi.jisr.net/v1/jisr_be/public/openapis

Retrieves financial information for a specific employee using a GET request to the '/openapi/v1/employees/financial_info' endpoint. Requires 'api-version', 'Slug', and 'Access-Token' headers. The 'source' and 'username' headers are optional.

```OpenAPI
GET /openapi/v1/employees/financial_info

---

# **Reuqest**

`GET /openapi/v1/employees/financial_info`

This API endpoint retrieves financial info of specific employee

The request includes the following:

### HEADERS

| name | **Required** | description | **Type** | **Example** | **default** | **Additional Notes** |
| --- | --- | --- | --- | --- | --- | --- |
| api-version | Yes | Supported API version s | Integer | 1 |  | currently supported is 1 only |
| Slug | Yes | Organization slug name | String | abcd |  |  |
| Access-Token | Yes | Used to allow an application to access an API it generated from Session API | String | eyJhbGciOiJIUzI1NiJ9.eyJvcmdhbml6YXRpb25faWRlbnRp<br>ZmllciI6OTAwMDAxNCwiYXBpX2tleV9pZCI6MSwic291cm<br>NlIjoib3Blbl9hcGkiLCJzb3VyY2VfaWQiOm51bGwsImlhd<br>CI6MTY5OTYwMjF4NiwiZXhwIjoxNzAyMTk0Njg2fQ.upSy<br>VVcRrBe2SNUvjnAlDq7NO-N_tenPnGF6zNs1KZU |  |  |
| source | No | the source type of Open Api | String | open_api | open_api | Supported values:  <br>\- open_api  <br>\- external_aggregator |
| username | Conditional:  <br>if the source type: external_aggregator | the name of the external service | String | workable |  |  |
```

--------------------------------

### API Success Response Example

Source: https://openapi.jisr.net/v1/jisr_be/public/openapis

This snippet shows a typical successful response from the API, including data and pagination information. It details the structure of punch data and how to navigate through paginated results.

```json
{
    "data": {
        "punches": [
            {
                "id": "unique_punch_id",
                "punch_time": "2023-10-27T10:00:00Z",
                "terminal_sn": "terminal_serial_number",
                "clocking_id": "clocking_identifier",
                "manual_balance_adjustment": null
            }
        ],
        "pagination": {
            "current_page": 1,
            "next_page": null,
            "previous_page": null,
            "total_pages": 1,
            "per_page": 50,
            "total_entries": 1
        }
    },
    "message": "Success",
    "status_code": 200
}
```

--------------------------------

### GET /openapi/v1/employees Request

Source: https://openapi.jisr.net/v1/jisr_be/public/openapis

Specifies the HTTP GET request for listing employees via the OpenAPI v1 endpoint. Includes tags and a summary for the operation.

```yaml
tags:
- Employees
summary: List
description: |-
  # **Reuqest**

  `GET /openapi/v1/employees`
```

--------------------------------

### Second Employee Record Example

Source: https://openapi.jisr.net/v1/jisr_be/public/openapis

This snippet details another employee's information, highlighting differences in job title, department, and employment status compared to the first record. It demonstrates the variability within employee data.

```YAML
- full_name_ar: Mohammed Ghassan Eljakhlab
  full_name_en: Mohammed Ghassan Eljakhlab
  gender: Male
  id: 9f96007c-e9f0-4e71-a720-c5385005d709
  is_active: false
  is_invited: true
  job_title:
    id: 14978
    name_ar: Product Manager
    name_en: Product Manager
  joining_date: '2011-01-01'
  last_active_time: 06 Sep 2021 12:11 PM
  line_manager:
    full_name: 
    guid: 
  location:
    id: 694
    name_ar: Olaya
    name_en: Olaya
  marital_status: Single
  nationality:
    id: 55
    name_ar: Egyptian
    name_en: Egyptian
  passport_number: ''
  status: inactive
  telephone: '539391878'
  terminate_date: '2022-02-27'
  working_experience_period: 12 Years - 11 Months - 12 Days
```

--------------------------------

### Retrieve Active Employees Basic Info

Source: https://openapi.jisr.net/v1/jisr_be/public/openapis

This snippet demonstrates how to call the API to get basic information for all active employees. It includes the necessary headers and query parameters for filtering and pagination.

```HTTP
GET /employees?id=bab6cd98-7246-4cfc-a576-19bc00391792&status=active HTTP/1.1
Host: api.jisr.net
api-version: 1
Slug: abcd
Access-Token: eyJhbGciOiJIUzI1NiJ9.eyJvcmdhbml6YXRpb25faWRlbnRpZmljYXRpb24iOjk
	MDAwMDE0LCJhcGlfa2V5X2lkIjoxLCJzb3VyY2UiOiJvcGVuX2FwaSIsInNvdXJjZV9pZCI6bnVsbCwianRpIjoxNjk5NjAyMTg2LCJleHAiOjE3MDIxOTQ2ODZ9.upSyVVcRrBe2SNUvjnAlDq7NO-N_tenPnGF6zNs1KZU

```

--------------------------------

### Employee Record Example

Source: https://openapi.jisr.net/v1/jisr_be/public/openapis

This snippet represents a single employee record, detailing their full name, job title, department, and employment status. It includes identifiers like ID and document number.

```YAML
- address:
  avatar:
  code: 72
  created_at: May 14, 2019
  delete_date:
  department:
    id: 10499
    name_ar: Service
    name_en: Service
  document_number: '2363725132'
  email: abcd_muk@outlook.com
  employment_type:
    id: 78
    name_ar: Ø¯ÙˆØ§Ù… ÙƒØ§Ù…Ù„
    name_en: Full Time
  full_name_ar: ÙŠÙˆÙ‚Ø´ ØªØ§Ù‚ÙˆØ±
  full_name_en: Yogesh Thakur
  gender: Male
  id: 8b6fb80c-6bfc-454b-a289-ad8cc7a6a155
  is_active: false
  is_invited: true
  job_title:
    id: 14983
    name_ar: Sr. QA Analyst
    name_en: Sr. QA Analyst
  joining_date: '2015-07-06'
  last_active_time: 06 Sep 2021 12:11 PM
  line_manager:
    full_name:
    guid:
```

--------------------------------

### Get Locations - OpenAPI Specification

Source: https://openapi.jisr.net/v1/jisr_be/public/openapis

This snippet details the GET request for retrieving locations from the JISR Net API. It specifies the required headers like 'slug', 'api-version', and 'Access-Token', along with optional query parameters for pagination ('page', 'rpp'). The response structure includes a success status, a message field, and a data object containing a list of locations with their IDs and addresses in both English and Arabic.

```json
{
  "/openapi/v1/lookups/locations": {
    "get": {
      "tags": [
        "Lookups"
      ],
      "summary": "Locations",
      "description": "# **Reuqest**\n`GET /openapi/v1/lookups/locations`\nThis API used to get all locations on organization\nThe request includes the following:\n### HEADERS\n| **Name** | **Description** |\n| --- | --- |\n| slug | Organization slug |\n| api-version | Supported version (1) |\n| Access-Token | Used to allow an application to access an API it generated from Session API |\n| source | open_api or external_aggregator |\n| username | This field needed if source is external_aggregator |\n#### Query Parameters\n| **Name** | **Description** |\n| --- | --- |\n| page | Current page to be shown |\n| rpp | **Record Per Page** represent the number of records per page |\n--- \n# Response\n- Success Response"
```

--------------------------------

### Employee Record Example

Source: https://openapi.jisr.net/v1/jisr_be/public/openapis

This snippet represents a single employee's record, showcasing various attributes like name, ID, job title, and employment status. It serves as a template for how employee data is structured.

```YAML
- full_name_ar: Younes Employee
  full_name_en: Younes Employee
  gender: Male
  id: e0173068-3793-407a-8ad3-7e42d41ff878
  is_active: false
  is_invited: true
  job_title:
    id: 15209
    name_ar: Pharmaceutical Lab Manager
    name_en: Pharmaceutical Lab Manager
  joining_date: '2021-12-08'
  last_active_time: 06 Sep 2021 12:11 PM
  line_manager:
    full_name: Yasser Mohammed
    guid: 1efd85e4-300a-4a61-873d-80e638be4f0a
  location:
    id: 6772
    name_ar: Al Nadweh
    name_en: Al Nadweh
  marital_status: Married
  nationality:
    id: 14
    name_ar: Bahraini
    name_en: Bahraini
  passport_number: o143318
  status: inactive
  telephone: ''
  terminate_date: '2022-12-14'
  working_experience_period: 2 Years - 5 Days
```

--------------------------------

### API Success Response Example

Source: https://openapi.jisr.net/v1/jisr_be/public/openapis

This snippet shows a typical successful response from the API, including the status, a message, and the data payload. It also indicates the HTTP status code.

```json
{
    "success": true,
    "message": null,
    "data": {
        "id": 1070400252,
        "name_en": "Salesman",
        "department": {
            "id": 10171,
            "name_en": "Central sales Dep",
            "name_ar": "Central sales Dep"
        },
        "employment_type": {
            "id": 78,
            "name_en": "Full Time",
            "name_ar": "Ø¯ÙˆØ§Ù… ÙƒØ§Ù…Ù„"
        },
        "location": {
            "id": 6589,
            "address_en": "CR- Deryah-1",
            "address_ar": "CR- Deryah-1"
        },
        "nationality": {
            "id": 161,
            "name_en": "Singaporean",
            "name_ar": "Ø³Ù†ØºØ§ÙÙˆØ±ÙŠ"
        },
        "document_number": "1070400252"
    },
    "Status_code": 200
}
```

--------------------------------

### Employee Data Structure Example

Source: https://openapi.jisr.net/v1/jisr_be/public/openapis

This snippet illustrates the structure of employee data within the OpenAPI JISR Net project. It includes personal details, employment information, and contact data, formatted as a JSON object.

```JSON
{
  "address": null,
  "avatar": null,
  "code": 6586328500461,
  "created_at": "October 3, 2022",
  "delete_date": null,
  "department": {
    "id": 347,
    "name_ar": "Ø£Ø¯Ø§Ø±Ù‡",
    "name_en": "Management"
  },
  "document_number": "01144919197",
  "email": "ahmed.shaalan@abcd.net",
  "employment_type": {
    "id": 78,
    "name_ar": "Ø¯ÙˆØ§Ù… ÙƒØ§Ù…Ù„",
    "name_en": "Full Time"
  },
  "full_name_ar": "ØÙ…Ø¯Ø¯",
  "full_name_en": "ahmed shaalan",
  "gender": null,
  "id": "c9219aee-8952-492e-afbf-0fbeead620af",
  "is_active": false,
  "is_invited": true,
  "job_title": {
    "id": 1833,
    "name_ar": "Ù…ØØ§Ø³Ø¨ ",
    "name_en": "Accountant"
  },
  "joining_date": "2022-10-03",
  "last_active_time": "18 Dec 2022 11:13 AM",
  "line_manager": {
    "full_name": null,
    "guid": null
  },
  "location": {
    "id": 12020,
    "name_ar": "Ø§Ù„ØØ±Ù…",
    "name_en": "Alharam"
  },
  "marital_status": null,
  "nationality": {
    "id": 55,
    "name_ar": "Ù…ØµØ±Ù‰",
    "name_en": "Egyptian"
  },
  "passport_number": null,
  "status": "inactive",
  "telephone": "",
  "terminate_date": "2022-10-10",
  "working_experience_period": "Year - 2 Months - 10 Days"
}
```

--------------------------------

### API Error Response Example

Source: https://openapi.jisr.net/v1/jisr_be/public/openapis

This snippet illustrates the structure of an error response from the API. It includes a success flag, an error message, and the corresponding status code, providing details about why a request might have failed.

```json
{
    "success": false,
    "error": "error message",
    "status_code": 400
}
```

--------------------------------

### Get Employment Types - OpenAPI

Source: https://openapi.jisr.net/v1/jisr_be/public/openapis

Retrieves a list of all employment types within an organization. Requires organization slug, API version, and access token in headers. Supports pagination via 'page' and 'rpp' query parameters.

```OpenAPI
openapi: 3.0.0
info:
  title: JISR Net API
  version: 1.0.0
paths:
  "/openapi/v1/lookups/employment_types":
    get:
      tags:
      - Lookups
      summary: Employment Types
      description: |- 
        This API is used to get all employment types on organization.

        **Request**
        `GET /openapi/v1/lookups/employment_types`

        ### HEADERS
        | Name | Description |
        | --- | --- |
        | slug | Organization slug |
        | api-version | Supported version (1) |
        | Access-Token | Used to allow an application to access an API it generated from Session API |
        | source | open_api or external_aggregator |
        | username | This field needed if source is external_aggregator |

        #### Query Parameters
        | Name | Description |
        | --- | --- |
        | page | Current page to be shown |
        | rpp | **Record Per Page** represent the number of records per page |

        # Response
        - Success Response
        ```json
        {
            "success": true,
            "message": null,
            "data": {
                "employment_types": [
                    {
                        "id": 104,
                        "name_en": "Ajeer",
                        "name_ar": "Ù…ÙˆØ¸Ù Ø£Ø¬ÙŠØ±"
                    },
                    {
                        "id": 7808,
                        "name_en": "Contractor",
                        "name_ar": "Ù…Ù‚Ø§ÙˆÙ„"
                    },
                    {
                        "id": 505,
                        "name_en": "Domestic Labor",
                        "name_ar": "Ø§Ù„Ø¹Ù…Ø§Ù„Ø© Ø§Ù„Ù…Ù†Ø²Ù„ÙŠØ©"
                    },
                    {
                        "id": 619,
                        "name_en": "FREE LANCER",
                        "name_ar": "Ù…Ø³ØªÙ‚Ù„"
                    },
                    {
                        "id": 78,
                        "name_en": "Full Time",
                        "name_ar": "Ø¯ÙˆØ§Ù… ÙƒØ§Ù…Ù„"
                    },
                    {
                        "id": 10700,
                        "name_en": "Outsourced",
                        "name_ar": "Ø£Ø¬ÙŠØ±"
                    },
                    {
                        "id": 79,
                        "name_en": "Part Time",
                        "name_ar": "Ø¯ÙˆØ§Ù… Ø¬Ø²Ø¦ÙŠ"
                    },
                    {
                        "id": 141,
                        "name_en": "Remote",
                        "name_ar": "Ù…ÙˆØ¸Ù Ø¹Ù† Ø¨Ø¹Ø¯"
                    },
                    {
                        "id": 7842,
                        "name_en": "Software Engineer",
                        "name_ar": "Ù…Ù‡Ù†Ø¯Ø³ Ø¨Ø±Ù…Ø¬ÙŠØ§Øª"
                    }
                ],
                "pagination": {
                    "current_page": 1,
                    "next_page": null,
                    "previous_page": null,
                    "total_pages": 1,
                    "per_page": 20,
                    "total_entries": 9
                }
            }
        }
        ```
      operationId: employmentTypes
      parameters:
      - name: page
        in: query
        schema:
          type: string
      - name: rpp
        in: query
        schema:
          type: string
      - name: slug
        in: header
        schema:
          type: string
      - name: api-version
        in: header
        schema:
          type: string
      - name: Access-Token
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Success Response By external aggregator

```

--------------------------------

### Get Outsourcing Companies API

Source: https://openapi.jisr.net/v1/jisr_be/public/openapis

Retrieves a list of all registered outsourcing companies. Requires organization slug, API version, and access token in headers. Supports pagination via query parameters.

```OpenAPI
{
    "openapi": "3.0.0",
    "info": {
        "title": "JISR Net API",
        "version": "1.0.0"
    },
    "paths": {
        "/openapi/v1/lookups/outsourcing_companies": {
            "get": {
                "tags": [
                    "Lookups"
                ],
                "summary": "Outsourcing Companies",
                "description": "This API used to get all Outsourcing Companies that on registered organization",
                "parameters": [
                    {
                        "name": "slug",
                        "in": "header",
                        "description": "Organization slug",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "api-version",
                        "in": "header",
                        "description": "Supported version (1)",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "Access-Token",
                        "in": "header",
                        "description": "Used to allow an application to access an API it generated from Session API",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "source",
                        "in": "header",
                        "description": "open_api or external_aggregator",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "username",
                        "in": "header",
                        "description": "This field needed if source is external_aggregator",
                        "required": false,
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "page",
                        "in": "query",
                        "description": "Current page to be shown",
                        "required": false,
                        "schema": {
                            "type": "integer"
                        }
                    },
                    {
                        "name": "rpp",
                        "in": "query",
                        "description": "Record Per Page represent the number of records per page",
                        "required": false,
                        "schema": {
                            "type": "integer"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success Response",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "success": {
                                            "type": "boolean",
                                            "example": true
                                        },
                                        "message": {
                                            "type": "object",
                                            "nullable": true,
                                            "example": null
                                        },
                                        "data": {
                                            "type": "object",
                                            "properties": {
                                                "outsourcing_companies": {
                                                    "type": "array",
                                                    "items": {
                                                        "type": "object",
                                                        "properties": {
                                                            "id": {
                                                                "type": "number",
                                                                "example": 1
                                                            },
                                                            "name_en": {
                                                                "type": "string",
                                                                "example": "Outsourcing Provider 1"
                                                            },
                                                            "name_ar": {
                                                                "type": "string",
                                                                "example": "Outsourcing Provider 1"
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```

--------------------------------

### Get Departments List

Source: https://openapi.jisr.net/v1/jisr_be/public/openapis

Retrieves a list of all departments within an organization. Requires organization slug, API version, access token, source, and optionally a username. Supports pagination via 'page' and 'rpp' query parameters.

```json
{
  "success": true,
  "message": null,
  "data": {
    "departments": [
      {
        "id": 65961,
        "name_en": "Testing MQ",
        "name_ar": "testing MQ"
      },
      {
        "id": 65962,
        "name_en": "Testing MQ 1",
        "name_ar": "Testing MQ 2"
      },
      {
        "id": 65956,
        "name_en": "test1aaa",
        "name_ar": "test1aaa"
      },
      {
        "id": 65957,
        "name_en": "HRsubsub",
        "name_ar": "HRsubsub"
      },
      {
        "id": 46910,
        "name_en": "Higher ManagementHigher Management",
        "name_ar": "Ø§Ù„Ø¥Ø¯Ø§Ø±Ø© Ø§Ù„Ø¹Ù„ÙŠØ§"
      },
      {
        "id": 49566,
        "name_en": "main department Parent parent parent",
        "name_ar": "Ø§Ù„Ù‚Ø³Ù… Ø§Ù„Ø±Ø¦ÙŠØ³ÙŠ"
      },
      {
        "id": 48515,
        "name_en": "Sample Parent",
        "name_ar": "Ù†Ù…ÙˆØ°Ø¬ Ø§Ù„Ø¨Ø§Ø±Ù†Øª Ø¯ÙŠØ¨Ø§Ø±ØªÙ…Ù†Øª"
      },
      {
        "id": 80256,
        "name_en": "ssa",
        "name_ar": "Ø´Ø³Ø³Ø´"
      },
      {
        "id": 80258,
        "name_en": "assasa",
        "name_ar": "Ø´Ø³Ø³Ø´Ø³"
      },
      {
        "id": 80257,
        "name_en": "Ø³Ø´Ø´",
        "name_ar": "Ø´Ø´"
      },
      {
        "id": 66456,
        "name_en": "fdsdaf",
        "name_ar": "sadfasdf"
      },
      {
        "id": 80383,
        "name_en": "testÙ¢Ù¢Ù¢Ù¡",
        "name_ar": "ØªÙŠØ³Øª"
      },
      {
        "id": 72284,
        "name_en": "Test_Department",
        "name_ar": "ØªÙŠØ³Øª_Ù‚Ø³Ù…"
      },
      {
        "id": 77116,
        "name_en": "Maice Zekry",
        "name_ar": "Ù…ÙŠØ³ Ø°ÙƒØ±ÙŠ"
      },
      {
        "id": 77214,
        "name_en": "Admin & Facility",
        "name_ar": "Ø§Ù„Ù…Ù†Ø´Ø§Øª"
      },
      {
        "id": 77436,
        "name_en": "fgh"
      }
    ],
    "example": 1,
    "next_page": null,
    "previous_page": null,
    "total_pages": 1,
    "per_page": 100,
    "total_entries": 6
  }
}
```

--------------------------------

### OpenAPI Schema for Employee Data

Source: https://openapi.jisr.net/v1/jisr_be/public/openapis

This snippet defines the OpenAPI schema for employee data, specifying types, examples, and required fields for various employee attributes. It includes details like name, email, department, and employment status.

```OpenAPI
marital_status:
  type: string
  example: Single
required: false
responses:
  '200':
    description: Success Response By external aggregator
    content:
      application/json:
        schema:
          type: object
          properties:
            data:
              type: object
              properties:
                employee:
                  type: object
                  properties:
                    address:
                      type: object
                      nullable: true
                      example: 'null'
                    avatar:
                      type: string
                      example: https://abcd-public.s3.me-south-1.amazonaws.com/images/employee.png
                    code:
                      type: number
                      example: 65458232
                    created_at:
                      type: string
                      example: August 30, 2023
                    department:
                      type: object
                      properties:
                        id:
                          type: number
                          example: 10467
                        name_ar:
                          type: string
                          example: accountant
                        name_en:
                          type: string
                          example: accountant
                    document_number:
                      type: string
                      example: '32584167917'
                    email:
                      type: string
                      example: test@abcd.net
                    employment_type:
                      type: object
                      properties:
                        id:
                          type: number
                          example: 104
                        name_ar:
                          type: string
                          example: Ù…ÙˆØ¸Ù Ø£Ø¬ÙŠØ±
                        name_en:
                          type: string
                          example: Ajeer
                    full_name_ar:
                      type: string
                      example: Ø³Ø§Ù„Ù… Ø¥Ø¨Ø±Ø§Ù‡ÙŠÙ… Ø£ØÙ…Ø¯
                    full_name_en:
                      type: string
                      example: Ibraheem Ahemd Salim
                    gender:
                      type: string
                      example: Male
                    id:
                      type: object
                      nullable: true
                      example: 'null'
                    is_active:
                      type: boolean
                      example: true
                    is_invited:
                      type: boolean
                      example: true
                    job_title:
                      type: object
                      nullable: true
                      example: 'null'
                    joining_date:
                      type: string
                      example: '2023-12-12'
                    last_active_time:
                      type: string
                      example: The employee has never logged in to his account
                    line_manager:
                      type: object
                      nullable: true
                      example: 'null'
                    location:
                      type: object
                      properties:
                        address_ar:
                          type: string
                          example: Ø§Ù„Ø¨Ù‚ÙŠØ¹
                        address_en:
                          type: string
                          example: Al Baqeaa
                        id:
                          type: number
                          example: 872
                    marital_status:
                      type: string
                      example: Single
                    nationality:
                      type: object
                      properties:
                        id:
                          type: number
                          example: 4
                        name_ar:
                          type: string
                          example: " Ø£Ù…Ø±ÙŠÙƒÙŠ"
                        name_en:
                          type: string
```

--------------------------------

### List Attendance Logs (GET /openapi/v1/attendance_logs)

Source: https://openapi.jisr.net/v1/jisr_be/public/openapis

Retrieves the status of punches (failed or success) using the GET method. Requires specific headers and supports various query parameters for filtering and pagination. The response includes punch details and pagination information.

```OpenAPI
paths:
  /openapi/v1/attendance_logs:
    get:
      tags:
      - Attendance Log
      summary: List
      description: |-
        # **Reuqest**

        `GET /openapi/v1/attendance_logs`

        This API endpoint retrieves the status of punches whether it's failed or success .

        The request includes the following:

        ### HEADERS

        | name | **Required** | description | **Type** | **Example** | **default** | **Additional Notes** |
        | --- | --- | --- | --- | --- | --- | --- |
        | api-version | Yes | Supported API version s | Integer | 1 |  | currently supported is 1 only |
        | Slug | Yes | Organization slug name | String | abcd |  |  |
        | Access-Token | Yes | Used to allow an application to access an API it generated from Session API | String | eyJhbGciOiJIUzI1NiJ9.eyJvcmdhbml6YXRpb25faWRlbnRp<br>ZmllciI6OTAwMDAxNCwiYXBpX2tleV9pZCI6MSwic291cm<br>NlIjoib3Blbl9hcGkiLCJzb3VyY2VfaWQiOm51bGwsImlhd<br>CI6MTY5OTYwMjF4NiwiZXhwIjoxNzAyMTk0Njg2fQ.upSy<br>VVcRrBe2SNUvjnAlDq7NO-N_tenPnGF6zNs1KZU |  |  |
        | source | No | the source type of Open Api | String | open_api | open_api | Supported values:  <br>\- open_api  <br>\- external_aggregator |
        | username | Conditional:  <br>if the source type: external_aggregator | the name of the external service | String | workable |  |  |

        #### Query Parameters

        | **name** | **Required** | **Description** | **Type** | **Example** | **Default** | **Additional Notes** |
        | --- | --- | --- | --- | --- | --- | --- |
        | status | Yes | Specifies the type of punches to be retrieved | String | success |  | Currently support only success or failed |
        | limit | No | controll the limit of the shown result per page | Integer | 50 | 100 | Minimum: 1  <br>Maximum: 100 |
        | page | No | choose the required page | Integer | 5 | 1 |  |
        | from | No | choose the start date time | DateTime | 2023-1-1 11:30:00 | 1 hour ago |  |
        | to | No | choose the end date time | DateTime | 2023-10-1 12:30:00 | Current time |  |

        ---

        # Response

        - Success Response

        The success response of the API represented as the following:

        ```
            {
                "success": true,
                "message": null,
                "data": {
                    "punches": [
                        {
                            "id": 360257,
                            "punch_time": "2023-11-01T00:00:00.000Z",
                            "employee_code": 199,
                            "terminal_sn": null,
                            "clocking_id": 5467897
                        }
                    ],
                    "pagination": {
                        "current_page": 1,
                        "next_page": null,
                        "previous_page": null,
                        "total_pages": 1,
                        "per_page": 50,
                        "total_entries": 1
                    }
                }
            }

         ```

            This contain the following:

            | **key** | **Description** | **value** |
            | --- | --- | --- |
            | success | represent the status of the API response | true |
      
```

--------------------------------

### Create Webhook Subscription Request

Source: https://openapi.jisr.net/v1/jisr_be/public/openapis

Defines the structure for creating a webhook subscription. It includes fields for the subscription's name, description, the endpoint URL for receiving events, its status, optional custom headers, and authentication details.

```json
{
  "name": "Subscription to Example Webhook",
  "description": "This subscription receives updates on example events.",
  "endpoint": "https://example.com/webhook",
  "status": "active",
  "custom_header": {
    "X-Custom-Header": "Value"
  },
  "authentication": {
    "type": "Bearer",
    "add_position": "header",
    "data": {
      "token": "your-auth-token"
    }
  }
}
```

--------------------------------

### Jisr API Server Endpoints

Source: https://openapi.jisr.net/index

Provides the base URLs for accessing the Jisr API, differentiating between AWS-hosted and locally-hosted instances.

```text
AWS endpoint URL ==> https://api.jisr.net
local endpoint URL ==> https://api.jisr.net.sa/api/
```

--------------------------------

### Get Webhooks

Source: https://openapi.jisr.net/v1/jisr_be/public/openapis

Retrieves all registered webhooks. Requires 'slug', 'api-version', and 'Access-Token' in the headers.

```json
{
    "openapi": "3.0.0",
    "paths": {
        "/openapi/v1/webhooks": {
            "get": {
                "tags": [
                    "Webhooks"
                ],
                "summary": "Webhooks",
                "description": "Get all webhooks",
                "operationId": "webhooks",
                "parameters": [
                    {
                        "name": "slug",
                        "in": "header",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "api-version",
                        "in": "header",
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "Access-Token",
                        "in": "header",
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success Response",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "success": {
                                            "type": "boolean"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```

--------------------------------

### Jisr OpenAPI Version and Specification

Source: https://openapi.jisr.net/index

This snippet indicates the version of the Jisr OpenAPI and its specification format.

```text
1.0.0
OAS 3.0
```
Tokens:
Raw