HRMS API

Human resource management — employees, attendance, departments, shifts, leave, and performance.

AiInsights

AiInsights collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of AiInsights. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/ai-insights?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new AiInsight record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/ai-insights \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "AiInsight created successfully"
}

Attendance

Attendance collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of Attendance. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/attendance?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new Attendance record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/attendance \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "Attendance created successfully"
}

AttendanceBotCommands

AttendanceBotCommands collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of AttendanceBotCommands. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/attendance-bot-commands?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new AttendanceBotCommand record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/attendance-bot-commands \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "AttendanceBotCommand created successfully"
}

Contractors

Contractors collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of Contractors. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/contractors?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new Contractor record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/contractors \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "Contractor created successfully"
}

Departments

Departments collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of Departments. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/departments?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new Department record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/departments \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "Department created successfully"
}

Designations

Designations collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of Designations. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/designations?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new Designation record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/designations \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "Designation created successfully"
}

EmployeeAnalytics

EmployeeAnalytics collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of EmployeeAnalytics. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/employee-analytics?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new EmployeeAnalytic record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/employee-analytics \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "EmployeeAnalytic created successfully"
}

EmployeePerformanceMetrics

EmployeePerformanceMetrics collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of EmployeePerformanceMetrics. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/employee-performance-metrics?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new EmployeePerformanceMetric record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/employee-performance-metrics \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "EmployeePerformanceMetric created successfully"
}

EmployeeSkills

EmployeeSkills collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of EmployeeSkills. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/employee-skills?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new EmployeeSkill record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/employee-skills \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "EmployeeSkill created successfully"
}

EmploymentTypes

EmploymentTypes collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of EmploymentTypes. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/employment-types?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new EmploymentType record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/employment-types \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "EmploymentType created successfully"
}

Equipment

Equipment collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of Equipment. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/equipment?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new Equipment record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/equipment \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "Equipment created successfully"
}

Holidays

Holidays collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of Holidays. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/holidays?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new Holiday record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/holidays \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "Holiday created successfully"
}

KpiTemplates

KpiTemplates collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of KpiTemplates. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/kpi-templates?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new KpiTemplate record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/kpi-templates \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "KpiTemplate created successfully"
}

LeaveRequests

LeaveRequests collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of LeaveRequests. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/leave-requests?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new LeaveRequest record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/leave-requests \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "LeaveRequest created successfully"
}

Locations

Locations collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of Locations. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/locations?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new Location record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/locations \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "Location created successfully"
}

OkrTemplates

OkrTemplates collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of OkrTemplates. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/okr-templates?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new OkrTemplate record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/okr-templates \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "OkrTemplate created successfully"
}

PerformanceReviews

PerformanceReviews collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of PerformanceReviews. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/performance-reviews?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new PerformanceReview record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/performance-reviews \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "PerformanceReview created successfully"
}

Policies

Policies collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of Policies. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/policies?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new Policy record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/policies \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "Policy created successfully"
}

RecruitmentApprovalChains

RecruitmentApprovalChains collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of RecruitmentApprovalChains. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/recruitment-approval-chains?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new RecruitmentApprovalChain record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/recruitment-approval-chains \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "RecruitmentApprovalChain created successfully"
}

RecruitmentEmailTemplates

RecruitmentEmailTemplates collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of RecruitmentEmailTemplates. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/recruitment-email-templates?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new RecruitmentEmailTemplate record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/recruitment-email-templates \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "RecruitmentEmailTemplate created successfully"
}

RecruitmentJobTemplates

RecruitmentJobTemplates collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of RecruitmentJobTemplates. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/recruitment-job-templates?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new RecruitmentJobTemplate record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/recruitment-job-templates \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "RecruitmentJobTemplate created successfully"
}

RecruitmentNotificationSettings

RecruitmentNotificationSettings collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of RecruitmentNotificationSettings. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/recruitment-notification-settings?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new RecruitmentNotificationSetting record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/recruitment-notification-settings \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "RecruitmentNotificationSetting created successfully"
}

RecruitmentPipelineStages

RecruitmentPipelineStages collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of RecruitmentPipelineStages. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/recruitment-pipeline-stages?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new RecruitmentPipelineStage record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/recruitment-pipeline-stages \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "RecruitmentPipelineStage created successfully"
}

RecruitmentScorecards

RecruitmentScorecards collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of RecruitmentScorecards. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/recruitment-scorecards?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new RecruitmentScorecard record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/recruitment-scorecards \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "RecruitmentScorecard created successfully"
}

ReviewCycles

ReviewCycles collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of ReviewCycles. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/review-cycles?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new ReviewCycle record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/review-cycles \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "ReviewCycle created successfully"
}

RotationalSchedules

RotationalSchedules collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of RotationalSchedules. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/rotational-schedules?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new RotationalSchedule record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/rotational-schedules \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "RotationalSchedule created successfully"
}

ShiftAssignments

ShiftAssignments collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of ShiftAssignments. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/shift-assignments?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new ShiftAssignment record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/shift-assignments \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "ShiftAssignment created successfully"
}

ShiftChangeRequests

ShiftChangeRequests collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of ShiftChangeRequests. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/shift-change-requests?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new ShiftChangeRequest record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/shift-change-requests \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "ShiftChangeRequest created successfully"
}

Shifts

Shifts collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of Shifts. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/shifts?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new Shift record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/shifts \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "Shift created successfully"
}

Teams

Teams collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of Teams. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/teams?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new Team record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/teams \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "Team created successfully"
}

WorkSessions

WorkSessions collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of WorkSessions. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/work-sessions?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new WorkSession record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/work-sessions \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "WorkSession created successfully"
}

HRMS API

Human resource management — employees, attendance, departments, shifts, leave, and performance.

AiInsights

AiInsights collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of AiInsights. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/ai-insights?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new AiInsight record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/ai-insights \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "AiInsight created successfully"
}

Attendance

Attendance collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of Attendance. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/attendance?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new Attendance record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/attendance \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "Attendance created successfully"
}

AttendanceBotCommands

AttendanceBotCommands collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of AttendanceBotCommands. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/attendance-bot-commands?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new AttendanceBotCommand record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/attendance-bot-commands \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "AttendanceBotCommand created successfully"
}

Contractors

Contractors collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of Contractors. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/contractors?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new Contractor record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/contractors \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "Contractor created successfully"
}

Departments

Departments collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of Departments. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/departments?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new Department record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/departments \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "Department created successfully"
}

Designations

Designations collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of Designations. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/designations?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new Designation record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/designations \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "Designation created successfully"
}

EmployeeAnalytics

EmployeeAnalytics collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of EmployeeAnalytics. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/employee-analytics?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new EmployeeAnalytic record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/employee-analytics \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "EmployeeAnalytic created successfully"
}

EmployeePerformanceMetrics

EmployeePerformanceMetrics collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of EmployeePerformanceMetrics. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/employee-performance-metrics?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new EmployeePerformanceMetric record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/employee-performance-metrics \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "EmployeePerformanceMetric created successfully"
}

EmployeeSkills

EmployeeSkills collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of EmployeeSkills. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/employee-skills?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new EmployeeSkill record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/employee-skills \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "EmployeeSkill created successfully"
}

EmploymentTypes

EmploymentTypes collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of EmploymentTypes. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/employment-types?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new EmploymentType record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/employment-types \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "EmploymentType created successfully"
}

Equipment

Equipment collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of Equipment. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/equipment?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new Equipment record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/equipment \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "Equipment created successfully"
}

Holidays

Holidays collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of Holidays. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/holidays?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new Holiday record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/holidays \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "Holiday created successfully"
}

KpiTemplates

KpiTemplates collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of KpiTemplates. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/kpi-templates?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new KpiTemplate record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/kpi-templates \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "KpiTemplate created successfully"
}

LeaveRequests

LeaveRequests collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of LeaveRequests. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/leave-requests?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new LeaveRequest record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/leave-requests \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "LeaveRequest created successfully"
}

Locations

Locations collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of Locations. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/locations?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new Location record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/locations \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "Location created successfully"
}

OkrTemplates

OkrTemplates collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of OkrTemplates. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/okr-templates?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new OkrTemplate record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/okr-templates \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "OkrTemplate created successfully"
}

PerformanceReviews

PerformanceReviews collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of PerformanceReviews. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/performance-reviews?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new PerformanceReview record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/performance-reviews \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "PerformanceReview created successfully"
}

Policies

Policies collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of Policies. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/policies?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new Policy record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/policies \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "Policy created successfully"
}

RecruitmentApprovalChains

RecruitmentApprovalChains collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of RecruitmentApprovalChains. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/recruitment-approval-chains?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new RecruitmentApprovalChain record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/recruitment-approval-chains \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "RecruitmentApprovalChain created successfully"
}

RecruitmentEmailTemplates

RecruitmentEmailTemplates collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of RecruitmentEmailTemplates. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/recruitment-email-templates?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new RecruitmentEmailTemplate record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/recruitment-email-templates \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "RecruitmentEmailTemplate created successfully"
}

RecruitmentJobTemplates

RecruitmentJobTemplates collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of RecruitmentJobTemplates. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/recruitment-job-templates?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new RecruitmentJobTemplate record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/recruitment-job-templates \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "RecruitmentJobTemplate created successfully"
}

RecruitmentNotificationSettings

RecruitmentNotificationSettings collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of RecruitmentNotificationSettings. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/recruitment-notification-settings?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new RecruitmentNotificationSetting record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/recruitment-notification-settings \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "RecruitmentNotificationSetting created successfully"
}

RecruitmentPipelineStages

RecruitmentPipelineStages collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of RecruitmentPipelineStages. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/recruitment-pipeline-stages?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new RecruitmentPipelineStage record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/recruitment-pipeline-stages \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "RecruitmentPipelineStage created successfully"
}

RecruitmentScorecards

RecruitmentScorecards collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of RecruitmentScorecards. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/recruitment-scorecards?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new RecruitmentScorecard record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/recruitment-scorecards \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "RecruitmentScorecard created successfully"
}

ReviewCycles

ReviewCycles collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of ReviewCycles. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/review-cycles?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new ReviewCycle record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/review-cycles \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "ReviewCycle created successfully"
}

RotationalSchedules

RotationalSchedules collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of RotationalSchedules. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/rotational-schedules?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new RotationalSchedule record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/rotational-schedules \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "RotationalSchedule created successfully"
}

ShiftAssignments

ShiftAssignments collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of ShiftAssignments. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/shift-assignments?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new ShiftAssignment record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/shift-assignments \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "ShiftAssignment created successfully"
}

ShiftChangeRequests

ShiftChangeRequests collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of ShiftChangeRequests. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/shift-change-requests?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new ShiftChangeRequest record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/shift-change-requests \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "ShiftChangeRequest created successfully"
}

Shifts

Shifts collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of Shifts. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/shifts?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new Shift record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/shifts \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "Shift created successfully"
}

Teams

Teams collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of Teams. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/teams?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new Team record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/teams \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "Team created successfully"
}

WorkSessions

WorkSessions collection — standard CRUD operations. Filter with where[], paginate with page/limit, control depth for relations.

Returns a paginated list of WorkSessions. Supports filtering, sorting, and relationship depth.

Auth: Both

Query Parameters

Name	Type	Required	Description
page	number	optional	Page number (default: 1)
limit	number	optional	Results per page (default: 20, max: 100)
sort	string	optional	Sort field, prefix with - for desc (e.g. -createdAt)
where	object	optional	Filter object e.g. where[status][equals]=active
depth	number	optional	Relationship depth (default: 1)

Example Request

curl https://v2-api.amdital.com/api/work-sessions?limit=20&sort=-createdAt \
  -H "Authorization: Bearer <token>"

Example Response

{
  "docs": [
    {
      "id": "64a1b2c3d4e5f6789abc0001",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-01-15T10:00:00Z"
    }
  ],
  "totalDocs": 42,
  "limit": 20,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true,
  "hasPrevPage": false
}

Creates a new WorkSession record. Requires authenticated workspace context.

Auth: Both

Body / Path Parameters

Name	Type	Required	Description
workspace	string	required	Workspace ID (from JWT claims)

Example Request

curl -X POST https://v2-api.amdital.com/api/work-sessions \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"workspace":"ws_abc123"}'

Example Response

{
  "doc": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  },
  "message": "WorkSession created successfully"
}