Download OpenAPI specification:Download
This document provides a comprehensive reference guide for the RMS Services API. The RMS Services API is a set of RESTful endpoints that allow developers to programmatically interact with RMS Services. This document includes detailed descriptions of each available endpoint, as well as the parameters, methods, and data structures used by the API.
Copyright: © Keture 2023. All rights reserved. This API reference is provided solely for the purpose of development and testing. Any commercial use or redistribution of this API, or any part thereof, is strictly prohibited without the prior written consent of Keture.
| v1 required | string Default: "v1" |
| name required | string |
| description | string |
{- "name": "Full-time",
- "description": "A full-time permanent job."
}{- "id": 123,
- "name": "Full-time",
- "description": "A full-time permanent job."
}| v1 required | string Default: "v1" |
| id required | integer |
| name required | string |
| description | string |
{- "id": 123,
- "name": "Part-time",
- "description": "A part-time temporary job."
}{- "id": 123,
- "name": "Part-time",
- "description": "A part-time temporary job."
}| v1 required | string Default: "v1" |
| id required | integer |
{- "id": 123
}{- "message": "Job type with id 123 was deleted successfully"
}| v1 required | string Default: "v1" |
| name required | string |
| description | string |
{- "name": "Remote",
- "description": "Ability to work remotely."
}{- "id": 123,
- "name": "Remote",
- "description": "Ability to work remotely."
}| v1 required | string Default: "v1" |
| id required | integer |
| name required | string |
| description | string |
{- "id": 123,
- "name": "Hybrid",
- "description": "Combination of office and remote work."
}{- "id": 123,
- "name": "Hybrid",
- "description": "Combination of office and remote work."
}| v1 required | string Default: "v1" |
| id required | integer |
{- "id": "123"
}{- "message": "Work style with id 123 was deleted successfully"
}| v1 required | string Default: "v1" |
| name required | string |
| description | string |
{- "name": "Entry",
- "description": "Beginner or junior level job."
}{- "id": 123,
- "name": "Entry",
- "description": "Beginner or junior level job."
}| v1 required | string Default: "v1" |
| id required | integer |
| name required | string |
| description | string |
{- "id": 123,
- "name": "Mid",
- "description": "Intermediate level job."
}{- "id": 123,
- "name": "Mid",
- "description": "Intermediate level job."
}| v1 required | string Default: "v1" |
| id required | integer |
{- "id": 123
}{- "message": "Job level with id 123 was deleted successfully"
}| v1 required | string Default: "v1" |
| refresh_token required | string |
{- "refresh_token": "string"
}{- "message": "Logged out successfully"
}| v1 required | string Default: "v1" |
| email required | string |
| password required | string |
{- "email": "admin@example.com",
- "password": "password123"
}{- "accessToken": "string",
- "refreshToken": "string"
}| v1 required | string Default: "v1" |
| email required | string |
| password required | string |
| first_name | string |
| last_name | string |
| phone_number | string |
{- "email": "john@email.com",
- "password": "password123",
- "first_name": "John",
- "last_name": "Doe",
- "phone_number": "1234567890"
}{- "message": "Registration successful"
}| v1 required | string Default: "v1" |
| email required | string |
| password required | string |
{- "email": "john@email.com",
- "password": "password123"
}{- "accessToken": "string",
- "refreshToken": "string"
}| v1 required | string Default: "v1" |
| refresh_token required | string |
{- "refresh_token": "string"
}{- "access_token": "string",
- "refresh_token": "string"
}| v1 required | string Default: "v1" |
| refresh_token required | string |
{- "refresh_token": "string"
}{- "message": "Logged out successfully"
}| v1 required | string Default: "v1" |
| email required | string |
| password required | string |
{- "email": "admin@example.com",
- "password": "password123"
}{- "accessToken": "string",
- "refreshToken": "string"
}| v1 required | string Default: "v1" |
| start required | number |
| end required | number |
{- "start": 0,
- "end": 10
}[- {
- "id": 123,
- "candidateName": "John Doe"
}, - {
- "id": 456,
- "candidateName": "Jane Doe"
}
]| v1 required | string Default: "v1" |
| fullName required | string |
| email required | string |
| phone required | string |
| linkedIn_url required | string |
| resume_file required | string |
| candidate_id | string |
{- "fullName": "John Doe",
- "email": "john@email.com",
- "phone": "1234567890",
- "linkedIn_url": "linkedin.com/john",
- "resume_file": "resume.pdf",
- "candidate_id": "abc123"
}{- "message": "Application submitted successfully"
}| v1 required | string Default: "v1" |
| email required | string |
| password required | string |
| first_name | string |
| last_name | string |
| phone_number | string |
{- "email": "john@email.com",
- "password": "password123",
- "first_name": "John",
- "last_name": "Doe",
- "phone_number": "1234567890"
}{- "message": "Registration successful"
}| v1 required | string Default: "v1" |
| email required | string |
| password required | string |
{- "email": "john@email.com",
- "password": "password123"
}{- "accessToken": "string",
- "refreshToken": "string"
}| v1 required | string Default: "v1" |
| refresh_token required | string |
{- "refresh_token": "string"
}{- "access_token": "string",
- "refresh_token": "string"
}| v1 required | string Default: "v1" |
| start required | number |
| end required | number |
{- "start": 0,
- "end": 10
}[- {
- "id": 123,
- "title": "Software Engineer"
}, - {
- "id": 456,
- "title": "Product Manager"
}
]{- "page": 1,
- "limit": 10,
- "totalPages": 1,
- "totalCount": 10,
- "data": [
- {
- "name": "Miththiran Inc",
- "address": null,
- "organization_categories": {
- "name": "Software company"
}, - "_count": {
- "job_openings": 1
}
}
]
}{- "departments": {
- "id": 1,
- "name": "Finance",
- "created_at": "2023-07-27T16:13:57.535Z",
- "updated_at": "2023-07-27T16:13:57.535Z",
- "deleted_at": null,
- "image_url": null
}, - "_count": {
- "job_openings": 1
}
}{- "name": "Miththiran Inc",
- "logo_url": null,
- "address": null,
- "organization_categories": {
- "id": 1,
- "name": "Software company",
- "description": "This organization is dedicated to creating software products for a variety of applications, including business, entertainment, and education.",
- "created_at": "2023-07-27T16:13:57.128Z",
- "updated_at": "2023-07-27T16:13:57.128Z",
- "deleted_at": null
}, - "_count": {
- "job_openings": 1
}
}| v1 required | string Default: "v1" |
| organization_name required | string |
| organization_email required | string |
| organization_category_id required | integer |
| first_name required | string |
| last_name required | string |
| email required | string |
| password required | string |
| phone_number required | string |
{- "organization_name": "Acme Inc",
- "organization_email": "contact@acme.com",
- "organization_category_id": 123,
- "first_name": "John",
- "last_name": "Doe",
- "email": "john@acme.com",
- "password": "password123",
- "phone_number": "1234567890"
}{- "message": "Registered successfully"
}| v1 required | string Default: "v1" |
| email required | string |
| password required | string |
{- "email": "john@acme.com",
- "password": "password123"
}{- "accessToken": "string",
- "refreshToken": "string"
}| v1 required | string Default: "v1" |
| department_id required | integer |
| title required | string |
{- "department_id": 123,
- "title": "Software Engineer"
}{- "message": "Job added successfully"
}| v1 required | string Default: "v1" |
| id | integer |
| title required | string |
| department_id required | integer |
{- "department_id": 123,
- "title": "Software Engineer"
}{- "message": "Job added successfully"
}| v1 required | string Default: "v1" |
| cv required | string <binary> |
{- "cv": "file_contents_here"
}{- "message": "CV uploaded successfully"
}