- API GATEWAY(FOR FRONTEND)
- Onboarding
- Auth
- User
- Applicants
- Employer
- Industry Types
- employer types
- Company
- Contact Persons
- WebHooks
- Sponsorship
- Training Reports
- Employer update profilePUT
- Job Preference
- Career Levels
- Testimonials
- Disabilities
- System Roles
- Destroy userDELETE
- Get user by idGET
- Get user's profile completion percentageGET
- Activate By EmailPATCH
- Get User By EmailGET
- Get user by uuidGET
- Forgot passwordPOST
- Reset PasswordPUT
- Change PasswordPUT
- Upload avatar/logoPOST
- Permissions
- HR
- Skiils
- Admin
- Assessment
- Onboarding
- Create assessment
- Skills
- Coding Challenges
- Create
- Fetch All
- Fetch One
- Submit Challenge
- Update
- Remove
- Add programming language
- Fetch all programming languages
- Fetch programming language by id
- Fetch programming language by name
- RUN Code
- Invite applicants by email
- Get coding challenge details by encrypted value
- Get coding challenge results for challenge
- Get coding challenge results for user by id.
- Get user's result for a challenge.
- Coding challenges test cases results
- Api Keys
- Roles
- personality-test
- Retrieve All Categories
- Submit Personality Assessment Answers
- Retrieve User Assessment Results
- Retrieve User Assessment Score
- Retrieve Assessment Result by ID
- List All Questions with Pagination
- Retrieve Question by ID
- Create a New Question
- Update a Question
- Delete a Question
- Check if User has taken Assessment test
- Seed categories
- Get Reports
- Get detailed info for category by ID.
- Retrieve User Assessment Results by user Id
- soft-skills
- Get All Categories
- Submit Soft Skill Assessment Answers
- Get User's Assessment Results
- Get Assessment Result by ID
- Get User's Assessment Score
- Get All Questions with Pagination
- Get Question by ID
- Delete a Question
- Create a Question
- Update a Question
- Get Headings
- Check if User has taken Assessment test
- Seed Categories
- Get Reports
- Get User's Assessment Results by user id
- culture-fit-assessment
- Retrieve All Categories
- Submit Culture Fit Assessment Answers
- Retrieve User Assessment Results
- Retrieve User Assessment Score
- Retrieve Assessment Result By ID
- List All Questions With Pagination
- Retrieve Question by ID
- Create New Question
- Update a Question
- Delete a Question
- Check if User has taken assessment test
- Seed Categories
- Get Reports
- Retrieve User Assessment Results by User Id
- Seeders
- Comprehension Assessments
- Scenario Assessment
- Integrity Assessment
- Level One Questionaire
- comprehension assessment
- Recruitment
- cv-builder
- JobProjectPipelines
- Create a new job project pipeline
- Retrieves all job project pipelines for the authenticated employer.
- Get a specific job project pipeline
- Update a job project pipeline
- Get all employer-created projects
- Get applicants in a specific pipeline
- Search candidates
- Add applicants to a pipeline
- Remove applicants from a pipeline
- parkway-wallet
- LMS
- Worknation LMS
- Attendance system
- Admin KPI
- Partners
- AI/ML
- SUbscription Plan
- MSD
- Notifications
- Chat
- Internship
- support
- NYSC
- External
- TestingPOST
Fetch
Develop Env
http://localhost:3000/api/v1
Develop Env
http://localhost:3000/api/v1
GET
/companies
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************Query Params
Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'http://localhost:3000/api/v1/companies?page=1&limit=10' \
--header 'Authorization: Bearer <token>'Responses
🟢200Fetch
application/json
Bodyapplication/json
Example
{
"message": "Fetched successful",
"status": "Success",
"data": {
"meta": {
"total": 2,
"perPage": 10,
"currentPage": 1,
"lastPage": 1,
"firstPage": 1,
"firstPageUrl": "/?page=1",
"lastPageUrl": "/?page=1",
"nextPageUrl": null,
"previousPageUrl": null
},
"data": [
{
"id": 3,
"employerId": 1,
"userId": 8,
"industryTypeId": 1,
"name": "Awesome Company ",
"registrationNumber": "123456786",
"address": "123 Awesome Street, City, Country",
"website": "https://www.awesomecompany.com",
"createdAt": "2024-09-25T13:40:31.772+00:00",
"updatedAt": "2024-09-25T13:40:31.772+00:00",
"user": {
"id": 8,
"reference": "f6400b19-9ceb-49b0-a454-c26b3b642b3a",
"systemRoleId": 6,
"countryId": 1,
"email": "company2@example.com",
"phoneNumber": "+134567890",
"avatarUrl": null,
"avatarKey": null,
"status": "pending",
"twoFactorAuthEnabled": false,
"createdAt": "2024-09-25T13:40:31.770+00:00",
"updatedAt": "2024-09-25T13:40:31.770+00:00"
}
},
{
"id": 2,
"employerId": 1,
"userId": 7,
"industryTypeId": 1,
"name": "Awesome Company",
"registrationNumber": "12345678",
"address": "123 Awesome Street, City, Country",
"website": "https://www.awesomecompany.com",
"createdAt": "2024-09-25T13:40:02.485+00:00",
"updatedAt": "2024-09-25T13:40:02.485+00:00",
"user": {
"id": 7,
"reference": "f39ce6c6-e741-4e23-84e7-2684b4bef6ee",
"systemRoleId": 6,
"countryId": 1,
"email": "company@example.com",
"phoneNumber": "+1234567890",
"avatarUrl": null,
"avatarKey": null,
"status": "pending",
"twoFactorAuthEnabled": false,
"createdAt": "2024-09-25T13:40:02.475+00:00",
"updatedAt": "2024-09-25T13:40:02.475+00:00"
}
}
]
}
}Modified at 2024-10-14 16:29:25