{
  "opencollection": "1.0.0",
  "info": {
    "name": "Sage HR Documents Employee API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Employee",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List active employees in company",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://subdomain.sage.hr/api/employees",
            "params": [
              {
                "name": "page",
                "value": "2",
                "type": "query"
              },
              {
                "name": "team_history",
                "value": "true",
                "type": "query"
              },
              {
                "name": "employment_status_history",
                "value": "true",
                "type": "query"
              },
              {
                "name": "position_history",
                "value": "true",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "List active employees in company"
        },
        {
          "info": {
            "name": "Create new employee",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://subdomain.sage.hr/api/employees",
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "Create new employee"
        },
        {
          "info": {
            "name": "Single active employee in company",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://subdomain.sage.hr/api/employees/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Numeric ID of the user to get."
              },
              {
                "name": "team_history",
                "value": "true",
                "type": "query"
              },
              {
                "name": "employment_status_history",
                "value": "true",
                "type": "query"
              },
              {
                "name": "position_history",
                "value": "true",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Single active employee in company"
        },
        {
          "info": {
            "name": "Update Employee",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://subdomain.sage.hr/api/employees/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Numeric ID of the user to update."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update Employee"
        },
        {
          "info": {
            "name": "Employee custom fields",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://subdomain.sage.hr/api/employees/:id/custom-fields",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Numeric ID of the user to get."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Employee custom fields"
        },
        {
          "info": {
            "name": "Update custom field",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://subdomain.sage.hr/api/employees/:id/custom-fields/:custom_field_id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Employee identifier"
              },
              {
                "name": "custom_field_id",
                "value": "",
                "type": "path",
                "description": "Custom field identifier"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "Update employee custom field"
        },
        {
          "info": {
            "name": "Terminate employee",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://subdomain.sage.hr/api/employees/:id/terminations",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Numeric ID of the user"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Terminate employee"
        },
        {
          "info": {
            "name": "List terminated employees in company",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://subdomain.sage.hr/api/terminated-employees",
            "params": [
              {
                "name": "page",
                "value": "2",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "List terminated employees in company"
        },
        {
          "info": {
            "name": "Single terminated employee in company",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://subdomain.sage.hr/api/terminated-employees/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Numeric ID of the user to get."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Single terminated employee in company"
        },
        {
          "info": {
            "name": "Employee time off balances",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://subdomain.sage.hr/api/employees/:id/leave-management/balances",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Numeric ID of the user to get."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Employee time off balances"
        },
        {
          "info": {
            "name": "Employee compensations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://subdomain.sage.hr/api/employees/:id/compensations",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Numeric ID of the user to get."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Employee compensations"
        }
      ]
    }
  ],
  "bundled": true
}