Info

Welcome to the generated API reference. Get Postman Collection

Corporation

api/settings/corporation/view

Example request:

curl -X GET \
    -G "http://localhost:8000/api/settings/corporation/view" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/settings/corporation/view"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (401):

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/settings/corporation/view

Domain

api/settings/domain/view

Example request:

curl -X GET \
    -G "http://localhost:8000/api/settings/domain/view" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/settings/domain/view"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (401):

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/settings/domain/view

Job Code

api/settings/job-code/view

Example request:

curl -X GET \
    -G "http://localhost:8000/api/settings/job-code/view" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/settings/job-code/view"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (401):

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/settings/job-code/view

Password Management

APIs for managing password reset

Send a reset link to the given user.

Example request:

curl -X POST \
    "http://localhost:8000/api/password/email" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/password/email"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

POST api/password/email

Reset the given user's password.

Example request:

curl -X POST \
    "http://localhost:8000/api/password/reset" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/password/reset"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

POST api/password/reset

Store

api/settings/store/view

Example request:

curl -X GET \
    -G "http://localhost:8000/api/settings/store/view" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/settings/store/view"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (401):

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/settings/store/view

general

Display Swagger API page.

Example request:

curl -X GET \
    -G "http://localhost:8000/api/documentation" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/documentation"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

null

HTTP Request

GET api/documentation

Display Oauth2 callback pages.

Example request:

curl -X GET \
    -G "http://localhost:8000/api/oauth2-callback" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/oauth2-callback"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

null

HTTP Request

GET api/oauth2-callback

api/settings/domain/create

Example request:

curl -X POST \
    "http://localhost:8000/api/settings/domain/create" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/settings/domain/create"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

POST api/settings/domain/create

api/settings/domain/update/{id}

Example request:

curl -X PUT \
    "http://localhost:8000/api/settings/domain/update/1" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/settings/domain/update/1"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

PUT api/settings/domain/update/{id}

api/settings/domain/update/{id}

Example request:

curl -X PATCH \
    "http://localhost:8000/api/settings/domain/update/1" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/settings/domain/update/1"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

PATCH api/settings/domain/update/{id}

api/settings/domain/delete/{id}

Example request:

curl -X DELETE \
    "http://localhost:8000/api/settings/domain/delete/1" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/settings/domain/delete/1"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

DELETE api/settings/domain/delete/{id}

api/settings/job-code/create

Example request:

curl -X POST \
    "http://localhost:8000/api/settings/job-code/create" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/settings/job-code/create"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

POST api/settings/job-code/create

api/settings/job-code/update/{id}

Example request:

curl -X PUT \
    "http://localhost:8000/api/settings/job-code/update/1" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/settings/job-code/update/1"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

PUT api/settings/job-code/update/{id}

api/settings/job-code/update/{id}

Example request:

curl -X PATCH \
    "http://localhost:8000/api/settings/job-code/update/1" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/settings/job-code/update/1"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

PATCH api/settings/job-code/update/{id}

api/settings/job-code/delete/{id}

Example request:

curl -X DELETE \
    "http://localhost:8000/api/settings/job-code/delete/1" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/settings/job-code/delete/1"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

DELETE api/settings/job-code/delete/{id}

api/settings/corporation/create

Example request:

curl -X POST \
    "http://localhost:8000/api/settings/corporation/create" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/settings/corporation/create"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

POST api/settings/corporation/create

api/settings/corporation/update/{id}

Example request:

curl -X PUT \
    "http://localhost:8000/api/settings/corporation/update/1" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/settings/corporation/update/1"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

PUT api/settings/corporation/update/{id}

api/settings/corporation/update/{id}

Example request:

curl -X PATCH \
    "http://localhost:8000/api/settings/corporation/update/1" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/settings/corporation/update/1"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

PATCH api/settings/corporation/update/{id}

api/settings/corporation/delete/{id}

Example request:

curl -X DELETE \
    "http://localhost:8000/api/settings/corporation/delete/1" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/settings/corporation/delete/1"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

DELETE api/settings/corporation/delete/{id}

api/settings/store/create

Example request:

curl -X POST \
    "http://localhost:8000/api/settings/store/create" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/settings/store/create"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

POST api/settings/store/create

api/settings/store/update/{id}

Example request:

curl -X PUT \
    "http://localhost:8000/api/settings/store/update/1" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/settings/store/update/1"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

PUT api/settings/store/update/{id}

api/settings/store/update/{id}

Example request:

curl -X PATCH \
    "http://localhost:8000/api/settings/store/update/1" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/settings/store/update/1"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

PATCH api/settings/store/update/{id}

api/settings/store/delete/{id}

Example request:

curl -X DELETE \
    "http://localhost:8000/api/settings/store/delete/1" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/settings/store/delete/1"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

DELETE api/settings/store/delete/{id}

api/auth/login

Example request:

curl -X POST \
    "http://localhost:8000/api/auth/login" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/auth/login"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

POST api/auth/login

api/auth/admin/login

Example request:

curl -X POST \
    "http://localhost:8000/api/auth/admin/login" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/auth/admin/login"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

POST api/auth/admin/login

First Time Login

Example request:

curl -X POST \
    "http://localhost:8000/api/auth/first-login" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/auth/first-login"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

POST api/auth/first-login

api/auth/logout

Example request:

curl -X GET \
    -G "http://localhost:8000/api/auth/logout" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/auth/logout"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (401):

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/auth/logout

api/auth/user

Example request:

curl -X GET \
    -G "http://localhost:8000/api/auth/user" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/auth/user"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (401):

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/auth/user

Retrieve Employees

Requires authentication

Example request:

curl -X GET \
    -G "http://localhost:8000/api/employee/account" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/employee/account"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (401):

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/employee/account

Create Employee

Requires authentication

Example request:

curl -X POST \
    "http://localhost:8000/api/employee/account/create" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/employee/account/create"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

POST api/employee/account/create

Update Employee

Requires authentication

Example request:

curl -X POST \
    "http://localhost:8000/api/employee/account/update/1" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/employee/account/update/1"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

POST api/employee/account/update/{slug}

Get Employee

Requires authentication

Example request:

curl -X GET \
    -G "http://localhost:8000/api/employee/account/show/1" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/employee/account/show/1"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (401):

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/employee/account/show/{slug}

Update Employee

Requires authentication

Example request:

curl -X PATCH \
    "http://localhost:8000/api/employee/account/update/1" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/employee/account/update/1"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

PATCH api/employee/account/update/{slug}

Activate an Employee

Requires authentication

Example request:

curl -X PATCH \
    "http://localhost:8000/api/employee/account/activate/1" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/employee/account/activate/1"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

PATCH api/employee/account/activate/{slug}

Deactivate an Employee

Requires authentication

Example request:

curl -X PATCH \
    "http://localhost:8000/api/employee/account/deactivate/1" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/employee/account/deactivate/1"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

PATCH api/employee/account/deactivate/{slug}

api/employee/account/next-of-kin/{slug}

Example request:

curl -X POST \
    "http://localhost:8000/api/employee/account/next-of-kin/1" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/employee/account/next-of-kin/1"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

POST api/employee/account/next-of-kin/{slug}

api/employee/account/account-details/{slug}

Example request:

curl -X POST \
    "http://localhost:8000/api/employee/account/account-details/1" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/employee/account/account-details/1"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

POST api/employee/account/account-details/{slug}

api/employee/account/update-profile-pic/{slug}

Example request:

curl -X POST \
    "http://localhost:8000/api/employee/account/update-profile-pic/1" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

const url = new URL(
    "http://localhost:8000/api/employee/account/update-profile-pic/1"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

POST api/employee/account/update-profile-pic/{slug}