Introduction
This documentation aims to provide all the information you need to work with our API.
Authenticating requests
To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".
All authenticated endpoints are marked with a requires authentication badge in the documentation below.
Admin Dashboard
All other endpoints
Retrieve various metrics for the admin dashboard (Stability Score: 0.1)
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/dashboard" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/dashboard"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Crudy Endpoints
All Crudy endpoints
External employee field
Fetch a list of External employee fields with pagination (Stability Score: 0.5)
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/external-employee-fields?page=1&pageSize=15&withSoftDeletes=1&include=externalIntegration" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/external-employee-fields"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "externalIntegration",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of External employee fields based on the provided filters, scopes, sorting and pagination (Stability Score: 0.5)
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/external-employee-fields/search?page=1&pageSize=15&withSoftDeletes=1&include=externalIntegration" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"externalIntegrationId\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
],
\"scopes\": [
{
\"name\": \"unMapped\",
\"parameters\": []
},
{
\"name\": \"mapped\",
\"parameters\": []
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/external-employee-fields/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "externalIntegration",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "externalIntegrationId",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
],
"scopes": [
{
"name": "unMapped",
"parameters": []
},
{
"name": "mapped",
"parameters": []
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Notification preference
Create a new Notification preference
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/notification-preferences?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"preferences\": [
[
[
\"sms\"
]
]
],
\"organizationId\": \"sed\"
}"
const url = new URL(
"http://localhost:8000/api/v1/notification-preferences"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"preferences": [
[
[
"sms"
]
]
],
"organizationId": "sed"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch create new Notification preferences
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/notification-preferences/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"preferences\": [],
\"organizationId\": \"quidem\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/notification-preferences/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"preferences": [],
"organizationId": "quidem"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Notification preference by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/notification-preferences/dolor?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/notification-preferences/dolor"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "NotificationPreference [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch update Notification preferences
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/notification-preferences/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
const url = new URL(
"http://localhost:8000/api/v1/notification-preferences/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PATCH",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Notification preference by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/notification-preferences/rem?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"preferences\": [
[
[
\"email\"
]
]
]
}"
const url = new URL(
"http://localhost:8000/api/v1/notification-preferences/rem"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"preferences": [
[
[
"email"
]
]
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "NotificationPreference [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch delete Notification preferences by their IDs
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/notification-preferences/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
\"inventore\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/notification-preferences/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
"inventore"
]
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Notification preference by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/notification-preferences/corporis?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/notification-preferences/corporis"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "NotificationPreference [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Notification preferences with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/notification-preferences?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/notification-preferences"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Notification preferences based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/notification-preferences/search?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"organizationId\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/notification-preferences/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "organizationId",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Behaviour
Create a new Behaviour
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/behaviours?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"identifier\": \"omnis\",
\"name\": \"dolorem\",
\"description\": \"Accusantium possimus labore fugit modi.\"
}"
const url = new URL(
"http://localhost:8000/api/v1/behaviours"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"identifier": "omnis",
"name": "dolorem",
"description": "Accusantium possimus labore fugit modi."
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch create new Behaviours
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/behaviours/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"identifier\": \"voluptas\",
\"name\": \"autem\",
\"description\": \"Perspiciatis omnis aperiam vitae eum eaque excepturi modi.\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/behaviours/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"identifier": "voluptas",
"name": "autem",
"description": "Perspiciatis omnis aperiam vitae eum eaque excepturi modi."
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Behaviour by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/behaviours/et?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/behaviours/et"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "Behaviour [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch update Behaviours
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/behaviours/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"name\": \"aliquam\",
\"description\": \"Consequatur blanditiis laborum doloremque et eos dignissimos itaque.\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/behaviours/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"name": "aliquam",
"description": "Consequatur blanditiis laborum doloremque et eos dignissimos itaque."
}
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Behaviour by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/behaviours/natus?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"in\",
\"description\": \"Velit reprehenderit iste accusantium hic praesentium aut.\"
}"
const url = new URL(
"http://localhost:8000/api/v1/behaviours/natus"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "in",
"description": "Velit reprehenderit iste accusantium hic praesentium aut."
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "Behaviour [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch delete Behaviours by their IDs
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/behaviours/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
\"omnis\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/behaviours/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
"omnis"
]
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Behaviour by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/behaviours/cumque?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/behaviours/cumque"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "Behaviour [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Behaviours with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/behaviours?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/behaviours"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Behaviours based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/behaviours/search?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/behaviours/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Function entity
Create a new Function entity
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/function-entities?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"identifier\": \"cumque\",
\"name\": \"recusandae\",
\"description\": \"Sunt aliquid eum et ab ex.\",
\"companyId\": \"vero\",
\"organizationId\": \"repellendus\",
\"customerTypeId\": \"dolorem\"
}"
const url = new URL(
"http://localhost:8000/api/v1/function-entities"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"identifier": "cumque",
"name": "recusandae",
"description": "Sunt aliquid eum et ab ex.",
"companyId": "vero",
"organizationId": "repellendus",
"customerTypeId": "dolorem"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch create new Function entities
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/function-entities/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"identifier\": \"voluptas\",
\"name\": \"veritatis\",
\"description\": \"Nihil sint quasi eligendi facilis soluta dolor cumque.\",
\"companyId\": \"repellendus\",
\"organizationId\": \"ea\",
\"customerTypeId\": \"molestiae\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/function-entities/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"identifier": "voluptas",
"name": "veritatis",
"description": "Nihil sint quasi eligendi facilis soluta dolor cumque.",
"companyId": "repellendus",
"organizationId": "ea",
"customerTypeId": "molestiae"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Function entity by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/function-entities/id?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/function-entities/id"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "FunctionEntity [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch update Function entities
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/function-entities/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"name\": \"voluptatem\",
\"description\": \"Suscipit impedit fugit nemo consequatur expedita sint consectetur.\",
\"companyId\": \"voluptas\",
\"organizationId\": \"quia\",
\"customerTypeId\": \"blanditiis\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/function-entities/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"name": "voluptatem",
"description": "Suscipit impedit fugit nemo consequatur expedita sint consectetur.",
"companyId": "voluptas",
"organizationId": "quia",
"customerTypeId": "blanditiis"
}
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Function entity by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/function-entities/in?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"unde\",
\"description\": \"Nam fugiat cum esse facilis debitis.\",
\"companyId\": \"corrupti\",
\"organizationId\": \"magni\",
\"customerTypeId\": \"sit\"
}"
const url = new URL(
"http://localhost:8000/api/v1/function-entities/in"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "unde",
"description": "Nam fugiat cum esse facilis debitis.",
"companyId": "corrupti",
"organizationId": "magni",
"customerTypeId": "sit"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "FunctionEntity [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch delete Function entities by their IDs
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/function-entities/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
\"sed\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/function-entities/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
"sed"
]
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Function entity by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/function-entities/perspiciatis?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/function-entities/perspiciatis"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "FunctionEntity [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Function entities with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/function-entities?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/function-entities"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Function entities based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/function-entities/search?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"companyId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"organizationId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"identifier\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"name\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/function-entities/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "companyId",
"operator": "=",
"value": "value"
},
{
"field": "organizationId",
"operator": "=",
"value": "value"
},
{
"field": "identifier",
"operator": "=",
"value": "value"
},
{
"field": "name",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Customer type
Create a new Customer type
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/customer-types?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"identifier\": \"omnis\",
\"name\": \"nobis\",
\"description\": \"Dolores dolorem natus possimus expedita.\"
}"
const url = new URL(
"http://localhost:8000/api/v1/customer-types"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"identifier": "omnis",
"name": "nobis",
"description": "Dolores dolorem natus possimus expedita."
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch create new Customer types
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/customer-types/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"identifier\": \"animi\",
\"name\": \"et\",
\"description\": \"Ab inventore voluptatibus vero vitae enim earum.\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/customer-types/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"identifier": "animi",
"name": "et",
"description": "Ab inventore voluptatibus vero vitae enim earum."
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Customer type by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/customer-types/nam?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/customer-types/nam"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "CustomerType [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch update Customer types
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/customer-types/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"name\": \"quos\",
\"description\": \"Voluptas ipsum quia temporibus id voluptatem rem magni.\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/customer-types/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"name": "quos",
"description": "Voluptas ipsum quia temporibus id voluptatem rem magni."
}
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Customer type by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/customer-types/expedita?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"nostrum\",
\"description\": \"Eaque beatae aut est dignissimos minus.\"
}"
const url = new URL(
"http://localhost:8000/api/v1/customer-types/expedita"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "nostrum",
"description": "Eaque beatae aut est dignissimos minus."
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "CustomerType [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch delete Customer types by their IDs
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/customer-types/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
\"sequi\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/customer-types/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
"sequi"
]
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Customer type by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/customer-types/omnis?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/customer-types/omnis"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "CustomerType [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Customer types with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/customer-types?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/customer-types"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Customer types based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/customer-types/search?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/customer-types/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Team position
Create a new Team position
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/team-positions?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"id\",
\"description\": \"Vel sed eveniet quia quos incidunt aut.\",
\"organizationId\": \"omnis\"
}"
const url = new URL(
"http://localhost:8000/api/v1/team-positions"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "id",
"description": "Vel sed eveniet quia quos incidunt aut.",
"organizationId": "omnis"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch create new Team positions
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/team-positions/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"name\": \"error\",
\"description\": \"Cumque nostrum et et dolor.\",
\"organizationId\": \"magni\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/team-positions/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"name": "error",
"description": "Cumque nostrum et et dolor.",
"organizationId": "magni"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Team position by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/team-positions/qui?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/team-positions/qui"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "TeamPosition [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch update Team positions
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/team-positions/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"name\": \"exercitationem\",
\"description\": \"Veniam molestias deleniti natus nihil repudiandae quisquam nihil.\",
\"organizationId\": \"ducimus\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/team-positions/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"name": "exercitationem",
"description": "Veniam molestias deleniti natus nihil repudiandae quisquam nihil.",
"organizationId": "ducimus"
}
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Team position by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/team-positions/aliquid?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"ea\",
\"description\": \"Quis consequatur in ea.\",
\"organizationId\": \"porro\"
}"
const url = new URL(
"http://localhost:8000/api/v1/team-positions/aliquid"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "ea",
"description": "Quis consequatur in ea.",
"organizationId": "porro"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "TeamPosition [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch delete Team positions by their IDs
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/team-positions/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
\"accusantium\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/team-positions/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
"accusantium"
]
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Team position by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/team-positions/aut?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/team-positions/aut"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "TeamPosition [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Team positions with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/team-positions?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/team-positions"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Team positions based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/team-positions/search?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"name\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"organizationId\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/team-positions/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "name",
"operator": "=",
"value": "value"
},
{
"field": "organizationId",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Person
Fetch a Person by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/persons/voluptatum?include=companies%2Cemployees" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/persons/voluptatum"
);
const params = {
"include": "companies,employees",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "Person [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of People with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/persons?page=1&pageSize=15&withSoftDeletes=1&include=companies%2Cemployees" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/persons"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "companies,employees",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of People based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/persons/search?page=1&pageSize=15&withSoftDeletes=1&include=companies%2Cemployees" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"companyIds\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"identities\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
],
\"scopes\": [
{
\"name\": \"findBySsn\",
\"parameters\": []
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/persons/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "companies,employees",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "companyIds",
"operator": "=",
"value": "value"
},
{
"field": "identities",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
],
"scopes": [
{
"name": "findBySsn",
"parameters": []
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Country
Create a new Country
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/countries?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"veniam\"
}"
const url = new URL(
"http://localhost:8000/api/v1/countries"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "veniam"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch create new Countries
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/countries/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"name\": \"minima\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/countries/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"name": "minima"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Country by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/countries/officia?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/countries/officia"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "Country [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch update Countries
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/countries/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
const url = new URL(
"http://localhost:8000/api/v1/countries/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PATCH",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Country by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/countries/earum?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
const url = new URL(
"http://localhost:8000/api/v1/countries/earum"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PATCH",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "Country [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch delete Countries by their IDs
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/countries/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
\"neque\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/countries/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
"neque"
]
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Country by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/countries/consectetur?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/countries/consectetur"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "Country [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Countries with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/countries?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/countries"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Countries based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/countries/search?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/countries/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Export
Fetch a list of Exports with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/exports?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/exports"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Exports based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/exports/search?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"companyId\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/exports/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "companyId",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Ext role mapping
Create a new Ext role mapping (Stability Score: 0.1)
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/ext-role-mappings?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"companyId\": \"quas\",
\"roleId\": 21.7,
\"externalIntegrationRoleId\": \"ad\"
}"
const url = new URL(
"http://localhost:8000/api/v1/ext-role-mappings"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"companyId": "quas",
"roleId": 21.7,
"externalIntegrationRoleId": "ad"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Ext role mapping by its ID (Stability Score: 0.1)
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/ext-role-mappings/ut?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"roleId\": 412058.2998902,
\"externalIntegrationRoleId\": \"debitis\"
}"
const url = new URL(
"http://localhost:8000/api/v1/ext-role-mappings/ut"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"roleId": 412058.2998902,
"externalIntegrationRoleId": "debitis"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "ExtRoleMapping [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Ext role mapping by its ID (Stability Score: 0.1)
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/ext-role-mappings/excepturi?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/ext-role-mappings/excepturi"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "ExtRoleMapping [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Ext role mappings based on the provided filters, scopes, sorting and pagination (Stability Score: 0.1)
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/ext-role-mappings/search?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"companyId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"roleId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"externalIntegrationRoleId\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/ext-role-mappings/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "companyId",
"operator": "=",
"value": "value"
},
{
"field": "roleId",
"operator": "=",
"value": "value"
},
{
"field": "externalIntegrationRoleId",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Ext integration role
Fetch a Ext integration role by its ID (Stability Score: 0.1)
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/external-integration-roles/quibusdam?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/external-integration-roles/quibusdam"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "ExtIntegrationRole [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Ext integration roles with pagination (Stability Score: 0.1)
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/external-integration-roles?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/external-integration-roles"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Ext integration roles based on the provided filters, scopes, sorting and pagination (Stability Score: 0.1)
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/external-integration-roles/search?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"companyId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"externalIntegrationId\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/external-integration-roles/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "companyId",
"operator": "=",
"value": "value"
},
{
"field": "externalIntegrationId",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Team
Create a new Team
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/teams?include=manager%2Ccompanies%2Cparticipants%2Corganization" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"ykxcqmrpwopdequdn\",
\"organizationId\": \"et\",
\"description\": \"Dolores qui pariatur omnis sunt at.\",
\"teamType\": \"organization\",
\"companyId\": \"voluptatibus\",
\"companyIds\": [
\"cumque\"
],
\"memberIds\": [
\"sit\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/teams"
);
const params = {
"include": "manager,companies,participants,organization",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "ykxcqmrpwopdequdn",
"organizationId": "et",
"description": "Dolores qui pariatur omnis sunt at.",
"teamType": "organization",
"companyId": "voluptatibus",
"companyIds": [
"cumque"
],
"memberIds": [
"sit"
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch create new Teams
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/teams/batch?include=manager%2Ccompanies%2Cparticipants%2Corganization" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"name\": \"rzxadeeulgaylx\",
\"organizationId\": \"error\",
\"description\": \"Quibusdam et qui consequatur vitae.\",
\"teamType\": \"company\",
\"companyId\": \"ut\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/teams/batch"
);
const params = {
"include": "manager,companies,participants,organization",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"name": "rzxadeeulgaylx",
"organizationId": "error",
"description": "Quibusdam et qui consequatur vitae.",
"teamType": "company",
"companyId": "ut"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Team by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/teams/a?include=manager%2Ccompanies%2Cparticipants%2Corganization" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/teams/a"
);
const params = {
"include": "manager,companies,participants,organization",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "Team [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch update Teams
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/teams/batch?include=manager%2Ccompanies%2Cparticipants%2Corganization" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"name\": \"vydyhi\",
\"description\": \"Exercitationem sit non qui.\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/teams/batch"
);
const params = {
"include": "manager,companies,participants,organization",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"name": "vydyhi",
"description": "Exercitationem sit non qui."
}
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Team by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/teams/dicta?include=manager%2Ccompanies%2Cparticipants%2Corganization" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"tpzjpliymrepidlgbqmfemc\",
\"description\": \"Esse vero ut perferendis alias tenetur et inventore.\",
\"companyIds\": [
\"nihil\"
],
\"memberIds\": [
\"dolor\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/teams/dicta"
);
const params = {
"include": "manager,companies,participants,organization",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "tpzjpliymrepidlgbqmfemc",
"description": "Esse vero ut perferendis alias tenetur et inventore.",
"companyIds": [
"nihil"
],
"memberIds": [
"dolor"
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "Team [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch delete Teams by their IDs
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/teams/batch?include=manager%2Ccompanies%2Cparticipants%2Corganization" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
\"consequatur\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/teams/batch"
);
const params = {
"include": "manager,companies,participants,organization",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
"consequatur"
]
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Team by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/teams/ea?include=manager%2Ccompanies%2Cparticipants%2Corganization" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/teams/ea"
);
const params = {
"include": "manager,companies,participants,organization",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "Team [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Teams with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/teams?page=1&pageSize=15&withSoftDeletes=1&include=manager%2Ccompanies%2Cparticipants%2Corganization" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/teams"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "manager,companies,participants,organization",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Teams based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/teams/search?page=1&pageSize=15&withSoftDeletes=1&include=manager%2Ccompanies%2Cparticipants%2Corganization" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"name\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"description\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"managerId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"companyIds\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"organizationId\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/teams/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "manager,companies,participants,organization",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "name",
"operator": "=",
"value": "value"
},
{
"field": "description",
"operator": "=",
"value": "value"
},
{
"field": "managerId",
"operator": "=",
"value": "value"
},
{
"field": "companyIds",
"operator": "=",
"value": "value"
},
{
"field": "organizationId",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Company change history
Fetch a list of Company change histories with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/company-change-history?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/company-change-history"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Company field change
Fetch a Company field change by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/company-field-changes/est?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/company-field-changes/est"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "CompanyFieldChange [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Company field changes with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/company-field-changes?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/company-field-changes"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Company field changes based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/company-field-changes/search?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"changeId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"approved\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"status\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"comment\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"deniedNote\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"companyFieldId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"changeType\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"changedBy\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"changedDate\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"effectiveDate\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"fieldName\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"newValue\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"oldValue\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"exported\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"companyId\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/company-field-changes/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "changeId",
"operator": "=",
"value": "value"
},
{
"field": "approved",
"operator": "=",
"value": "value"
},
{
"field": "status",
"operator": "=",
"value": "value"
},
{
"field": "comment",
"operator": "=",
"value": "value"
},
{
"field": "deniedNote",
"operator": "=",
"value": "value"
},
{
"field": "companyFieldId",
"operator": "=",
"value": "value"
},
{
"field": "changeType",
"operator": "=",
"value": "value"
},
{
"field": "changedBy",
"operator": "=",
"value": "value"
},
{
"field": "changedDate",
"operator": "=",
"value": "value"
},
{
"field": "effectiveDate",
"operator": "=",
"value": "value"
},
{
"field": "fieldName",
"operator": "=",
"value": "value"
},
{
"field": "newValue",
"operator": "=",
"value": "value"
},
{
"field": "oldValue",
"operator": "=",
"value": "value"
},
{
"field": "exported",
"operator": "=",
"value": "value"
},
{
"field": "companyId",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Grid view
Create a new Grid view
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/grid-views?include=grid%2Cactors" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"gridId\": \"neque\",
\"viewName\": \"dolorem\",
\"viewDescription\": \"quo\",
\"viewSettings\": [],
\"userId\": 6
}"
const url = new URL(
"http://localhost:8000/api/v1/grid-views"
);
const params = {
"include": "grid,actors",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"gridId": "neque",
"viewName": "dolorem",
"viewDescription": "quo",
"viewSettings": [],
"userId": 6
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Grid view by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/grid-views/quo?include=grid%2Cactors" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/grid-views/quo"
);
const params = {
"include": "grid,actors",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "GridView [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Grid view by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/grid-views/quia?include=grid%2Cactors" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"gridId\": \"optio\",
\"viewName\": \"magnam\",
\"viewDescription\": \"ducimus\",
\"userId\": 15
}"
const url = new URL(
"http://localhost:8000/api/v1/grid-views/quia"
);
const params = {
"include": "grid,actors",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"gridId": "optio",
"viewName": "magnam",
"viewDescription": "ducimus",
"userId": 15
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "GridView [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Grid view by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/grid-views/eum?include=grid%2Cactors" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/grid-views/eum"
);
const params = {
"include": "grid,actors",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "GridView [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Grid views with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/grid-views?page=1&pageSize=15&withSoftDeletes=1&include=grid%2Cactors" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/grid-views"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "grid,actors",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Grid views based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/grid-views/search?page=1&pageSize=15&withSoftDeletes=1&include=grid%2Cactors" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"viewName\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"gridId\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/grid-views/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "grid,actors",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "viewName",
"operator": "=",
"value": "value"
},
{
"field": "gridId",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Grid configuration
Create a new Grid configuration
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/grid-configurations?include=grid%2Cuser" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"gridId\": \"consectetur\",
\"userId\": \"et\",
\"gridTitle\": \"et\",
\"gridDescription\": \"reiciendis\",
\"gridSettings\": []
}"
const url = new URL(
"http://localhost:8000/api/v1/grid-configurations"
);
const params = {
"include": "grid,user",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"gridId": "consectetur",
"userId": "et",
"gridTitle": "et",
"gridDescription": "reiciendis",
"gridSettings": []
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch create new Grid configurations
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/grid-configurations/batch?include=grid%2Cuser" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"gridId\": \"aut\",
\"userId\": \"unde\",
\"gridTitle\": \"nesciunt\",
\"gridDescription\": \"corrupti\",
\"gridSettings\": []
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/grid-configurations/batch"
);
const params = {
"include": "grid,user",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"gridId": "aut",
"userId": "unde",
"gridTitle": "nesciunt",
"gridDescription": "corrupti",
"gridSettings": []
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Grid configuration by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/grid-configurations/et?include=grid%2Cuser" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/grid-configurations/et"
);
const params = {
"include": "grid,user",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "GridConfiguration [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch update Grid configurations
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/grid-configurations/batch?include=grid%2Cuser" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"gridTitle\": \"et\",
\"gridDescription\": \"odio\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/grid-configurations/batch"
);
const params = {
"include": "grid,user",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"gridTitle": "et",
"gridDescription": "odio"
}
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Grid configuration by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/grid-configurations/velit?include=grid%2Cuser" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"gridTitle\": \"ipsam\",
\"gridDescription\": \"impedit\"
}"
const url = new URL(
"http://localhost:8000/api/v1/grid-configurations/velit"
);
const params = {
"include": "grid,user",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"gridTitle": "ipsam",
"gridDescription": "impedit"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "GridConfiguration [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch delete Grid configurations by their IDs
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/grid-configurations/batch?include=grid%2Cuser" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
\"ut\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/grid-configurations/batch"
);
const params = {
"include": "grid,user",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
"ut"
]
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Grid configuration by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/grid-configurations/velit?include=grid%2Cuser" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/grid-configurations/velit"
);
const params = {
"include": "grid,user",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "GridConfiguration [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Grid configurations with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/grid-configurations?page=1&pageSize=15&withSoftDeletes=1&include=grid%2Cuser" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/grid-configurations"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "grid,user",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Grid configurations based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/grid-configurations/search?page=1&pageSize=15&withSoftDeletes=1&include=grid%2Cuser" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/grid-configurations/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "grid,user",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Ui grid
Batch create new Ui grids
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/ui-grids/batch?include=views%2Ccompany%2Cactors" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"gridTitle\": \"dolorem\",
\"gridDescription\": \"perspiciatis\",
\"gridSettings\": {
\"gridFor\": \"numquam\"
},
\"companyId\": \"ipsam\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/ui-grids/batch"
);
const params = {
"include": "views,company,actors",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"gridTitle": "dolorem",
"gridDescription": "perspiciatis",
"gridSettings": {
"gridFor": "numquam"
},
"companyId": "ipsam"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Ui grid by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/ui-grids/ab?include=views%2Ccompany%2Cactors" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/ui-grids/ab"
);
const params = {
"include": "views,company,actors",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "UiGrid [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch update Ui grids
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/ui-grids/batch?include=views%2Ccompany%2Cactors" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"gridTitle\": \"ut\",
\"gridDescription\": \"ut\",
\"gridSettings\": {
\"gridFor\": \"consectetur\"
},
\"companyId\": \"optio\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/ui-grids/batch"
);
const params = {
"include": "views,company,actors",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"gridTitle": "ut",
"gridDescription": "ut",
"gridSettings": {
"gridFor": "consectetur"
},
"companyId": "optio"
}
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Ui grid by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/ui-grids/odio?include=views%2Ccompany%2Cactors" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"gridTitle\": \"itaque\",
\"gridDescription\": \"aut\",
\"gridSettings\": {
\"gridFor\": \"nesciunt\"
},
\"companyId\": \"corrupti\"
}"
const url = new URL(
"http://localhost:8000/api/v1/ui-grids/odio"
);
const params = {
"include": "views,company,actors",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"gridTitle": "itaque",
"gridDescription": "aut",
"gridSettings": {
"gridFor": "nesciunt"
},
"companyId": "corrupti"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "UiGrid [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch delete Ui grids by their IDs
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/ui-grids/batch?include=views%2Ccompany%2Cactors" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
\"voluptatem\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/ui-grids/batch"
);
const params = {
"include": "views,company,actors",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
"voluptatem"
]
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Ui grid by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/ui-grids/dolorem?include=views%2Ccompany%2Cactors" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/ui-grids/dolorem"
);
const params = {
"include": "views,company,actors",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "UiGrid [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Ui grids with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/ui-grids?page=1&pageSize=15&withSoftDeletes=1&include=views%2Ccompany%2Cactors" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/ui-grids"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "views,company,actors",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Ui grids based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/ui-grids/search?page=1&pageSize=15&withSoftDeletes=1&include=views%2Ccompany%2Cactors" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"gridTitle\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"companyId\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/ui-grids/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "views,company,actors",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "gridTitle",
"operator": "=",
"value": "value"
},
{
"field": "companyId",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create a new Ui grid
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/ui-grids?include=views%2Ccompany%2Cactors" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"gridTitle\": \"ea\",
\"gridDescription\": \"eum\",
\"gridSettings\": {
\"gridFor\": \"placeat\"
},
\"companyId\": \"ea\"
}"
const url = new URL(
"http://localhost:8000/api/v1/ui-grids"
);
const params = {
"include": "views,company,actors",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"gridTitle": "ea",
"gridDescription": "eum",
"gridSettings": {
"gridFor": "placeat"
},
"companyId": "ea"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Ui grids with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/companies/atque/ui-grids?page=1&pageSize=15&withSoftDeletes=1&include=views%2Ccompany%2Cactors" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/companies/atque/ui-grids"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "views,company,actors",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Ui grid by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/companies/earum/ui-grids/odio?include=views%2Ccompany%2Cactors" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/companies/earum/ui-grids/odio"
);
const params = {
"include": "views,company,actors",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "UiGrid [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Ui grid by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/companies/beatae/ui-grids/aut?include=views%2Ccompany%2Cactors" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"gridTitle\": \"quis\",
\"gridDescription\": \"tempore\",
\"gridSettings\": {
\"gridFor\": \"dolores\"
},
\"companyId\": \"molestiae\"
}"
const url = new URL(
"http://localhost:8000/api/v1/companies/beatae/ui-grids/aut"
);
const params = {
"include": "views,company,actors",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"gridTitle": "quis",
"gridDescription": "tempore",
"gridSettings": {
"gridFor": "dolores"
},
"companyId": "molestiae"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "UiGrid [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Ui grid by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/companies/et/ui-grids/ut?include=views%2Ccompany%2Cactors" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/companies/et/ui-grids/ut"
);
const params = {
"include": "views,company,actors",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "UiGrid [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Salary warning
Fetch a Salary warning by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/salary-warnings/ipsam?include=employee%2CsalaryRule" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/salary-warnings/ipsam"
);
const params = {
"include": "employee,salaryRule",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "SalaryWarning [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Salary warnings with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/salary-warnings?page=1&pageSize=15&withSoftDeletes=1&include=employee%2CsalaryRule" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/salary-warnings"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "employee,salaryRule",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Salary warnings based on the provided filters, scopes, sorting and pagination (Stability Score: 0.5)
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/salary-warnings/search?page=1&pageSize=15&withSoftDeletes=1&include=employee%2CsalaryRule" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"confirmedBy\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"salaryRuleId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"employeeId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"salaryPeriod\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/salary-warnings/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "employee,salaryRule",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "confirmedBy",
"operator": "=",
"value": "value"
},
{
"field": "salaryRuleId",
"operator": "=",
"value": "value"
},
{
"field": "employeeId",
"operator": "=",
"value": "value"
},
{
"field": "salaryPeriod",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Company integration
Create a new Company integration
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/company-integrations?include=externalIntegration" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"externalIntegrationId\": \"fugit\",
\"companyId\": \"vero\"
}"
const url = new URL(
"http://localhost:8000/api/v1/company-integrations"
);
const params = {
"include": "externalIntegration",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"externalIntegrationId": "fugit",
"companyId": "vero"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch create new Company integrations
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/company-integrations/batch?include=externalIntegration" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"externalIntegrationId\": \"aperiam\",
\"companyId\": \"non\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/company-integrations/batch"
);
const params = {
"include": "externalIntegration",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"externalIntegrationId": "aperiam",
"companyId": "non"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Company integration by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/company-integrations/saepe?include=externalIntegration" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/company-integrations/saepe"
);
const params = {
"include": "externalIntegration",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "CompanyIntegration [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch update Company integrations
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/company-integrations/batch?include=externalIntegration" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
const url = new URL(
"http://localhost:8000/api/v1/company-integrations/batch"
);
const params = {
"include": "externalIntegration",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PATCH",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Company integration by its ID (Stability Score: 0.5)
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/company-integrations/quam?include=externalIntegration" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
const url = new URL(
"http://localhost:8000/api/v1/company-integrations/quam"
);
const params = {
"include": "externalIntegration",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PATCH",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "CompanyIntegration [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch delete Company integrations by their IDs
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/company-integrations/batch?include=externalIntegration" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
\"cum\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/company-integrations/batch"
);
const params = {
"include": "externalIntegration",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
"cum"
]
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Company integration by its ID (Stability Score: 0.5)
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/company-integrations/voluptas?include=externalIntegration" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/company-integrations/voluptas"
);
const params = {
"include": "externalIntegration",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "CompanyIntegration [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Company integrations with pagination (Stability Score: 0.5)
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/company-integrations?page=1&pageSize=15&withSoftDeletes=1&include=externalIntegration" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/company-integrations"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "externalIntegration",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Company integrations based on the provided filters, scopes, sorting and pagination (Stability Score: 0.5)
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/company-integrations/search?page=1&pageSize=15&withSoftDeletes=1&include=externalIntegration" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"externalIntegrationId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"companyId\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/company-integrations/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "externalIntegration",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "externalIntegrationId",
"operator": "=",
"value": "value"
},
{
"field": "companyId",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Integration type
Fetch a list of Integration types with pagination (Stability Score: 0.5)
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/integration-types?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/integration-types"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Integration types based on the provided filters, scopes, sorting and pagination (Stability Score: 0.5)
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/integration-types/search?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"name\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/integration-types/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "name",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.User
Fetch a User by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/users/1?include=teams" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/users/1"
);
const params = {
"include": "teams",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "User [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Users with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/users?page=1&pageSize=15&withSoftDeletes=1&include=teams" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/users"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "teams",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Users based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/users/search?page=1&pageSize=15&withSoftDeletes=1&include=teams" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"name\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"email\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"userId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"pgUserId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"user_id\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"organizationIds\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/users/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "teams",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "name",
"operator": "=",
"value": "value"
},
{
"field": "email",
"operator": "=",
"value": "value"
},
{
"field": "userId",
"operator": "=",
"value": "value"
},
{
"field": "pgUserId",
"operator": "=",
"value": "value"
},
{
"field": "user_id",
"operator": "=",
"value": "value"
},
{
"field": "organizationIds",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Notification
Fetch a list of Notifications with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/notifications?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/notifications"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Notifications based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/notifications/search?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"readAt\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"createdAt\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"data\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"data.settings.type\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"data.settings.level\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/notifications/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "readAt",
"operator": "=",
"value": "value"
},
{
"field": "createdAt",
"operator": "=",
"value": "value"
},
{
"field": "data",
"operator": "=",
"value": "value"
},
{
"field": "data.settings.type",
"operator": "=",
"value": "value"
},
{
"field": "data.settings.level",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Employee field
Create a new Employee field
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/employee-fields?include=combinedFields" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"isShow\": true,
\"isMandatory\": false,
\"salarySensitive\": false,
\"sensitive\": false,
\"allowNewValue\": true,
\"observe\": false,
\"importExcluded\": true,
\"manualInput\": true,
\"fieldType\": \"textarea\",
\"dataType\": \"date\",
\"maxInput\": 77929.9,
\"minInput\": 38,
\"maxLength\": 3948279.0496,
\"minLength\": 0,
\"fieldName\": \"ouzmfexms\",
\"combinedFieldIds\": [
\"dolor\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/employee-fields"
);
const params = {
"include": "combinedFields",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"isShow": true,
"isMandatory": false,
"salarySensitive": false,
"sensitive": false,
"allowNewValue": true,
"observe": false,
"importExcluded": true,
"manualInput": true,
"fieldType": "textarea",
"dataType": "date",
"maxInput": 77929.9,
"minInput": 38,
"maxLength": 3948279.0496,
"minLength": 0,
"fieldName": "ouzmfexms",
"combinedFieldIds": [
"dolor"
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Employee field by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/employee-fields/aperiam?include=combinedFields" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/employee-fields/aperiam"
);
const params = {
"include": "combinedFields",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "EmployeeField [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Employee field by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/employee-fields/laborum?include=combinedFields" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"isShow\": false,
\"isMandatory\": false,
\"salarySensitive\": true,
\"sensitive\": false,
\"allowNewValue\": false,
\"observe\": true,
\"importExcluded\": false,
\"manualInput\": true,
\"fieldType\": \"number\",
\"dataType\": \"decimal\",
\"maxInput\": 3136.39758984,
\"minInput\": 6.49888436,
\"maxLength\": 5082.070454,
\"minLength\": 3.319063,
\"combinedFieldIds\": [
\"blanditiis\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/employee-fields/laborum"
);
const params = {
"include": "combinedFields",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"isShow": false,
"isMandatory": false,
"salarySensitive": true,
"sensitive": false,
"allowNewValue": false,
"observe": true,
"importExcluded": false,
"manualInput": true,
"fieldType": "number",
"dataType": "decimal",
"maxInput": 3136.39758984,
"minInput": 6.49888436,
"maxLength": 5082.070454,
"minLength": 3.319063,
"combinedFieldIds": [
"blanditiis"
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "EmployeeField [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Employee field by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/employee-fields/dignissimos?include=combinedFields" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/employee-fields/dignissimos"
);
const params = {
"include": "combinedFields",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "EmployeeField [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Employee fields with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/employee-fields?page=1&pageSize=15&withSoftDeletes=1&include=combinedFields" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/employee-fields"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "combinedFields",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Company field
Create a new Company field
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/company-fields?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"fieldName\": \"ex\",
\"autoApproveOnImport\": false
}"
const url = new URL(
"http://localhost:8000/api/v1/company-fields"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"fieldName": "ex",
"autoApproveOnImport": false
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch create new Company fields
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/company-fields/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"fieldName\": \"et\",
\"autoApproveOnImport\": false
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/company-fields/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"fieldName": "et",
"autoApproveOnImport": false
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Company field by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/company-fields/quam?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/company-fields/quam"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "CompanyField [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch update Company fields
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/company-fields/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"autoApproveOnImport\": true
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/company-fields/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"autoApproveOnImport": true
}
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Company field by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/company-fields/perspiciatis?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"autoApproveOnImport\": true
}"
const url = new URL(
"http://localhost:8000/api/v1/company-fields/perspiciatis"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"autoApproveOnImport": true
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "CompanyField [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch delete Company fields by their IDs
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/company-fields/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
\"sapiente\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/company-fields/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
"sapiente"
]
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Company field by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/company-fields/labore?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/company-fields/labore"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "CompanyField [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Company fields with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/company-fields?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/company-fields"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Company fields based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/company-fields/search?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"fieldName\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/company-fields/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "fieldName",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Log entity
Fetch a list of Log entities with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/log-entities?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/log-entities"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Log entities based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/log-entities/search?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"entity\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"entityId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"action\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"createdBy\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"createdAt\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/log-entities/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "entity",
"operator": "=",
"value": "value"
},
{
"field": "entityId",
"operator": "=",
"value": "value"
},
{
"field": "action",
"operator": "=",
"value": "value"
},
{
"field": "createdBy",
"operator": "=",
"value": "value"
},
{
"field": "createdAt",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Variable type
Create a new Variable type
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/variable-types?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"description\": \"Fugiat animi alias officiis.\"
}"
const url = new URL(
"http://localhost:8000/api/v1/variable-types"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"description": "Fugiat animi alias officiis."
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch create new Variable types
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/variable-types/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"description\": \"Officia quis qui sint sed rerum facere.\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/variable-types/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"description": "Officia quis qui sint sed rerum facere."
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Variable type by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/variable-types/repellendus?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/variable-types/repellendus"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "VariableType [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch update Variable types
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/variable-types/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"description\": \"Rem quae et sapiente ex saepe.\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/variable-types/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"description": "Rem quae et sapiente ex saepe."
}
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Variable type by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/variable-types/omnis?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"description\": \"Nesciunt pariatur quod vero fuga.\"
}"
const url = new URL(
"http://localhost:8000/api/v1/variable-types/omnis"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"description": "Nesciunt pariatur quod vero fuga."
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "VariableType [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch delete Variable types by their IDs
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/variable-types/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
\"autem\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/variable-types/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
"autem"
]
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Variable type by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/variable-types/non?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/variable-types/non"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "VariableType [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Variable types with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/variable-types?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/variable-types"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Variable types based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/variable-types/search?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"description\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/variable-types/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "description",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Salary rule
Create a new Salary rule
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/salary-rules?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"companyId\": \"necessitatibus\",
\"warning\": \"ad\",
\"solutionDescription\": \"qui\",
\"ruleExpression\": [
{
\"type\": \"logical\",
\"payCodeIds\": [
4
],
\"previous_periods\": 1,
\"diff_type\": \"real\"
}
],
\"selections\": [
{
\"employeeFieldId\": \"tenetur\",
\"operator\": \"!=\",
\"value\": \"quo\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/salary-rules"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"companyId": "necessitatibus",
"warning": "ad",
"solutionDescription": "qui",
"ruleExpression": [
{
"type": "logical",
"payCodeIds": [
4
],
"previous_periods": 1,
"diff_type": "real"
}
],
"selections": [
{
"employeeFieldId": "tenetur",
"operator": "!=",
"value": "quo"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Salary rule by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/salary-rules/sit?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/salary-rules/sit"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "SalaryRule [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Salary rule by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/salary-rules/ut?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"warning\": \"illo\",
\"solutionDescription\": \"cumque\",
\"ruleExpression\": [
{
\"type\": \"logical_missing\",
\"payCodeIds\": [
\"sapiente\"
],
\"previous_periods\": 1,
\"diff_type\": \"real\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/salary-rules/ut"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"warning": "illo",
"solutionDescription": "cumque",
"ruleExpression": [
{
"type": "logical_missing",
"payCodeIds": [
"sapiente"
],
"previous_periods": 1,
"diff_type": "real"
}
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "SalaryRule [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Salary rule by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/salary-rules/voluptas?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/salary-rules/voluptas"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "SalaryRule [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Salary rules with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/salary-rules?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/salary-rules"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Salary rules based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/salary-rules/search?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/salary-rules/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Org integrations mapping
Create a new Org integrations mapping
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/org-integrations-mappings?include=externalIntegration%2Corganization" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"externalIntegrationId\": \"suscipit\",
\"organizationId\": \"sed\",
\"notes\": \"autem\",
\"status\": \"active\"
}"
const url = new URL(
"http://localhost:8000/api/v1/org-integrations-mappings"
);
const params = {
"include": "externalIntegration,organization",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"externalIntegrationId": "suscipit",
"organizationId": "sed",
"notes": "autem",
"status": "active"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch create new Org integrations mappings
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/org-integrations-mappings/batch?include=externalIntegration%2Corganization" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"externalIntegrationId\": \"eos\",
\"organizationId\": \"hic\",
\"notes\": \"cumque\",
\"status\": \"active\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/org-integrations-mappings/batch"
);
const params = {
"include": "externalIntegration,organization",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"externalIntegrationId": "eos",
"organizationId": "hic",
"notes": "cumque",
"status": "active"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Org integrations mapping by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/org-integrations-mappings/qui?include=externalIntegration%2Corganization" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/org-integrations-mappings/qui"
);
const params = {
"include": "externalIntegration,organization",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch update Org integrations mappings
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/org-integrations-mappings/batch?include=externalIntegration%2Corganization" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"notes\": \"occaecati\",
\"status\": \"inactive\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/org-integrations-mappings/batch"
);
const params = {
"include": "externalIntegration,organization",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"notes": "occaecati",
"status": "inactive"
}
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Org integrations mapping by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/org-integrations-mappings/et?include=externalIntegration%2Corganization" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"notes\": \"sed\",
\"status\": \"active\"
}"
const url = new URL(
"http://localhost:8000/api/v1/org-integrations-mappings/et"
);
const params = {
"include": "externalIntegration,organization",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"notes": "sed",
"status": "active"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch delete Org integrations mappings by their IDs
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/org-integrations-mappings/batch?include=externalIntegration%2Corganization" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
\"voluptatem\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/org-integrations-mappings/batch"
);
const params = {
"include": "externalIntegration,organization",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
"voluptatem"
]
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Org integrations mapping by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/org-integrations-mappings/quod?include=externalIntegration%2Corganization" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/org-integrations-mappings/quod"
);
const params = {
"include": "externalIntegration,organization",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Org integrations mappings with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/org-integrations-mappings?page=1&pageSize=15&withSoftDeletes=1&include=externalIntegration%2Corganization" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/org-integrations-mappings"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "externalIntegration,organization",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Org integrations mappings based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/org-integrations-mappings/search?page=1&pageSize=15&withSoftDeletes=1&include=externalIntegration%2Corganization" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"externalIntegrationId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"organizationId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"status\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/org-integrations-mappings/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "externalIntegration,organization",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "externalIntegrationId",
"operator": "=",
"value": "value"
},
{
"field": "organizationId",
"operator": "=",
"value": "value"
},
{
"field": "status",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Field value matrix
Create a new Field value matrix
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/field-value-matrices?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"quibusdam\",
\"description\": \"Est sit libero quia veritatis.\",
\"keyFieldId\": \"recusandae\",
\"fieldIds\": [
\"at\"
],
\"companyId\": \"iusto\",
\"matrixFields\": [
{
\"keyFieldValue\": \"non\",
\"fields\": [
{
\"fieldValue\": \"animi\",
\"fieldId\": \"molestiae\"
}
]
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/field-value-matrices"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "quibusdam",
"description": "Est sit libero quia veritatis.",
"keyFieldId": "recusandae",
"fieldIds": [
"at"
],
"companyId": "iusto",
"matrixFields": [
{
"keyFieldValue": "non",
"fields": [
{
"fieldValue": "animi",
"fieldId": "molestiae"
}
]
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Field value matrix by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/field-value-matrices/quibusdam?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/field-value-matrices/quibusdam"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "FieldValueMatrix [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Field value matrix by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/field-value-matrices/est?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"blanditiis\",
\"description\": \"Et et amet ut dolores.\",
\"keyFieldId\": \"sed\",
\"fieldIds\": [
\"quisquam\"
],
\"matrixFields\": [
{
\"keyFieldValue\": \"est\",
\"fields\": [
{
\"fieldValue\": \"nisi\",
\"fieldId\": \"suscipit\"
}
]
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/field-value-matrices/est"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "blanditiis",
"description": "Et et amet ut dolores.",
"keyFieldId": "sed",
"fieldIds": [
"quisquam"
],
"matrixFields": [
{
"keyFieldValue": "est",
"fields": [
{
"fieldValue": "nisi",
"fieldId": "suscipit"
}
]
}
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "FieldValueMatrix [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Field value matrix by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/field-value-matrices/ut?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/field-value-matrices/ut"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "FieldValueMatrix [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Field value matrices with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/field-value-matrices?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/field-value-matrices"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Field value matrices based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/field-value-matrices/search?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"name\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"description\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"keyFieldValue\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"keyFieldId\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/field-value-matrices/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "name",
"operator": "=",
"value": "value"
},
{
"field": "description",
"operator": "=",
"value": "value"
},
{
"field": "keyFieldValue",
"operator": "=",
"value": "value"
},
{
"field": "keyFieldId",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Organization
Create a new Organization
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/organizations?include=companies" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"mollitia\",
\"orgNumber\": \"quibusdam\"
}"
const url = new URL(
"http://localhost:8000/api/v1/organizations"
);
const params = {
"include": "companies",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "mollitia",
"orgNumber": "quibusdam"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch create new Organizations
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/organizations/batch?include=companies" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"name\": \"vel\",
\"orgNumber\": \"qui\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/organizations/batch"
);
const params = {
"include": "companies",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"name": "vel",
"orgNumber": "qui"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Organization by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/organizations/totam?include=companies" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/organizations/totam"
);
const params = {
"include": "companies",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "Organization [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch update Organizations
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/organizations/batch?include=companies" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"name\": \"error\",
\"orgNumber\": \"aliquid\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/organizations/batch"
);
const params = {
"include": "companies",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"name": "error",
"orgNumber": "aliquid"
}
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Organization by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/organizations/porro?include=companies" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"fugit\",
\"orgNumber\": \"ipsum\"
}"
const url = new URL(
"http://localhost:8000/api/v1/organizations/porro"
);
const params = {
"include": "companies",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "fugit",
"orgNumber": "ipsum"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "Organization [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch delete Organizations by their IDs
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/organizations/batch?include=companies" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
\"consequatur\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/organizations/batch"
);
const params = {
"include": "companies",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
"consequatur"
]
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Organization by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/organizations/architecto?include=companies" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/organizations/architecto"
);
const params = {
"include": "companies",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "Organization [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Organizations with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/organizations?page=1&pageSize=15&withSoftDeletes=1&include=companies" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/organizations"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "companies",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Organizations based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/organizations/search?page=1&pageSize=15&withSoftDeletes=1&include=companies" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"name\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"orgNumber\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/organizations/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "companies",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "name",
"operator": "=",
"value": "value"
},
{
"field": "orgNumber",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Menu
Create a new Menu
requires authentication
Batch create new Menus
requires authentication
Fetch a Menu by its ID
requires authentication
Batch update Menus
requires authentication
Update a Menu by its ID
requires authentication
Batch delete Menus by their IDs
requires authentication
Delete a Menu by its ID
requires authentication
Fetch a list of Menus with pagination
requires authentication
Fetch a list of Menus based on the provided filters, scopes, sorting and pagination
requires authentication
Company field map
Create a new Company field map
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/company-field-maps?include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"externalCompanyFieldId\": \"suscipit\",
\"companyFieldId\": \"impedit\",
\"companyId\": \"aut\",
\"externalIntegrationId\": \"quia\"
}"
const url = new URL(
"http://localhost:8000/api/v1/company-field-maps"
);
const params = {
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"externalCompanyFieldId": "suscipit",
"companyFieldId": "impedit",
"companyId": "aut",
"externalIntegrationId": "quia"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch create new Company field maps
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/company-field-maps/batch?include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"externalCompanyFieldId\": \"illum\",
\"companyFieldId\": \"quis\",
\"companyId\": \"voluptate\",
\"externalIntegrationId\": \"omnis\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/company-field-maps/batch"
);
const params = {
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"externalCompanyFieldId": "illum",
"companyFieldId": "quis",
"companyId": "voluptate",
"externalIntegrationId": "omnis"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Company field map by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/company-field-maps/assumenda?include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/company-field-maps/assumenda"
);
const params = {
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "CompanyFieldMap [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch update Company field maps
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/company-field-maps/batch?include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"externalCompanyFieldId\": \"similique\",
\"companyFieldId\": \"optio\",
\"companyId\": \"voluptatem\",
\"externalIntegrationId\": \"dicta\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/company-field-maps/batch"
);
const params = {
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"externalCompanyFieldId": "similique",
"companyFieldId": "optio",
"companyId": "voluptatem",
"externalIntegrationId": "dicta"
}
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Company field map by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/company-field-maps/voluptate?include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"externalCompanyFieldId\": \"ut\",
\"companyFieldId\": \"quos\",
\"companyId\": \"saepe\",
\"externalIntegrationId\": \"molestias\"
}"
const url = new URL(
"http://localhost:8000/api/v1/company-field-maps/voluptate"
);
const params = {
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"externalCompanyFieldId": "ut",
"companyFieldId": "quos",
"companyId": "saepe",
"externalIntegrationId": "molestias"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "CompanyFieldMap [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch delete Company field maps by their IDs
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/company-field-maps/batch?include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
\"illo\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/company-field-maps/batch"
);
const params = {
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
"illo"
]
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Company field map by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/company-field-maps/aliquid?include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/company-field-maps/aliquid"
);
const params = {
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "CompanyFieldMap [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Company field maps with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/company-field-maps?page=1&pageSize=15&withSoftDeletes=1&include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/company-field-maps"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Company field maps based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/company-field-maps/search?page=1&pageSize=15&withSoftDeletes=1&include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"companyId\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/company-field-maps/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "companyId",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Pay code variable
Create a new Pay code variable
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/pay-code-variables?include=variableType" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"variableTypeId\": \"quis\"
}"
const url = new URL(
"http://localhost:8000/api/v1/pay-code-variables"
);
const params = {
"include": "variableType",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"variableTypeId": "quis"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch create new Pay code variables
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/pay-code-variables/batch?include=variableType" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"variableTypeId\": \"iusto\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/pay-code-variables/batch"
);
const params = {
"include": "variableType",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"variableTypeId": "iusto"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Pay code variable by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/pay-code-variables/cumque?include=variableType" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/pay-code-variables/cumque"
);
const params = {
"include": "variableType",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "PayCodeVariable [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch update Pay code variables
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/pay-code-variables/batch?include=variableType" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
const url = new URL(
"http://localhost:8000/api/v1/pay-code-variables/batch"
);
const params = {
"include": "variableType",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PATCH",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Pay code variable by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/pay-code-variables/qui?include=variableType" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
const url = new URL(
"http://localhost:8000/api/v1/pay-code-variables/qui"
);
const params = {
"include": "variableType",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PATCH",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "PayCodeVariable [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch delete Pay code variables by their IDs
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/pay-code-variables/batch?include=variableType" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
\"eius\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/pay-code-variables/batch"
);
const params = {
"include": "variableType",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
"eius"
]
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Pay code variable by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/pay-code-variables/aut?include=variableType" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/pay-code-variables/aut"
);
const params = {
"include": "variableType",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "PayCodeVariable [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Pay code variables with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/pay-code-variables?page=1&pageSize=15&withSoftDeletes=1&include=variableType" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/pay-code-variables"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "variableType",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Pay code variables based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/pay-code-variables/search?page=1&pageSize=15&withSoftDeletes=1&include=variableType" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"variableTypeId\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/pay-code-variables/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "variableType",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "variableTypeId",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Pay code type
Create a new Pay code type
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/pay-code-types?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"payCodeTypeNumber\": 0.1
}"
const url = new URL(
"http://localhost:8000/api/v1/pay-code-types"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"payCodeTypeNumber": 0.1
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch create new Pay code types
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/pay-code-types/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"payCodeTypeNumber\": 68821533
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/pay-code-types/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"payCodeTypeNumber": 68821533
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Pay code type by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/pay-code-types/deserunt?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/pay-code-types/deserunt"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "PayCodeType [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch update Pay code types
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/pay-code-types/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"payCodeTypeNumber\": 17.4
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/pay-code-types/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"payCodeTypeNumber": 17.4
}
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Pay code type by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/pay-code-types/facilis?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"payCodeTypeNumber\": 1143.849294312
}"
const url = new URL(
"http://localhost:8000/api/v1/pay-code-types/facilis"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"payCodeTypeNumber": 1143.849294312
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "PayCodeType [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch delete Pay code types by their IDs
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/pay-code-types/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
\"perferendis\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/pay-code-types/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
"perferendis"
]
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Pay code type by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/pay-code-types/repellat?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/pay-code-types/repellat"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "PayCodeType [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Pay code types with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/pay-code-types?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/pay-code-types"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Pay code types based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/pay-code-types/search?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"payCodeTypeNumber\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/pay-code-types/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "payCodeTypeNumber",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Pay code mapping
Create a new Pay code mapping
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/pay-code-mappings?include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"companyId\": \"omnis\",
\"organizationId\": \"temporibus\",
\"isGlobal\": true,
\"isGroup\": false,
\"notes\": \"sint\"
}"
const url = new URL(
"http://localhost:8000/api/v1/pay-code-mappings"
);
const params = {
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"companyId": "omnis",
"organizationId": "temporibus",
"isGlobal": true,
"isGroup": false,
"notes": "sint"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch create new Pay code mappings
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/pay-code-mappings/batch?include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"companyId\": \"est\",
\"organizationId\": \"nesciunt\",
\"isGlobal\": true,
\"isGroup\": true,
\"mappings\": [],
\"notes\": \"et\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/pay-code-mappings/batch"
);
const params = {
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"companyId": "est",
"organizationId": "nesciunt",
"isGlobal": true,
"isGroup": true,
"mappings": [],
"notes": "et"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Pay code mapping by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/pay-code-mappings/a?include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/pay-code-mappings/a"
);
const params = {
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "PayCodeMapping [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch update Pay code mappings
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/pay-code-mappings/batch?include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"isGlobal\": false,
\"isGroup\": false,
\"notes\": \"cumque\",
\"status\": \"active\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/pay-code-mappings/batch"
);
const params = {
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"isGlobal": false,
"isGroup": false,
"notes": "cumque",
"status": "active"
}
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Pay code mapping by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/pay-code-mappings/ex?include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"isGlobal\": false,
\"isGroup\": true,
\"notes\": \"qui\",
\"status\": \"inactive\"
}"
const url = new URL(
"http://localhost:8000/api/v1/pay-code-mappings/ex"
);
const params = {
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"isGlobal": false,
"isGroup": true,
"notes": "qui",
"status": "inactive"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "PayCodeMapping [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch delete Pay code mappings by their IDs
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/pay-code-mappings/batch?include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
\"animi\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/pay-code-mappings/batch"
);
const params = {
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
"animi"
]
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Pay code mapping by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/pay-code-mappings/facilis?include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/pay-code-mappings/facilis"
);
const params = {
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "PayCodeMapping [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Pay code mappings with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/pay-code-mappings?page=1&pageSize=15&withSoftDeletes=1&include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/pay-code-mappings"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Pay code mappings based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/pay-code-mappings/search?page=1&pageSize=15&withSoftDeletes=1&include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"companyId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"isGlobal\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"isGroup\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"status\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"whiteListedPayCodeIds\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/pay-code-mappings/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "companyId",
"operator": "=",
"value": "value"
},
{
"field": "isGlobal",
"operator": "=",
"value": "value"
},
{
"field": "isGroup",
"operator": "=",
"value": "value"
},
{
"field": "status",
"operator": "=",
"value": "value"
},
{
"field": "whiteListedPayCodeIds",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Company
Create a new Company
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/companies?include=companies%2CfieldMaps%2CcompanyIntegration%2CcompanyIntegration.externalIntegration%2CparentCompany%2CdefaultGridView%2Ccountry%2Cteams%2CcustomerTypes" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"customerTypeIds\": [
\"deserunt\"
],
\"autoApproveOnImport\": false
}"
const url = new URL(
"http://localhost:8000/api/v1/companies"
);
const params = {
"include": "companies,fieldMaps,companyIntegration,companyIntegration.externalIntegration,parentCompany,defaultGridView,country,teams,customerTypes",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"customerTypeIds": [
"deserunt"
],
"autoApproveOnImport": false
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch create new Companies
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/companies/batch?include=companies%2CfieldMaps%2CcompanyIntegration%2CcompanyIntegration.externalIntegration%2CparentCompany%2CdefaultGridView%2Ccountry%2Cteams%2CcustomerTypes" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"autoApproveOnImport\": false
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/companies/batch"
);
const params = {
"include": "companies,fieldMaps,companyIntegration,companyIntegration.externalIntegration,parentCompany,defaultGridView,country,teams,customerTypes",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"autoApproveOnImport": false
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Company by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/companies/quidem?include=companies%2CfieldMaps%2CcompanyIntegration%2CcompanyIntegration.externalIntegration%2CparentCompany%2CdefaultGridView%2Ccountry%2Cteams%2CcustomerTypes" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/companies/quidem"
);
const params = {
"include": "companies,fieldMaps,companyIntegration,companyIntegration.externalIntegration,parentCompany,defaultGridView,country,teams,customerTypes",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "Company [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch update Companies
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/companies/batch?include=companies%2CfieldMaps%2CcompanyIntegration%2CcompanyIntegration.externalIntegration%2CparentCompany%2CdefaultGridView%2Ccountry%2Cteams%2CcustomerTypes" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"autoApproveOnImport\": false
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/companies/batch"
);
const params = {
"include": "companies,fieldMaps,companyIntegration,companyIntegration.externalIntegration,parentCompany,defaultGridView,country,teams,customerTypes",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"autoApproveOnImport": false
}
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Company by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/companies/eos?include=companies%2CfieldMaps%2CcompanyIntegration%2CcompanyIntegration.externalIntegration%2CparentCompany%2CdefaultGridView%2Ccountry%2Cteams%2CcustomerTypes" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"customerTypeIds\": [
\"expedita\"
],
\"autoApproveOnImport\": true
}"
const url = new URL(
"http://localhost:8000/api/v1/companies/eos"
);
const params = {
"include": "companies,fieldMaps,companyIntegration,companyIntegration.externalIntegration,parentCompany,defaultGridView,country,teams,customerTypes",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"customerTypeIds": [
"expedita"
],
"autoApproveOnImport": true
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "Company [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch delete Companies by their IDs
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/companies/batch?include=companies%2CfieldMaps%2CcompanyIntegration%2CcompanyIntegration.externalIntegration%2CparentCompany%2CdefaultGridView%2Ccountry%2Cteams%2CcustomerTypes" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
\"sit\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/companies/batch"
);
const params = {
"include": "companies,fieldMaps,companyIntegration,companyIntegration.externalIntegration,parentCompany,defaultGridView,country,teams,customerTypes",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
"sit"
]
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Company by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/companies/id?include=companies%2CfieldMaps%2CcompanyIntegration%2CcompanyIntegration.externalIntegration%2CparentCompany%2CdefaultGridView%2Ccountry%2Cteams%2CcustomerTypes" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/companies/id"
);
const params = {
"include": "companies,fieldMaps,companyIntegration,companyIntegration.externalIntegration,parentCompany,defaultGridView,country,teams,customerTypes",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "Company [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Companies with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/companies?page=1&pageSize=15&withSoftDeletes=1&include=companies%2CfieldMaps%2CcompanyIntegration%2CcompanyIntegration.externalIntegration%2CparentCompany%2CdefaultGridView%2Ccountry%2Cteams%2CcustomerTypes" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/companies"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "companies,fieldMaps,companyIntegration,companyIntegration.externalIntegration,parentCompany,defaultGridView,country,teams,customerTypes",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Companies based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/companies/search?page=1&pageSize=15&withSoftDeletes=1&include=companies%2CfieldMaps%2CcompanyIntegration%2CcompanyIntegration.externalIntegration%2CparentCompany%2CdefaultGridView%2Ccountry%2Cteams%2CcustomerTypes" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"companyId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"importedAt\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"parentCompanyId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"organizationId\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"externalId\",
\"direction\": \"asc\"
},
{
\"field\": \"companyId\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/companies/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "companies,fieldMaps,companyIntegration,companyIntegration.externalIntegration,parentCompany,defaultGridView,country,teams,customerTypes",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "companyId",
"operator": "=",
"value": "value"
},
{
"field": "importedAt",
"operator": "=",
"value": "value"
},
{
"field": "parentCompanyId",
"operator": "=",
"value": "value"
},
{
"field": "organizationId",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "externalId",
"direction": "asc"
},
{
"field": "companyId",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Company integrations mapping
Create a new Company integrations mapping
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/company-integrations-mappings?include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"externalIntegrationId\": \"tempora\",
\"companyId\": \"ipsa\",
\"notes\": \"labore\",
\"status\": \"inactive\"
}"
const url = new URL(
"http://localhost:8000/api/v1/company-integrations-mappings"
);
const params = {
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"externalIntegrationId": "tempora",
"companyId": "ipsa",
"notes": "labore",
"status": "inactive"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch create new Company integrations mappings
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/company-integrations-mappings/batch?include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"externalIntegrationId\": \"tenetur\",
\"companyId\": \"porro\",
\"notes\": \"voluptatem\",
\"status\": \"inactive\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/company-integrations-mappings/batch"
);
const params = {
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"externalIntegrationId": "tenetur",
"companyId": "porro",
"notes": "voluptatem",
"status": "inactive"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Company integrations mapping by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/company-integrations-mappings/voluptatum?include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/company-integrations-mappings/voluptatum"
);
const params = {
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch update Company integrations mappings
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/company-integrations-mappings/batch?include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"notes\": \"aliquam\",
\"status\": \"inactive\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/company-integrations-mappings/batch"
);
const params = {
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"notes": "aliquam",
"status": "inactive"
}
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Company integrations mapping by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/company-integrations-mappings/alias?include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"notes\": \"quidem\",
\"status\": \"active\"
}"
const url = new URL(
"http://localhost:8000/api/v1/company-integrations-mappings/alias"
);
const params = {
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"notes": "quidem",
"status": "active"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch delete Company integrations mappings by their IDs
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/company-integrations-mappings/batch?include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
\"fuga\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/company-integrations-mappings/batch"
);
const params = {
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
"fuga"
]
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Company integrations mapping by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/company-integrations-mappings/expedita?include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/company-integrations-mappings/expedita"
);
const params = {
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Company integrations mappings with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/company-integrations-mappings?page=1&pageSize=15&withSoftDeletes=1&include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/company-integrations-mappings"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Company integrations mappings based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/company-integrations-mappings/search?page=1&pageSize=15&withSoftDeletes=1&include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/company-integrations-mappings/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Company settings
Create a new Company settings
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/company-settings?include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"defaultLocale\": \"ha_SD\",
\"defaultProfile\": \"aperiam\",
\"activeProfile\": \"provident\",
\"companyId\": \"qui\",
\"organizationId\": \"aliquid\",
\"organisationNumber\": \"magnam\"
}"
const url = new URL(
"http://localhost:8000/api/v1/company-settings"
);
const params = {
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"defaultLocale": "ha_SD",
"defaultProfile": "aperiam",
"activeProfile": "provident",
"companyId": "qui",
"organizationId": "aliquid",
"organisationNumber": "magnam"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch create new Company settings
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/company-settings/batch?include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"defaultLocale\": \"de_DE\",
\"defaultProfile\": \"nostrum\",
\"activeProfile\": \"vel\",
\"companyId\": \"impedit\",
\"organizationId\": \"eum\",
\"organisationNumber\": \"blanditiis\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/company-settings/batch"
);
const params = {
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"defaultLocale": "de_DE",
"defaultProfile": "nostrum",
"activeProfile": "vel",
"companyId": "impedit",
"organizationId": "eum",
"organisationNumber": "blanditiis"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Company settings by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/company-settings/nulla?include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/company-settings/nulla"
);
const params = {
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "CompanySettings [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch update Company settings
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/company-settings/batch?include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"defaultLocale\": \"ja_JP\",
\"defaultProfile\": \"architecto\",
\"activeProfile\": \"rerum\",
\"organisationNumber\": \"hic\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/company-settings/batch"
);
const params = {
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"defaultLocale": "ja_JP",
"defaultProfile": "architecto",
"activeProfile": "rerum",
"organisationNumber": "hic"
}
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Company settings by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/company-settings/sed?include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"defaultLocale\": \"es_UY\",
\"defaultProfile\": \"maiores\",
\"activeProfile\": \"reprehenderit\",
\"organisationNumber\": \"libero\"
}"
const url = new URL(
"http://localhost:8000/api/v1/company-settings/sed"
);
const params = {
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"defaultLocale": "es_UY",
"defaultProfile": "maiores",
"activeProfile": "reprehenderit",
"organisationNumber": "libero"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "CompanySettings [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch delete Company settings by their IDs
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/company-settings/batch?include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
\"mollitia\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/company-settings/batch"
);
const params = {
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
"mollitia"
]
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Company settings by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/company-settings/cupiditate?include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"companyId\": \"sit\"
}"
const url = new URL(
"http://localhost:8000/api/v1/company-settings/cupiditate"
);
const params = {
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"companyId": "sit"
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "CompanySettings [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Company settings with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/company-settings?page=1&pageSize=15&withSoftDeletes=1&include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/company-settings"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Company settings based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/company-settings/search?page=1&pageSize=15&withSoftDeletes=1&include=company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"companyId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"organisationId\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/company-settings/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "company",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "companyId",
"operator": "=",
"value": "value"
},
{
"field": "organisationId",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Pay code group
Create a new Pay code group
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/pay-code-groups?include=payCodeVariables%2CpayCodeVariables.variableType" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"payCodeGroupNumber\": 78210.03829,
\"payCodeVariableIds\": [
\"vitae\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/pay-code-groups"
);
const params = {
"include": "payCodeVariables,payCodeVariables.variableType",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"payCodeGroupNumber": 78210.03829,
"payCodeVariableIds": [
"vitae"
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch create new Pay code groups
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/pay-code-groups/batch?include=payCodeVariables%2CpayCodeVariables.variableType" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"payCodeGroupNumber\": 641600792.1,
\"payCodeVariableIds\": []
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/pay-code-groups/batch"
);
const params = {
"include": "payCodeVariables,payCodeVariables.variableType",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"payCodeGroupNumber": 641600792.1,
"payCodeVariableIds": []
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Pay code group by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/pay-code-groups/nesciunt?include=payCodeVariables%2CpayCodeVariables.variableType" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/pay-code-groups/nesciunt"
);
const params = {
"include": "payCodeVariables,payCodeVariables.variableType",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "PayCodeGroup [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch update Pay code groups
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/pay-code-groups/batch?include=payCodeVariables%2CpayCodeVariables.variableType" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"payCodeGroupNumber\": 0.5529983
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/pay-code-groups/batch"
);
const params = {
"include": "payCodeVariables,payCodeVariables.variableType",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"payCodeGroupNumber": 0.5529983
}
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Pay code group by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/pay-code-groups/molestias?include=payCodeVariables%2CpayCodeVariables.variableType" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"payCodeGroupNumber\": 104907.392218237,
\"payCodeVariableIds\": [
\"minima\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/pay-code-groups/molestias"
);
const params = {
"include": "payCodeVariables,payCodeVariables.variableType",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"payCodeGroupNumber": 104907.392218237,
"payCodeVariableIds": [
"minima"
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "PayCodeGroup [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch delete Pay code groups by their IDs
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/pay-code-groups/batch?include=payCodeVariables%2CpayCodeVariables.variableType" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
\"reprehenderit\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/pay-code-groups/batch"
);
const params = {
"include": "payCodeVariables,payCodeVariables.variableType",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
"reprehenderit"
]
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Pay code group by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/pay-code-groups/qui?include=payCodeVariables%2CpayCodeVariables.variableType" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/pay-code-groups/qui"
);
const params = {
"include": "payCodeVariables,payCodeVariables.variableType",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "PayCodeGroup [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Pay code groups with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/pay-code-groups?page=1&pageSize=15&withSoftDeletes=1&include=payCodeVariables%2CpayCodeVariables.variableType" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/pay-code-groups"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "payCodeVariables,payCodeVariables.variableType",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Pay code groups based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/pay-code-groups/search?page=1&pageSize=15&withSoftDeletes=1&include=payCodeVariables%2CpayCodeVariables.variableType" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"payCodeGroupNumber\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"payCodeVariableIds\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/pay-code-groups/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "payCodeVariables,payCodeVariables.variableType",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "payCodeGroupNumber",
"operator": "=",
"value": "value"
},
{
"field": "payCodeVariableIds",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.External integration
Batch create new External integrations
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/external-integrations/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
const url = new URL(
"http://localhost:8000/api/v1/external-integrations/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a External integration by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/external-integrations/eos?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/external-integrations/eos"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "ExternalIntegration [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch update External integrations
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/external-integrations/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"description\": \"Eos aut a asperiores rerum voluptas.\",
\"status\": \"active\",
\"integrationTypeId\": \"temporibus\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/external-integrations/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"description": "Eos aut a asperiores rerum voluptas.",
"status": "active",
"integrationTypeId": "temporibus"
}
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a External integration by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/external-integrations/a?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"description\": \"Incidunt impedit non unde a qui.\",
\"status\": \"active\",
\"integrationTypeId\": \"nostrum\"
}"
const url = new URL(
"http://localhost:8000/api/v1/external-integrations/a"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"description": "Incidunt impedit non unde a qui.",
"status": "active",
"integrationTypeId": "nostrum"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "ExternalIntegration [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch delete External integrations by their IDs
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/external-integrations/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
\"quibusdam\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/external-integrations/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
"quibusdam"
]
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a External integration by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/external-integrations/fugiat?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/external-integrations/fugiat"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "ExternalIntegration [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of External integrations with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/external-integrations?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/external-integrations"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of External integrations based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/external-integrations/search?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"integrationName\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"description\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"status\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/external-integrations/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "integrationName",
"operator": "=",
"value": "value"
},
{
"field": "description",
"operator": "=",
"value": "value"
},
{
"field": "status",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Pay code
Create a new Pay code
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/pay-codes?include=payCodeGroup%2CpayCodeType%2CpayCodeVariables%2CpayCodeVariables.variableType" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"companyId\": \"et\",
\"integrationId\": \"error\",
\"organizationId\": \"qui\",
\"payCodeNumber\": 450277.6422224,
\"payCodeGroupId\": \"nobis\",
\"payCodeTypeId\": \"sapiente\",
\"payCodeVariableIds\": [
\"et\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/pay-codes"
);
const params = {
"include": "payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"companyId": "et",
"integrationId": "error",
"organizationId": "qui",
"payCodeNumber": 450277.6422224,
"payCodeGroupId": "nobis",
"payCodeTypeId": "sapiente",
"payCodeVariableIds": [
"et"
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch create new Pay codes
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/pay-codes/batch?include=payCodeGroup%2CpayCodeType%2CpayCodeVariables%2CpayCodeVariables.variableType" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"companyId\": \"nihil\",
\"integrationId\": \"dolor\",
\"organizationId\": \"quod\",
\"payCodeNumber\": 81.8501,
\"payCodeGroupId\": \"quia\",
\"payCodeTypeId\": \"saepe\",
\"payCodeVariableIds\": []
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/pay-codes/batch"
);
const params = {
"include": "payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"companyId": "nihil",
"integrationId": "dolor",
"organizationId": "quod",
"payCodeNumber": 81.8501,
"payCodeGroupId": "quia",
"payCodeTypeId": "saepe",
"payCodeVariableIds": []
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Pay code by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/pay-codes/odio?include=payCodeGroup%2CpayCodeType%2CpayCodeVariables%2CpayCodeVariables.variableType" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/pay-codes/odio"
);
const params = {
"include": "payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "PayCode [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch update Pay codes
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/pay-codes/batch?include=payCodeGroup%2CpayCodeType%2CpayCodeVariables%2CpayCodeVariables.variableType" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"payCodeNumber\": 82,
\"payCodeGroupId\": \"voluptatibus\",
\"payCodeTypeId\": \"quia\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/pay-codes/batch"
);
const params = {
"include": "payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"payCodeNumber": 82,
"payCodeGroupId": "voluptatibus",
"payCodeTypeId": "quia"
}
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Pay code by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/pay-codes/sunt?include=payCodeGroup%2CpayCodeType%2CpayCodeVariables%2CpayCodeVariables.variableType" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"payCodeNumber\": 5895.620492145,
\"payCodeGroupId\": \"nesciunt\",
\"payCodeTypeId\": \"maiores\",
\"payCodeVariableIds\": [
\"harum\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/pay-codes/sunt"
);
const params = {
"include": "payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"payCodeNumber": 5895.620492145,
"payCodeGroupId": "nesciunt",
"payCodeTypeId": "maiores",
"payCodeVariableIds": [
"harum"
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "PayCode [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch delete Pay codes by their IDs
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/pay-codes/batch?include=payCodeGroup%2CpayCodeType%2CpayCodeVariables%2CpayCodeVariables.variableType" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
\"et\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/pay-codes/batch"
);
const params = {
"include": "payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
"et"
]
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Pay code by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/pay-codes/blanditiis?include=payCodeGroup%2CpayCodeType%2CpayCodeVariables%2CpayCodeVariables.variableType" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/pay-codes/blanditiis"
);
const params = {
"include": "payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "PayCode [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Pay codes with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/pay-codes?page=1&pageSize=15&withSoftDeletes=1&include=payCodeGroup%2CpayCodeType%2CpayCodeVariables%2CpayCodeVariables.variableType" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/pay-codes"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Pay codes based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/pay-codes/search?page=1&pageSize=15&withSoftDeletes=1&include=payCodeGroup%2CpayCodeType%2CpayCodeVariables%2CpayCodeVariables.variableType" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"organizationId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"integrationId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"companyId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"payCodeNumber\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"payCodeGroupId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"payCodeTypeId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"payCodeVariableIds\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"payCodeNumber\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/pay-codes/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "organizationId",
"operator": "=",
"value": "value"
},
{
"field": "integrationId",
"operator": "=",
"value": "value"
},
{
"field": "companyId",
"operator": "=",
"value": "value"
},
{
"field": "payCodeNumber",
"operator": "=",
"value": "value"
},
{
"field": "payCodeGroupId",
"operator": "=",
"value": "value"
},
{
"field": "payCodeTypeId",
"operator": "=",
"value": "value"
},
{
"field": "payCodeVariableIds",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "payCodeNumber",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Personal card profile
Create a new Personal card profile
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/personal-card-profiles?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"praesentium\",
\"tabs\": [
{
\"order\": 5729070.7,
\"personalCardProfileTabId\": \"quibusdam\",
\"grids\": [
{
\"order\": 2097959.334,
\"personalCardProfileTabGridId\": \"vel\",
\"fieldGroupId\": \"ipsum\",
\"fields\": [
{
\"order\": 330554.6,
\"fieldId\": \"optio\"
}
]
}
]
}
],
\"description\": \"Saepe eum totam qui quo temporibus.\",
\"isGlobal\": \"iste\",
\"roleIds\": [
12
],
\"companyId\": \"sapiente\"
}"
const url = new URL(
"http://localhost:8000/api/v1/personal-card-profiles"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "praesentium",
"tabs": [
{
"order": 5729070.7,
"personalCardProfileTabId": "quibusdam",
"grids": [
{
"order": 2097959.334,
"personalCardProfileTabGridId": "vel",
"fieldGroupId": "ipsum",
"fields": [
{
"order": 330554.6,
"fieldId": "optio"
}
]
}
]
}
],
"description": "Saepe eum totam qui quo temporibus.",
"isGlobal": "iste",
"roleIds": [
12
],
"companyId": "sapiente"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch create new Personal card profiles
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/personal-card-profiles/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"name\": \"aliquam\",
\"description\": \"Libero optio enim quia aut iusto.\",
\"isGlobal\": \"sed\",
\"companyId\": \"culpa\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/personal-card-profiles/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"name": "aliquam",
"description": "Libero optio enim quia aut iusto.",
"isGlobal": "sed",
"companyId": "culpa"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Personal card profile by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/personal-card-profiles/ex?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"isGlobal\": \"expedita\"
}"
const url = new URL(
"http://localhost:8000/api/v1/personal-card-profiles/ex"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"isGlobal": "expedita"
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "PersonalCardProfile [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch update Personal card profiles
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/personal-card-profiles/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"et\",
\"description\": \"Vel nulla repellendus asperiores voluptatem expedita molestias mollitia repudiandae.\",
\"tabs\": [
{
\"order\": 1720.91,
\"personalCardProfileTabId\": \"exercitationem\",
\"grids\": [
{
\"order\": 502505092.7,
\"personalCardProfileTabGridId\": \"cum\",
\"fieldGroupId\": \"magni\",
\"fields\": [
{
\"order\": 17.49,
\"fieldId\": \"provident\"
}
]
}
]
}
],
\"isGlobal\": \"illum\",
\"companyId\": \"qui\",
\"roleIds\": [
1
]
}"
const url = new URL(
"http://localhost:8000/api/v1/personal-card-profiles/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "et",
"description": "Vel nulla repellendus asperiores voluptatem expedita molestias mollitia repudiandae.",
"tabs": [
{
"order": 1720.91,
"personalCardProfileTabId": "exercitationem",
"grids": [
{
"order": 502505092.7,
"personalCardProfileTabGridId": "cum",
"fieldGroupId": "magni",
"fields": [
{
"order": 17.49,
"fieldId": "provident"
}
]
}
]
}
],
"isGlobal": "illum",
"companyId": "qui",
"roleIds": [
1
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Personal card profile by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/personal-card-profiles/est?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"id\",
\"description\": \"Ipsa quod quis voluptatem vel quam quis.\",
\"tabs\": [
{
\"order\": 204322.5,
\"personalCardProfileTabId\": \"expedita\",
\"grids\": [
{
\"order\": 363330.24731,
\"personalCardProfileTabGridId\": \"quae\",
\"fieldGroupId\": \"nobis\",
\"fields\": [
{
\"order\": 18632478.92044,
\"fieldId\": \"cupiditate\"
}
]
}
]
}
],
\"isGlobal\": \"iusto\",
\"companyId\": \"unde\",
\"roleIds\": [
9
]
}"
const url = new URL(
"http://localhost:8000/api/v1/personal-card-profiles/est"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "id",
"description": "Ipsa quod quis voluptatem vel quam quis.",
"tabs": [
{
"order": 204322.5,
"personalCardProfileTabId": "expedita",
"grids": [
{
"order": 363330.24731,
"personalCardProfileTabGridId": "quae",
"fieldGroupId": "nobis",
"fields": [
{
"order": 18632478.92044,
"fieldId": "cupiditate"
}
]
}
]
}
],
"isGlobal": "iusto",
"companyId": "unde",
"roleIds": [
9
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "PersonalCardProfile [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch delete Personal card profiles by their IDs
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/personal-card-profiles/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"isGlobal\": \"doloribus\"
}"
const url = new URL(
"http://localhost:8000/api/v1/personal-card-profiles/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"isGlobal": "doloribus"
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Personal card profile by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/personal-card-profiles/ipsum?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"isGlobal\": \"laboriosam\"
}"
const url = new URL(
"http://localhost:8000/api/v1/personal-card-profiles/ipsum"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"isGlobal": "laboriosam"
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "PersonalCardProfile [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Personal card profiles with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/personal-card-profiles?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"isGlobal\": \"et\"
}"
const url = new URL(
"http://localhost:8000/api/v1/personal-card-profiles"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"isGlobal": "et"
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Personal card profiles based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/personal-card-profiles/search?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"companyId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"isGlobal\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"name\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"description\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/personal-card-profiles/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "companyId",
"operator": "=",
"value": "value"
},
{
"field": "isGlobal",
"operator": "=",
"value": "value"
},
{
"field": "name",
"operator": "=",
"value": "value"
},
{
"field": "description",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Personal card profile tab grid
Create a new Personal card profile tab grid
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/personal-card-profile-tab-grids?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"tabId\": \"eos\",
\"isGlobal\": false,
\"description\": \"Aliquam repudiandae quia id nihil libero.\",
\"fieldGroupId\": \"repellendus\",
\"translations\": {
\"no\": [],
\"dk\": [],
\"se\": [],
\"en\": [],
\"fi\": []
},
\"originPersonalCardProfileId\": \"corrupti\",
\"fields\": [
{
\"globalFieldId\": \"tenetur\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/personal-card-profile-tab-grids"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"tabId": "eos",
"isGlobal": false,
"description": "Aliquam repudiandae quia id nihil libero.",
"fieldGroupId": "repellendus",
"translations": {
"no": [],
"dk": [],
"se": [],
"en": [],
"fi": []
},
"originPersonalCardProfileId": "corrupti",
"fields": [
{
"globalFieldId": "tenetur"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch create new Personal card profile tab grids
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/personal-card-profile-tab-grids/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"tabId\": \"sint\",
\"isGlobal\": false,
\"description\": \"Iure voluptatem commodi facere sit facilis qui quibusdam provident.\",
\"fieldGroupId\": \"veniam\",
\"translations\": {
\"no\": [],
\"dk\": [],
\"se\": [],
\"en\": [],
\"fi\": []
},
\"originPersonalCardProfileId\": \"voluptate\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/personal-card-profile-tab-grids/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"tabId": "sint",
"isGlobal": false,
"description": "Iure voluptatem commodi facere sit facilis qui quibusdam provident.",
"fieldGroupId": "veniam",
"translations": {
"no": [],
"dk": [],
"se": [],
"en": [],
"fi": []
},
"originPersonalCardProfileId": "voluptate"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Personal card profile tab grid by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/personal-card-profile-tab-grids/sed?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/personal-card-profile-tab-grids/sed"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "PersonalCardProfileTabGrid [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch update Personal card profile tab grids
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/personal-card-profile-tab-grids/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"isGlobal\": true,
\"description\": \"Et unde illo accusantium recusandae perferendis tempore ad.\",
\"translations\": {
\"no\": [],
\"dk\": [],
\"se\": [],
\"en\": [],
\"fi\": []
}
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/personal-card-profile-tab-grids/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"isGlobal": true,
"description": "Et unde illo accusantium recusandae perferendis tempore ad.",
"translations": {
"no": [],
"dk": [],
"se": [],
"en": [],
"fi": []
}
}
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Personal card profile tab grid by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/personal-card-profile-tab-grids/est?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"isGlobal\": false,
\"description\": \"Consequatur enim molestiae accusamus tempore.\",
\"translations\": {
\"no\": [],
\"dk\": [],
\"se\": [],
\"en\": [],
\"fi\": []
}
}"
const url = new URL(
"http://localhost:8000/api/v1/personal-card-profile-tab-grids/est"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"isGlobal": false,
"description": "Consequatur enim molestiae accusamus tempore.",
"translations": {
"no": [],
"dk": [],
"se": [],
"en": [],
"fi": []
}
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "PersonalCardProfileTabGrid [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch delete Personal card profile tab grids by their IDs
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/personal-card-profile-tab-grids/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
\"quis\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/personal-card-profile-tab-grids/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
"quis"
]
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Personal card profile tab grid by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/personal-card-profile-tab-grids/et?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/personal-card-profile-tab-grids/et"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "PersonalCardProfileTabGrid [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Personal card profile tab grids with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/personal-card-profile-tab-grids?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/personal-card-profile-tab-grids"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Personal card profile tab grids based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/personal-card-profile-tab-grids/search?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"isGlobal\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"description\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"originPersonalCardProfileId\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/personal-card-profile-tab-grids/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "isGlobal",
"operator": "=",
"value": "value"
},
{
"field": "description",
"operator": "=",
"value": "value"
},
{
"field": "originPersonalCardProfileId",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Personal card profile tab
Create a new Personal card profile tab
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/personal-card-profile-tabs?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"isGlobal\": true,
\"description\": \"Minima illum voluptatem et modi magni amet.\",
\"translations\": {
\"no\": [],
\"dk\": [],
\"se\": [],
\"en\": [],
\"fi\": []
},
\"originPersonalCardProfileId\": \"non\"
}"
const url = new URL(
"http://localhost:8000/api/v1/personal-card-profile-tabs"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"isGlobal": true,
"description": "Minima illum voluptatem et modi magni amet.",
"translations": {
"no": [],
"dk": [],
"se": [],
"en": [],
"fi": []
},
"originPersonalCardProfileId": "non"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch create new Personal card profile tabs
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/personal-card-profile-tabs/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"isGlobal\": false,
\"description\": \"Sed hic sit sunt perspiciatis.\",
\"translations\": {
\"no\": [],
\"dk\": [],
\"se\": [],
\"en\": [],
\"fi\": []
},
\"originPersonalCardProfileId\": \"dicta\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/personal-card-profile-tabs/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"isGlobal": false,
"description": "Sed hic sit sunt perspiciatis.",
"translations": {
"no": [],
"dk": [],
"se": [],
"en": [],
"fi": []
},
"originPersonalCardProfileId": "dicta"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Personal card profile tab by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/personal-card-profile-tabs/et?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/personal-card-profile-tabs/et"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "PersonalCardProfileTab [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch update Personal card profile tabs
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/personal-card-profile-tabs/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"isGlobal\": false,
\"description\": \"Ea non natus omnis est praesentium perferendis et.\",
\"translations\": {
\"no\": [],
\"dk\": [],
\"se\": [],
\"en\": [],
\"fi\": []
}
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/personal-card-profile-tabs/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"isGlobal": false,
"description": "Ea non natus omnis est praesentium perferendis et.",
"translations": {
"no": [],
"dk": [],
"se": [],
"en": [],
"fi": []
}
}
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Personal card profile tab by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/personal-card-profile-tabs/aperiam?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"isGlobal\": false,
\"description\": \"Voluptas facilis provident perspiciatis voluptate minus.\",
\"translations\": {
\"no\": [],
\"dk\": [],
\"se\": [],
\"en\": [],
\"fi\": []
}
}"
const url = new URL(
"http://localhost:8000/api/v1/personal-card-profile-tabs/aperiam"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"isGlobal": false,
"description": "Voluptas facilis provident perspiciatis voluptate minus.",
"translations": {
"no": [],
"dk": [],
"se": [],
"en": [],
"fi": []
}
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "PersonalCardProfileTab [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch delete Personal card profile tabs by their IDs
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/personal-card-profile-tabs/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
\"ipsum\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/personal-card-profile-tabs/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
"ipsum"
]
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Personal card profile tab by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/personal-card-profile-tabs/ad?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/personal-card-profile-tabs/ad"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "PersonalCardProfileTab [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Personal card profile tabs with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/personal-card-profile-tabs?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/personal-card-profile-tabs"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Personal card profile tabs based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/personal-card-profile-tabs/search?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"isGlobal\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"description\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"originPersonalCardProfileId\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/personal-card-profile-tabs/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "isGlobal",
"operator": "=",
"value": "value"
},
{
"field": "description",
"operator": "=",
"value": "value"
},
{
"field": "originPersonalCardProfileId",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Locale
Create a new Locale
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/locales?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"culpa\",
\"code\": \"consectetur\",
\"enabled\": true
}"
const url = new URL(
"http://localhost:8000/api/v1/locales"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "culpa",
"code": "consectetur",
"enabled": true
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch create new Locales
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/locales/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"title\": \"corporis\",
\"code\": \"voluptatem\",
\"enabled\": false
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/locales/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"title": "corporis",
"code": "voluptatem",
"enabled": false
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Locale by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/locales/officia?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/locales/officia"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "Locale [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch update Locales
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/locales/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"title\": \"atque\",
\"code\": \"sint\",
\"enabled\": false
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/locales/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"title": "atque",
"code": "sint",
"enabled": false
}
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Locale by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/locales/aut?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"sed\",
\"code\": \"temporibus\",
\"enabled\": false
}"
const url = new URL(
"http://localhost:8000/api/v1/locales/aut"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "sed",
"code": "temporibus",
"enabled": false
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "Locale [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch delete Locales by their IDs
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/locales/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
\"qui\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/locales/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
"qui"
]
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Locale by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/locales/aut?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/locales/aut"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "Locale [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Locales with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/locales?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/locales"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Locales based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/locales/search?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"code\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"title\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"enabled\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/locales/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "code",
"operator": "=",
"value": "value"
},
{
"field": "title",
"operator": "=",
"value": "value"
},
{
"field": "enabled",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.External salary type
Fetch a External salary type by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/external-salary-types/fugit?include=company%2CexternalIntegration" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/external-salary-types/fugit"
);
const params = {
"include": "company,externalIntegration",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "ExternalSalaryType [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of External salary types with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/external-salary-types?page=1&pageSize=15&withSoftDeletes=1&include=company%2CexternalIntegration" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/external-salary-types"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "company,externalIntegration",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Emp permission
Create a new Emp permission (Stability Score: 0.1)
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/personnel-permissions?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"companyId\": \"excepturi\",
\"glue\": \"AND\",
\"rules\": [
\"rem\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/personnel-permissions"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"companyId": "excepturi",
"glue": "AND",
"rules": [
"rem"
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Emp permission by its ID (Stability Score: 0.1)
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/personnel-permissions/provident?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"companyId\": \"eos\",
\"glue\": \"OR\",
\"rules\": [
\"quo\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/personnel-permissions/provident"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"companyId": "eos",
"glue": "OR",
"rules": [
"quo"
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "EmpPermission [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Emp permission by its ID (Stability Score: 0.1)
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/personnel-permissions/et?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/personnel-permissions/et"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "EmpPermission [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Emp permissions based on the provided filters, scopes, sorting and pagination (Stability Score: 0.1)
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/personnel-permissions/search?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"empPermissionId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"companyId\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/personnel-permissions/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "empPermissionId",
"operator": "=",
"value": "value"
},
{
"field": "companyId",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Emp permission rule
Create a new Emp permission rule
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/personnel-permission-rules?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"employeeFieldId\": \"enim\",
\"operator\": \"=\",
\"value\": \"sed\"
}"
const url = new URL(
"http://localhost:8000/api/v1/personnel-permission-rules"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"employeeFieldId": "enim",
"operator": "=",
"value": "sed"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch create new Emp permission rules
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/personnel-permission-rules/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"employeeFieldId\": \"rerum\",
\"operator\": \"=\",
\"value\": \"dolorem\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/personnel-permission-rules/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"employeeFieldId": "rerum",
"operator": "=",
"value": "dolorem"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a Emp permission rule by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/personnel-permission-rules/est?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/personnel-permission-rules/est"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "EmpPermissionRule [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch update Emp permission rules
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/personnel-permission-rules/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
{
\"employeeFieldId\": \"nemo\",
\"operator\": \"=\",
\"value\": \"sapiente\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/personnel-permission-rules/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
{
"employeeFieldId": "nemo",
"operator": "=",
"value": "sapiente"
}
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a Emp permission rule by its ID (Stability Score: 0.1)
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/personnel-permission-rules/ipsa?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"employeeFieldId\": \"illum\",
\"operator\": \"=\",
\"value\": \"deserunt\"
}"
const url = new URL(
"http://localhost:8000/api/v1/personnel-permission-rules/ipsa"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"employeeFieldId": "illum",
"operator": "=",
"value": "deserunt"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "EmpPermissionRule [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Batch delete Emp permission rules by their IDs
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/personnel-permission-rules/batch?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": [
\"non\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/personnel-permission-rules/batch"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": [
"non"
]
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a Emp permission rule by its ID (Stability Score: 0.1)
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/personnel-permission-rules/placeat?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/personnel-permission-rules/placeat"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Example response (404):
{
"data": [],
"message": "EmpPermissionRule [id] does not exist.",
"status": 404
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Emp permission rules with pagination (Stability Score: 0.1)
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/personnel-permission-rules?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/personnel-permission-rules"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Emp permission rules based on the provided filters, scopes, sorting and pagination (Stability Score: 0.1)
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/personnel-permission-rules/search?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"empPermissionRuleId\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/personnel-permission-rules/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "empPermissionRuleId",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Transaction
Fetch a list of Transactions with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/transactions?page=1&pageSize=15&withSoftDeletes=1&include=company%2Cemployee%2CpayCode" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"companyId\": \"ad\"
}"
const url = new URL(
"http://localhost:8000/api/v1/transactions"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "company,employee,payCode",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"companyId": "ad"
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Transactions based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/transactions/search?page=1&pageSize=15&withSoftDeletes=1&include=company%2Cemployee%2CpayCode" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"companyId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"employeeId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"payCodeId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"salaryPeriod\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"externalId\",
\"direction\": \"asc\"
}
],
\"companyId\": \"cupiditate\"
}"
const url = new URL(
"http://localhost:8000/api/v1/transactions/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "company,employee,payCode",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "companyId",
"operator": "=",
"value": "value"
},
{
"field": "employeeId",
"operator": "=",
"value": "value"
},
{
"field": "payCodeId",
"operator": "=",
"value": "value"
},
{
"field": "salaryPeriod",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "externalId",
"direction": "asc"
}
],
"companyId": "cupiditate"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Employee
Fetch a list of Employees with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/companies/soluta/employees?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/companies/soluta/employees"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create a new Employee
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/companies/dolore/employees?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/companies/dolore/employees"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of Employees based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/companies/dolorum/employees/search?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"companyId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"personId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"isDraft\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
],
\"scopes\": [
{
\"name\": \"fieldNameFilter\",
\"parameters\": []
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/companies/dolorum/employees/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "companyId",
"operator": "=",
"value": "value"
},
{
"field": "personId",
"operator": "=",
"value": "value"
},
{
"field": "isDraft",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
],
"scopes": [
{
"name": "fieldNameFilter",
"parameters": []
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.App\ http\ resources\ api\ v1\ company field change resource
Fetch a list of App\ http\ resources\ api\ v1\ company field change resources based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/companies/praesentium/field-changes/search-custom?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"fieldName\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"changeId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"effectiveDate\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"status\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/companies/praesentium/field-changes/search-custom"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "fieldName",
"operator": "=",
"value": "value"
},
{
"field": "changeId",
"operator": "=",
"value": "value"
},
{
"field": "effectiveDate",
"operator": "=",
"value": "value"
},
{
"field": "status",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Employee field change
Fetch a list of Employee field changes based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/field-changes/search?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"effectiveDate\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"employeeId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"companyId\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/field-changes/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "effectiveDate",
"operator": "=",
"value": "value"
},
{
"field": "employeeId",
"operator": "=",
"value": "value"
},
{
"field": "companyId",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.App\ http\ resources\ api\ v1\ employee field change resource
Fetch a list of App\ http\ resources\ api\ v1\ employee field change resources based on the provided filters, scopes, sorting and pagination
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/employees/sapiente/field-changes/search-custom?page=1&pageSize=15&withSoftDeletes=1&include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"fieldName\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"changeId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"effectiveDate\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"status\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/employees/sapiente/field-changes/search-custom"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "fieldName",
"operator": "=",
"value": "value"
},
{
"field": "changeId",
"operator": "=",
"value": "value"
},
{
"field": "effectiveDate",
"operator": "=",
"value": "value"
},
{
"field": "status",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Employee field map
Fetch a list of Employee field maps based on the provided filters, scopes, sorting and pagination (Stability Score: 0.5)
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/field-mappings/search?page=1&pageSize=15&withSoftDeletes=1&include=company%2CexternalEmployeeField%2CemployeeField%2CexternalIntegration%2Corganization" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"filters\": [
{
\"field\": \"companyId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"employeeFieldId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"externalIntegrationId\",
\"operator\": \"=\",
\"value\": \"value\"
},
{
\"field\": \"organizationId\",
\"operator\": \"=\",
\"value\": \"value\"
}
],
\"sort\": [
{
\"field\": \"createdAt\",
\"direction\": \"asc\"
},
{
\"field\": \"updatedAt\",
\"direction\": \"asc\"
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/field-mappings/search"
);
const params = {
"page": "1",
"pageSize": "15",
"withSoftDeletes": "1",
"include": "company,externalEmployeeField,employeeField,externalIntegration,organization",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"filters": [
{
"field": "companyId",
"operator": "=",
"value": "value"
},
{
"field": "employeeFieldId",
"operator": "=",
"value": "value"
},
{
"field": "externalIntegrationId",
"operator": "=",
"value": "value"
},
{
"field": "organizationId",
"operator": "=",
"value": "value"
}
],
"sort": [
{
"field": "createdAt",
"direction": "asc"
},
{
"field": "updatedAt",
"direction": "asc"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Custom Endpoints
All other endpoints
Authentication
Authenticate (Stability Score: 0.1)
This endpoint lets you authenticate.
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/authenticate" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"url\": \"http:\\/\\/www.ebert.biz\\/enim-et-quia-dolores-ratione-modi-rerum.html\",
\"companyId\": \"molestiae\",
\"roleId\": 7,
\"access_token\": \"molestias\",
\"sensitive\": false,
\"useLatest\": false
}"
const url = new URL(
"http://localhost:8000/api/v1/authenticate"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"url": "http:\/\/www.ebert.biz\/enim-et-quia-dolores-ratione-modi-rerum.html",
"companyId": "molestiae",
"roleId": 7,
"access_token": "molestias",
"sensitive": false,
"useLatest": false
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (422):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Company molestiae does not exist. (and 1 more error)",
"errors": {
"companyId": [
"Company molestiae does not exist."
],
"roleId": [
"The selected role id is invalid."
]
},
"status": 422
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Logout
requires authentication
This endpoint lets you logout.
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/logout" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/logout"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.User (Stability Score: 0.1)
requires authentication
This endpoint lets you get the authenticated user.
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/user" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/user"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Receive the roles that the authenticated user has access to. (Stability Score: 0.1)
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/user/roles" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/user/roles"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Function Entities
Duplicate a function entity.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/function-entities/accusantium/duplicate?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/function-entities/accusantium/duplicate"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Grid Views
Duplicate a grid view.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/grid-views/vero/duplicate?include=grid%2Cactors" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/grid-views/vero/duplicate"
);
const params = {
"include": "grid,actors",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.SalaryWarning
Confirm a salary rule warning (Stability Score: 0.1)
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/salary-warnings/natus/confirm?include=employee%2CsalaryRule" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/salary-warnings/natus/confirm"
);
const params = {
"include": "employee,salaryRule",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Remove confirmation from a salary rule warning (Stability Score: 0.1)
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/salary-warnings/magnam/unconfirm?include=employee%2CsalaryRule" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/salary-warnings/magnam/unconfirm"
);
const params = {
"include": "employee,salaryRule",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Evaluate salary rules for a given period (Stability Score: 0.1)
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/execute-salary-rules?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/execute-salary-rules"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Users
Create a user. (Stability Score: 0.5)
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/users" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"quo\",
\"email\": \"carroll.peter@example.com\",
\"preferred_username\": \"omnis\",
\"user_id\": 1800457.0922873,
\"notificationPreferences\": [
[
[
\"inapp\"
]
]
]
}"
const url = new URL(
"http://localhost:8000/api/v1/users"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "quo",
"email": "carroll.peter@example.com",
"preferred_username": "omnis",
"user_id": 1800457.0922873,
"notificationPreferences": [
[
[
"inapp"
]
]
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a user. (Stability Score: 0.5)
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/users" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"notificationPreferences\": [
[
[
\"broadcast\"
]
]
],
\"id\": 367.21,
\"userId\": \"exblqhdpoblqrunhcxxv\",
\"user_id\": 10.504062448,
\"name\": \"ea\",
\"email\": \"dach.shaylee@example.org\",
\"family_name\": \"aut\",
\"given_name\": \"sunt\",
\"preferred_username\": \"provident\"
}"
const url = new URL(
"http://localhost:8000/api/v1/users"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"notificationPreferences": [
[
[
"broadcast"
]
]
],
"id": 367.21,
"userId": "exblqhdpoblqrunhcxxv",
"user_id": 10.504062448,
"name": "ea",
"email": "dach.shaylee@example.org",
"family_name": "aut",
"given_name": "sunt",
"preferred_username": "provident"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Notification
Mark all notifications as read
requires authentication
This endpoint lets you mark all notifications as read.
Example request:
curl --request POST \
"http://localhost:8000/api/v1/notifications/read-all?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/notifications/read-all"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Mark a notification as read by its ID (Stability Score: 0.1)
requires authentication
This endpoint lets you mark a notification as read.
Example request:
curl --request POST \
"http://localhost:8000/api/v1/notifications/sequi/read?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/notifications/sequi/read"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Mark a notification as not read by its ID (Stability Score: 0.1)
requires authentication
This endpoint lets you mark a notification as not read.
Example request:
curl --request POST \
"http://localhost:8000/api/v1/notifications/dolore/unread?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/notifications/dolore/unread"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.PayCode Mapping
Duplicate a payCode mapping
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/pay-code-mappings/iusto/duplicate" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"companyId\": \"ut\"
}"
const url = new URL(
"http://localhost:8000/api/v1/pay-code-mappings/iusto/duplicate"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"companyId": "ut"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Statistics
Transaction Statistics
requires authentication
This endpoint lets you get transaction statistics.
Example request:
curl --request POST \
"http://localhost:8000/api/v1/transactions/statistics" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"includeChildren\": true,
\"organizationId\": \"et\",
\"companyId\": \"molestias\"
}"
const url = new URL(
"http://localhost:8000/api/v1/transactions/statistics"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"includeChildren": true,
"organizationId": "et",
"companyId": "molestias"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Personal Card Profile
Duplicate a personal card profile
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/personal-card-profiles/rerum/duplicate?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"odit\",
\"description\": \"Fugiat voluptatem similique perspiciatis.\",
\"isGlobal\": \"velit\",
\"companyId\": \"non\"
}"
const url = new URL(
"http://localhost:8000/api/v1/personal-card-profiles/rerum/duplicate"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "odit",
"description": "Fugiat voluptatem similique perspiciatis.",
"isGlobal": "velit",
"companyId": "non"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Team Positions
Duplicate a Team Position
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/team-positions/neque/duplicate?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/team-positions/neque/duplicate"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Company
Duplicate a company
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/companies/unde/duplicate" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"parentCompanyId\": \"labore\"
}"
const url = new URL(
"http://localhost:8000/api/v1/companies/unde/duplicate"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"parentCompanyId": "labore"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Companies
Get all unique effective dates for a company.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/companies/animi/field-changes/unique-effective-dates" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/companies/animi/field-changes/unique-effective-dates"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Company Changes
Approve a field change for a particular company.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/companies/cupiditate/field-changes/approve-field-change" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"changeId\": \"et\",
\"recordId\": \"provident\"
}"
const url = new URL(
"http://localhost:8000/api/v1/companies/cupiditate/field-changes/approve-field-change"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"changeId": "et",
"recordId": "provident"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Approve multiple field changes for a particular company.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/companies/ut/field-changes/approve-field-change/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"changeId\": \"doloribus\",
\"recordId\": \"delectus\"
}"
const url = new URL(
"http://localhost:8000/api/v1/companies/ut/field-changes/approve-field-change/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"changeId": "doloribus",
"recordId": "delectus"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Deny a field change for a particular company.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/companies/sequi/field-changes/deny-field-change" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"changeId\": \"ut\",
\"recordId\": \"ipsum\"
}"
const url = new URL(
"http://localhost:8000/api/v1/companies/sequi/field-changes/deny-field-change"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"changeId": "ut",
"recordId": "ipsum"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Deny multiple field changes for a particular company.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/companies/fuga/field-changes/deny-field-change/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"changeId\": \"unde\",
\"recordId\": \"eos\"
}"
const url = new URL(
"http://localhost:8000/api/v1/companies/fuga/field-changes/deny-field-change/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"changeId": "unde",
"recordId": "eos"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Storage Structure
Create a new storage structure
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/storage-structure" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"directoryName\": \"enim\",
\"directoryParentId\": \"iste\"
}"
const url = new URL(
"http://localhost:8000/api/v1/storage-structure"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"directoryName": "enim",
"directoryParentId": "iste"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a list of storage structures with pagination
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/storage-structure" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/storage-structure"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a storage structure by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/storage-structure/consequatur" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/storage-structure/consequatur"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a storage structure by its ID
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/storage-structure/unde" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"directoryName\": \"laborum\",
\"directoryParentId\": \"est\"
}"
const url = new URL(
"http://localhost:8000/api/v1/storage-structure/unde"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"directoryName": "laborum",
"directoryParentId": "est"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a storage structure by its ID
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/storage-structure/ad" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/storage-structure/ad"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Employee Field Changes
Approve multiple field changes for a particular employee.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/field-changes/approve/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"changeId\": \"libero\",
\"recordId\": \"voluptatem\"
}"
const url = new URL(
"http://localhost:8000/api/v1/field-changes/approve/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"changeId": "libero",
"recordId": "voluptatem"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Deny multiple field changes for a particular employee.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/field-changes/deny/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"changeId\": \"sed\",
\"recordId\": \"iusto\"
}"
const url = new URL(
"http://localhost:8000/api/v1/field-changes/deny/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"changeId": "sed",
"recordId": "iusto"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Revert multiple field changes for a particular employee.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/field-changes/revert/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"changeId\": \"autem\",
\"recordId\": \"quia\"
}"
const url = new URL(
"http://localhost:8000/api/v1/field-changes/revert/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"changeId": "autem",
"recordId": "quia"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Revert field change for a particular employee.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/field-changes/revert" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"changeId\": \"et\",
\"recordId\": \"cum\"
}"
const url = new URL(
"http://localhost:8000/api/v1/field-changes/revert"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"changeId": "et",
"recordId": "cum"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Revert multiple pay code field changes for a particular employee.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/field-changes/revert/pay-code/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"changeId\": \"illo\",
\"recordId\": \"eveniet\"
}"
const url = new URL(
"http://localhost:8000/api/v1/field-changes/revert/pay-code/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"changeId": "illo",
"recordId": "eveniet"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Revert pay code field change for a particular employee.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/field-changes/revert/pay-code" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"changeId\": \"nam\",
\"recordId\": \"qui\"
}"
const url = new URL(
"http://localhost:8000/api/v1/field-changes/revert/pay-code"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"changeId": "nam",
"recordId": "qui"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Revert multiple employment field changes for a particular employee.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/field-changes/revert/employment/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"changeId\": \"itaque\",
\"recordId\": \"eveniet\"
}"
const url = new URL(
"http://localhost:8000/api/v1/field-changes/revert/employment/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"changeId": "itaque",
"recordId": "eveniet"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Revert employment field change for a particular employee.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/field-changes/revert/employment" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"changeId\": \"natus\",
\"recordId\": \"fugit\"
}"
const url = new URL(
"http://localhost:8000/api/v1/field-changes/revert/employment"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"changeId": "natus",
"recordId": "fugit"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Approve a field change for a particular employee.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/employees/pariatur/approve-field-change" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"changeId\": \"accusamus\",
\"recordId\": \"quae\"
}"
const url = new URL(
"http://localhost:8000/api/v1/employees/pariatur/approve-field-change"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"changeId": "accusamus",
"recordId": "quae"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Approve multiple field changes for a particular employee.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/employees/et/approve-field-change/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"changeId\": \"autem\",
\"recordId\": \"facere\"
}"
const url = new URL(
"http://localhost:8000/api/v1/employees/et/approve-field-change/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"changeId": "autem",
"recordId": "facere"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Deny a field change for a particular employee.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/employees/molestiae/deny-field-change" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"changeId\": \"consequatur\",
\"recordId\": \"explicabo\"
}"
const url = new URL(
"http://localhost:8000/api/v1/employees/molestiae/deny-field-change"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"changeId": "consequatur",
"recordId": "explicabo"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Deny multiple field changes for a particular employee.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/employees/voluptates/deny-field-change/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"changeId\": \"nisi\",
\"recordId\": \"qui\"
}"
const url = new URL(
"http://localhost:8000/api/v1/employees/voluptates/deny-field-change/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"changeId": "nisi",
"recordId": "qui"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Relatives
Create a new relative
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/employees/culpa/employee-relatives" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"firstName\": \"eos\",
\"lastName\": \"quis\",
\"emailAddress\": \"genoveva.pouros@example.net\",
\"telephone\": \"d{5,}\",
\"mobilePhone\": \"d{5,}\",
\"relationship\": \"voluptates\",
\"comment\": \"voluptate\"
}"
const url = new URL(
"http://localhost:8000/api/v1/employees/culpa/employee-relatives"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"firstName": "eos",
"lastName": "quis",
"emailAddress": "genoveva.pouros@example.net",
"telephone": "d{5,}",
"mobilePhone": "d{5,}",
"relationship": "voluptates",
"comment": "voluptate"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Relative Changes
Get changes for a particular relative.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/employees/ut/employee-relatives/sed/field-changes" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/employees/ut/employee-relatives/sed/field-changes"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Employee Relative Field Changes
Approve a field change for a particular employee.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/employees/ipsam/employee-relatives/aut/approve-field-change" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"changeId\": \"dolores\",
\"recordId\": \"quia\"
}"
const url = new URL(
"http://localhost:8000/api/v1/employees/ipsam/employee-relatives/aut/approve-field-change"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"changeId": "dolores",
"recordId": "quia"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Approve multiple field changes for a particular employee.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/employees/ipsam/employee-relatives/quaerat/approve-field-change/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"changeId\": \"consequuntur\",
\"recordId\": \"officiis\"
}"
const url = new URL(
"http://localhost:8000/api/v1/employees/ipsam/employee-relatives/quaerat/approve-field-change/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"changeId": "consequuntur",
"recordId": "officiis"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Deny a field change for a particular employee.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/employees/aut/employee-relatives/ut/deny-field-change" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"changeId\": \"ratione\",
\"recordId\": \"aspernatur\"
}"
const url = new URL(
"http://localhost:8000/api/v1/employees/aut/employee-relatives/ut/deny-field-change"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"changeId": "ratione",
"recordId": "aspernatur"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Deny multiple field changes for a particular employee.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/employees/sequi/employee-relatives/ipsam/deny-field-change/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"changeId\": \"deserunt\",
\"recordId\": \"sunt\"
}"
const url = new URL(
"http://localhost:8000/api/v1/employees/sequi/employee-relatives/ipsam/deny-field-change/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"changeId": "deserunt",
"recordId": "sunt"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Employee Future Changes
List all changes for a particular employee.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/employees/sit/future-changes" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/employees/sit/future-changes"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Employees
Get all unique effective dates for an employee.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/employees/ratione/field-changes/unique-effective-dates" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/employees/ratione/field-changes/unique-effective-dates"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create a new employee change
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/employees/facilis/field-changes" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"effectiveDate\": 0,
\"changeId\": \"quidem\",
\"changeType\": \"delete\",
\"fieldName\": \"cupiditate\",
\"oldValue\": \"qui\",
\"comment\": \"quia\"
}"
const url = new URL(
"http://localhost:8000/api/v1/employees/facilis/field-changes"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"effectiveDate": 0,
"changeId": "quidem",
"changeType": "delete",
"fieldName": "cupiditate",
"oldValue": "qui",
"comment": "quia"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create multiple employee changes
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/employees/sed/field-changes/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"effectiveDate\": 0,
\"changeId\": \"voluptatibus\",
\"changeType\": \"delete\",
\"fieldName\": \"illum\",
\"oldValue\": \"voluptatem\",
\"comment\": \"quod\"
}"
const url = new URL(
"http://localhost:8000/api/v1/employees/sed/field-changes/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"effectiveDate": 0,
"changeId": "voluptatibus",
"changeType": "delete",
"fieldName": "illum",
"oldValue": "voluptatem",
"comment": "quod"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Employment Changes
List all changes for a particular employee.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/employees/sint/field-changes/employment" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/employees/sint/field-changes/employment"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create a new change request for a particular employee.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/employees/repudiandae/field-changes/employment" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"effectiveDate\": 1,
\"changeId\": \"quisquam\",
\"changeType\": \"delete\",
\"fieldName\": \"assumenda\",
\"oldValue\": \"in\",
\"comment\": \"necessitatibus\"
}"
const url = new URL(
"http://localhost:8000/api/v1/employees/repudiandae/field-changes/employment"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"effectiveDate": 1,
"changeId": "quisquam",
"changeType": "delete",
"fieldName": "assumenda",
"oldValue": "in",
"comment": "necessitatibus"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create multiple change requests for a particular employee.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/employees/est/field-changes/employment/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"effectiveDate\": 1,
\"changeId\": \"consequatur\",
\"changeType\": \"delete\",
\"fieldName\": \"itaque\",
\"oldValue\": \"qui\",
\"comment\": \"asperiores\"
}"
const url = new URL(
"http://localhost:8000/api/v1/employees/est/field-changes/employment/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"effectiveDate": 1,
"changeId": "consequatur",
"changeType": "delete",
"fieldName": "itaque",
"oldValue": "qui",
"comment": "asperiores"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Approve a field change for a particular employee.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/employees/ipsam/field-changes/employment/approve-field-change" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"changeId\": \"occaecati\",
\"recordId\": \"accusantium\"
}"
const url = new URL(
"http://localhost:8000/api/v1/employees/ipsam/field-changes/employment/approve-field-change"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"changeId": "occaecati",
"recordId": "accusantium"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Approve multiple field changes for a particular employee.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/employees/sequi/field-changes/employment/approve-field-change/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"changeId\": \"explicabo\",
\"recordId\": \"illum\"
}"
const url = new URL(
"http://localhost:8000/api/v1/employees/sequi/field-changes/employment/approve-field-change/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"changeId": "explicabo",
"recordId": "illum"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Deny a field change for a particular employee.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/employees/suscipit/field-changes/employment/deny-field-change" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"changeId\": \"corporis\",
\"recordId\": \"aspernatur\"
}"
const url = new URL(
"http://localhost:8000/api/v1/employees/suscipit/field-changes/employment/deny-field-change"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"changeId": "corporis",
"recordId": "aspernatur"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Deny multiple field changes for a particular employee.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/employees/nulla/field-changes/employment/deny-field-change/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"changeId\": \"necessitatibus\",
\"recordId\": \"porro\"
}"
const url = new URL(
"http://localhost:8000/api/v1/employees/nulla/field-changes/employment/deny-field-change/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"changeId": "necessitatibus",
"recordId": "porro"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Pay Code Changes
Get all pay code changes.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/employees/ipsam/field-changes/pay-code" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/employees/ipsam/field-changes/pay-code"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create a new pay code change.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/employees/et/field-changes/pay-code" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"effectiveDate\": 0,
\"changeId\": \"sit\",
\"changeType\": \"delete\",
\"fieldName\": \"aut\",
\"comment\": \"et\"
}"
const url = new URL(
"http://localhost:8000/api/v1/employees/et/field-changes/pay-code"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"effectiveDate": 0,
"changeId": "sit",
"changeType": "delete",
"fieldName": "aut",
"comment": "et"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create multiple pay code changes.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/employees/sint/field-changes/pay-code/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"effectiveDate\": 1,
\"changeId\": \"sunt\",
\"changeType\": \"delete\",
\"fieldName\": \"et\",
\"comment\": \"distinctio\"
}"
const url = new URL(
"http://localhost:8000/api/v1/employees/sint/field-changes/pay-code/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"effectiveDate": 1,
"changeId": "sunt",
"changeType": "delete",
"fieldName": "et",
"comment": "distinctio"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Approve a field change for a particular employee.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/employees/nam/field-changes/pay-code/approve-field-change" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"changeId\": \"molestiae\",
\"recordId\": \"ut\"
}"
const url = new URL(
"http://localhost:8000/api/v1/employees/nam/field-changes/pay-code/approve-field-change"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"changeId": "molestiae",
"recordId": "ut"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Approve multiple field changes for a particular employee.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/employees/eveniet/field-changes/pay-code/approve-field-change/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"changeId\": \"dolores\",
\"recordId\": \"beatae\"
}"
const url = new URL(
"http://localhost:8000/api/v1/employees/eveniet/field-changes/pay-code/approve-field-change/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"changeId": "dolores",
"recordId": "beatae"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Deny a field change for a particular employee.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/employees/fugiat/field-changes/pay-code/deny-field-change" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"changeId\": \"officiis\",
\"recordId\": \"incidunt\"
}"
const url = new URL(
"http://localhost:8000/api/v1/employees/fugiat/field-changes/pay-code/deny-field-change"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"changeId": "officiis",
"recordId": "incidunt"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Deny multiple field changes for a particular employee.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/employees/alias/field-changes/pay-code/deny-field-change/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"changeId\": \"sit\",
\"recordId\": \"minus\"
}"
const url = new URL(
"http://localhost:8000/api/v1/employees/alias/field-changes/pay-code/deny-field-change/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"changeId": "sit",
"recordId": "minus"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Employee Field Mappings
Create a new employee field mapping.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/field-mappings" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"externalEmployeeFieldId\": \"nostrum\",
\"employeeFieldId\": \"quod\",
\"externalIntegrationId\": \"expedita\"
}"
const url = new URL(
"http://localhost:8000/api/v1/field-mappings"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"externalEmployeeFieldId": "nostrum",
"employeeFieldId": "quod",
"externalIntegrationId": "expedita"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create multiple employee field mappings.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/field-mappings/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"externalEmployeeFieldId\": \"eveniet\",
\"employeeFieldId\": \"sapiente\",
\"externalIntegrationId\": \"sit\"
}"
const url = new URL(
"http://localhost:8000/api/v1/field-mappings/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"externalEmployeeFieldId": "eveniet",
"employeeFieldId": "sapiente",
"externalIntegrationId": "sit"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update an employee field mapping.
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/field-mappings/doloribus" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"externalEmployeeFieldId\": \"non\",
\"externalIntegrationId\": \"ut\"
}"
const url = new URL(
"http://localhost:8000/api/v1/field-mappings/doloribus"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"externalEmployeeFieldId": "non",
"externalIntegrationId": "ut"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete an employee field mapping.
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/field-mappings/autem" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/field-mappings/autem"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Employee Fields
Get fields for a particular integration.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/external-integration/ut/employee-fields" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"isShow\": true,
\"isMandatory\": false,
\"salarySensitive\": false,
\"sensitive\": false,
\"allowNewValue\": true,
\"observe\": false,
\"importExcluded\": false,
\"manualInput\": true,
\"fieldType\": \"select\",
\"dataType\": \"decimal\",
\"maxInput\": 7095.99,
\"minInput\": 6.1
}"
const url = new URL(
"http://localhost:8000/api/v1/external-integration/ut/employee-fields"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"isShow": true,
"isMandatory": false,
"salarySensitive": false,
"sensitive": false,
"allowNewValue": true,
"observe": false,
"importExcluded": false,
"manualInput": true,
"fieldType": "select",
"dataType": "decimal",
"maxInput": 7095.99,
"minInput": 6.1
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Customize an existing global employee field for a particular integration.
requires authentication
Example request:
curl --request PUT \
"http://localhost:8000/api/v1/external-integration/pariatur/employee-fields/facilis" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"isShow\": false,
\"isMandatory\": true,
\"salarySensitive\": true,
\"sensitive\": true,
\"allowNewValue\": true,
\"observe\": true,
\"importExcluded\": false,
\"manualInput\": false,
\"fieldType\": \"password\",
\"dataType\": \"decimal\",
\"maxInput\": 1.82496819,
\"minInput\": 6003.176798309
}"
const url = new URL(
"http://localhost:8000/api/v1/external-integration/pariatur/employee-fields/facilis"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"isShow": false,
"isMandatory": true,
"salarySensitive": true,
"sensitive": true,
"allowNewValue": true,
"observe": true,
"importExcluded": false,
"manualInput": false,
"fieldType": "password",
"dataType": "decimal",
"maxInput": 1.82496819,
"minInput": 6003.176798309
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get an extended employee field for a particular integration.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/external-integration/accusantium/employee-fields/enim" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"isShow\": true,
\"isMandatory\": true,
\"salarySensitive\": false,
\"sensitive\": true,
\"allowNewValue\": false,
\"observe\": false,
\"importExcluded\": true,
\"manualInput\": true,
\"fieldType\": \"email\",
\"dataType\": \"number\",
\"maxInput\": 152135863.68,
\"minInput\": 2.92601
}"
const url = new URL(
"http://localhost:8000/api/v1/external-integration/accusantium/employee-fields/enim"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"isShow": true,
"isMandatory": true,
"salarySensitive": false,
"sensitive": true,
"allowNewValue": false,
"observe": false,
"importExcluded": true,
"manualInput": true,
"fieldType": "email",
"dataType": "number",
"maxInput": 152135863.68,
"minInput": 2.92601
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Revert an extended employee field for a particular integration.
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/external-integration/aut/employee-fields/tempora" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"isShow\": false,
\"isMandatory\": true,
\"salarySensitive\": false,
\"sensitive\": true,
\"allowNewValue\": true,
\"observe\": false,
\"importExcluded\": false,
\"manualInput\": false,
\"fieldType\": \"select\",
\"dataType\": \"number\",
\"maxInput\": 1324.4,
\"minInput\": 63250.8812539
}"
const url = new URL(
"http://localhost:8000/api/v1/external-integration/aut/employee-fields/tempora"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"isShow": false,
"isMandatory": true,
"salarySensitive": false,
"sensitive": true,
"allowNewValue": true,
"observe": false,
"importExcluded": false,
"manualInput": false,
"fieldType": "select",
"dataType": "number",
"maxInput": 1324.4,
"minInput": 63250.8812539
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get fields for a particular organization.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/organization/qui/employee-fields" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"isShow\": false,
\"isMandatory\": false,
\"salarySensitive\": false,
\"sensitive\": false,
\"allowNewValue\": false,
\"observe\": false,
\"importExcluded\": true,
\"manualInput\": true,
\"fieldType\": \"date\",
\"dataType\": \"boolean\",
\"maxInput\": 5332.328655,
\"minInput\": 0.894885
}"
const url = new URL(
"http://localhost:8000/api/v1/organization/qui/employee-fields"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"isShow": false,
"isMandatory": false,
"salarySensitive": false,
"sensitive": false,
"allowNewValue": false,
"observe": false,
"importExcluded": true,
"manualInput": true,
"fieldType": "date",
"dataType": "boolean",
"maxInput": 5332.328655,
"minInput": 0.894885
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Customize an existing global employee field for a particular organization.
requires authentication
Example request:
curl --request PUT \
"http://localhost:8000/api/v1/organization/ab/employee-fields/veritatis" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"isShow\": true,
\"isMandatory\": true,
\"salarySensitive\": false,
\"sensitive\": true,
\"allowNewValue\": true,
\"observe\": true,
\"importExcluded\": true,
\"manualInput\": false,
\"fieldType\": \"select\",
\"dataType\": \"number\",
\"maxInput\": 319582.6881,
\"minInput\": 12329039.3
}"
const url = new URL(
"http://localhost:8000/api/v1/organization/ab/employee-fields/veritatis"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"isShow": true,
"isMandatory": true,
"salarySensitive": false,
"sensitive": true,
"allowNewValue": true,
"observe": true,
"importExcluded": true,
"manualInput": false,
"fieldType": "select",
"dataType": "number",
"maxInput": 319582.6881,
"minInput": 12329039.3
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show an extended employee field for a particular organization.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/organization/aut/employee-fields/reprehenderit" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"isShow\": true,
\"isMandatory\": false,
\"salarySensitive\": true,
\"sensitive\": true,
\"allowNewValue\": true,
\"observe\": true,
\"importExcluded\": true,
\"manualInput\": true,
\"fieldType\": \"password\",
\"dataType\": \"boolean\",
\"maxInput\": 66979.9,
\"minInput\": 1.93536709
}"
const url = new URL(
"http://localhost:8000/api/v1/organization/aut/employee-fields/reprehenderit"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"isShow": true,
"isMandatory": false,
"salarySensitive": true,
"sensitive": true,
"allowNewValue": true,
"observe": true,
"importExcluded": true,
"manualInput": true,
"fieldType": "password",
"dataType": "boolean",
"maxInput": 66979.9,
"minInput": 1.93536709
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Revert an extended employee field for a particular organization.
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/organization/consequatur/employee-fields/magni" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"isShow\": false,
\"isMandatory\": true,
\"salarySensitive\": true,
\"sensitive\": false,
\"allowNewValue\": true,
\"observe\": true,
\"importExcluded\": true,
\"manualInput\": false,
\"fieldType\": \"radio\",
\"dataType\": \"boolean\",
\"maxInput\": 35746495.0694627,
\"minInput\": 269060.9
}"
const url = new URL(
"http://localhost:8000/api/v1/organization/consequatur/employee-fields/magni"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"isShow": false,
"isMandatory": true,
"salarySensitive": true,
"sensitive": false,
"allowNewValue": true,
"observe": true,
"importExcluded": true,
"manualInput": false,
"fieldType": "radio",
"dataType": "boolean",
"maxInput": 35746495.0694627,
"minInput": 269060.9
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Customize an existing global employee field for a particular company.
requires authentication
Example request:
curl --request PUT \
"http://localhost:8000/api/v1/company/cupiditate/employee-fields/quo" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"isShow\": true,
\"isMandatory\": true,
\"salarySensitive\": false,
\"sensitive\": true,
\"allowNewValue\": true,
\"observe\": true,
\"importExcluded\": false,
\"manualInput\": false,
\"fieldType\": \"password\",
\"dataType\": \"decimal\",
\"maxInput\": 740.39596,
\"minInput\": 2.90087906
}"
const url = new URL(
"http://localhost:8000/api/v1/company/cupiditate/employee-fields/quo"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"isShow": true,
"isMandatory": true,
"salarySensitive": false,
"sensitive": true,
"allowNewValue": true,
"observe": true,
"importExcluded": false,
"manualInput": false,
"fieldType": "password",
"dataType": "decimal",
"maxInput": 740.39596,
"minInput": 2.90087906
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Revert an extended employee field for a particular company.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/company/minus/employee-fields/accusamus/revert" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"isShow\": true,
\"isMandatory\": false,
\"salarySensitive\": true,
\"sensitive\": true,
\"allowNewValue\": true,
\"observe\": false,
\"importExcluded\": true,
\"manualInput\": false,
\"fieldType\": \"number\",
\"dataType\": \"date\",
\"maxInput\": 250222434.87367,
\"minInput\": 4.4
}"
const url = new URL(
"http://localhost:8000/api/v1/company/minus/employee-fields/accusamus/revert"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"isShow": true,
"isMandatory": false,
"salarySensitive": true,
"sensitive": true,
"allowNewValue": true,
"observe": false,
"importExcluded": true,
"manualInput": false,
"fieldType": "number",
"dataType": "date",
"maxInput": 250222434.87367,
"minInput": 4.4
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Revert extended employee fields and custom fields for a particular company.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/company/minima/employee-fields/revert-all" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"isShow\": false,
\"isMandatory\": true,
\"salarySensitive\": true,
\"sensitive\": true,
\"allowNewValue\": false,
\"observe\": true,
\"importExcluded\": false,
\"manualInput\": true,
\"fieldType\": \"textarea\",
\"dataType\": \"date\",
\"maxInput\": 0.1,
\"minInput\": 3752067.7897
}"
const url = new URL(
"http://localhost:8000/api/v1/company/minima/employee-fields/revert-all"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"isShow": false,
"isMandatory": true,
"salarySensitive": true,
"sensitive": true,
"allowNewValue": false,
"observe": true,
"importExcluded": false,
"manualInput": true,
"fieldType": "textarea",
"dataType": "date",
"maxInput": 0.1,
"minInput": 3752067.7897
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get an extended employee field for a particular company.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/company/eligendi/employee-fields/ab" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"isShow\": true,
\"isMandatory\": true,
\"salarySensitive\": true,
\"sensitive\": false,
\"allowNewValue\": true,
\"observe\": false,
\"importExcluded\": false,
\"manualInput\": true,
\"fieldType\": \"email\",
\"dataType\": \"decimal\",
\"maxInput\": 284.36900544,
\"minInput\": 428.3
}"
const url = new URL(
"http://localhost:8000/api/v1/company/eligendi/employee-fields/ab"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"isShow": true,
"isMandatory": true,
"salarySensitive": true,
"sensitive": false,
"allowNewValue": true,
"observe": false,
"importExcluded": false,
"manualInput": true,
"fieldType": "email",
"dataType": "decimal",
"maxInput": 284.36900544,
"minInput": 428.3
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get employee fields for a particular company.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/company/fugit/employee-fields" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"isShow\": false,
\"isMandatory\": true,
\"salarySensitive\": true,
\"sensitive\": false,
\"allowNewValue\": false,
\"observe\": true,
\"importExcluded\": false,
\"manualInput\": false,
\"fieldType\": \"checkbox\",
\"dataType\": \"boolean\",
\"maxInput\": 23.576897644,
\"minInput\": 70.65
}"
const url = new URL(
"http://localhost:8000/api/v1/company/fugit/employee-fields"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"isShow": false,
"isMandatory": true,
"salarySensitive": true,
"sensitive": false,
"allowNewValue": false,
"observe": true,
"importExcluded": false,
"manualInput": false,
"fieldType": "checkbox",
"dataType": "boolean",
"maxInput": 23.576897644,
"minInput": 70.65
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get employee fields for a particular company.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/company/voluptas/employee-fields" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"isShow\": false,
\"isMandatory\": false,
\"salarySensitive\": false,
\"sensitive\": false,
\"allowNewValue\": false,
\"observe\": true,
\"importExcluded\": false,
\"manualInput\": true,
\"fieldType\": \"checkbox\",
\"dataType\": \"date\",
\"maxInput\": 548165.41,
\"minInput\": 84,
\"maxLength\": 257.10683,
\"minLength\": 20.64036,
\"fieldName\": \"tdkedobytsh\",
\"combinedFieldIds\": [
\"nihil\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/company/voluptas/employee-fields"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"isShow": false,
"isMandatory": false,
"salarySensitive": false,
"sensitive": false,
"allowNewValue": false,
"observe": true,
"importExcluded": false,
"manualInput": true,
"fieldType": "checkbox",
"dataType": "date",
"maxInput": 548165.41,
"minInput": 84,
"maxLength": 257.10683,
"minLength": 20.64036,
"fieldName": "tdkedobytsh",
"combinedFieldIds": [
"nihil"
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update an employee field for a particular company.
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/company/adipisci/employee-fields/quas" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"isShow\": true,
\"isMandatory\": false,
\"salarySensitive\": false,
\"sensitive\": true,
\"allowNewValue\": true,
\"observe\": true,
\"importExcluded\": false,
\"manualInput\": true,
\"fieldType\": \"number\",
\"dataType\": \"string\",
\"maxInput\": 554,
\"minInput\": 459.487200469,
\"maxLength\": 93259.59359,
\"minLength\": 353463724.3,
\"combinedFieldIds\": [
\"sint\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/company/adipisci/employee-fields/quas"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"isShow": true,
"isMandatory": false,
"salarySensitive": false,
"sensitive": true,
"allowNewValue": true,
"observe": true,
"importExcluded": false,
"manualInput": true,
"fieldType": "number",
"dataType": "string",
"maxInput": 554,
"minInput": 459.487200469,
"maxLength": 93259.59359,
"minLength": 353463724.3,
"combinedFieldIds": [
"sint"
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete an employee field for a particular company.
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/company/nisi/employee-fields/omnis" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/company/nisi/employee-fields/omnis"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Revert an extended employee field for a particular organization.
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/organization/non/locales/quasi" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"dolores\",
\"code\": \"ratione\",
\"enabled\": true
}"
const url = new URL(
"http://localhost:8000/api/v1/organization/non/locales/quasi"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "dolores",
"code": "ratione",
"enabled": true
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Revert an extended employee field for a particular company.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/company/et/locales/et/revert" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"dolor\",
\"code\": \"qui\",
\"enabled\": true
}"
const url = new URL(
"http://localhost:8000/api/v1/company/et/locales/et/revert"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "dolor",
"code": "qui",
"enabled": true
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Field Groups
Create a global field group
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/field-groups" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"groupName\": \"minus\"
}"
const url = new URL(
"http://localhost:8000/api/v1/field-groups"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"groupName": "minus"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch all global field groups
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/field-groups" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/field-groups"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetch a global field group by its ID
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/field-groups/omnis" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/field-groups/omnis"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a global field group
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/field-groups/sunt" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"groupName\": \"eos\"
}"
const url = new URL(
"http://localhost:8000/api/v1/field-groups/sunt"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"groupName": "eos"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a global field group
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/field-groups/et" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/field-groups/et"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Add a field to a global field group
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/field-groups/earum/add-field" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"groupId\": \"voluptas\"
}"
const url = new URL(
"http://localhost:8000/api/v1/field-groups/earum/add-field"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"groupId": "voluptas"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Move a field from one global field group to another
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/field-groups/perspiciatis/move-field" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"oldGroupId\": \"impedit\",
\"newGroupId\": \"mollitia\"
}"
const url = new URL(
"http://localhost:8000/api/v1/field-groups/perspiciatis/move-field"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"oldGroupId": "impedit",
"newGroupId": "mollitia"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Remove a field from a global field group
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/field-groups/velit/remove-field" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"groupId\": \"quaerat\"
}"
const url = new URL(
"http://localhost:8000/api/v1/field-groups/velit/remove-field"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"groupId": "quaerat"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get fields groups for a particular integration.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/external-integration/sed/field-groups" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"groupName\": \"et\"
}"
const url = new URL(
"http://localhost:8000/api/v1/external-integration/sed/field-groups"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"groupName": "et"
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Customize an existing global field group for a particular integration.
requires authentication
Example request:
curl --request PUT \
"http://localhost:8000/api/v1/external-integration/aliquam/field-groups/et" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"groupName\": \"optio\"
}"
const url = new URL(
"http://localhost:8000/api/v1/external-integration/aliquam/field-groups/et"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"groupName": "optio"
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get a particular field group for a particular integration.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/external-integration/a/field-groups/qui" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"groupName\": \"omnis\"
}"
const url = new URL(
"http://localhost:8000/api/v1/external-integration/a/field-groups/qui"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"groupName": "omnis"
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Revert a customized global field group for a particular integration.
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/external-integration/et/field-groups/qui" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"groupName\": \"recusandae\"
}"
const url = new URL(
"http://localhost:8000/api/v1/external-integration/et/field-groups/qui"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"groupName": "recusandae"
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Add a field to a particular field group for a particular integration.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/external-integration/unde/field-groups/laudantium/add-field" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"groupId\": \"sed\"
}"
const url = new URL(
"http://localhost:8000/api/v1/external-integration/unde/field-groups/laudantium/add-field"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"groupId": "sed"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Move a field from a field group for a particular integration.
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/external-integration/eum/field-groups/dignissimos/move-field" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"oldGroupId\": \"ut\",
\"newGroupId\": \"rerum\"
}"
const url = new URL(
"http://localhost:8000/api/v1/external-integration/eum/field-groups/dignissimos/move-field"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"oldGroupId": "ut",
"newGroupId": "rerum"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Remove a field from a field group for a particular integration.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/external-integration/ad/field-groups/ab/remove-field" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"groupId\": \"voluptates\"
}"
const url = new URL(
"http://localhost:8000/api/v1/external-integration/ad/field-groups/ab/remove-field"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"groupId": "voluptates"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get fields groups for a particular organization.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/organization/eum/field-groups" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"groupName\": \"animi\"
}"
const url = new URL(
"http://localhost:8000/api/v1/organization/eum/field-groups"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"groupName": "animi"
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Customize an existing global field group for a particular organization.
requires authentication
Example request:
curl --request PUT \
"http://localhost:8000/api/v1/organization/fugit/field-groups/sunt" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"groupName\": \"veritatis\"
}"
const url = new URL(
"http://localhost:8000/api/v1/organization/fugit/field-groups/sunt"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"groupName": "veritatis"
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get a particular field group for a particular organization.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/organization/consequatur/field-groups/et" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"groupName\": \"natus\"
}"
const url = new URL(
"http://localhost:8000/api/v1/organization/consequatur/field-groups/et"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"groupName": "natus"
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Revert a customized field group for a particular organization.
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/organization/est/field-groups/natus" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"groupName\": \"nihil\"
}"
const url = new URL(
"http://localhost:8000/api/v1/organization/est/field-groups/natus"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"groupName": "nihil"
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Add a field to a particular field group for a particular organization.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/organization/similique/field-groups/et/add-field" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"groupId\": \"consequatur\"
}"
const url = new URL(
"http://localhost:8000/api/v1/organization/similique/field-groups/et/add-field"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"groupId": "consequatur"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Move a field from one field group to another for a particular organization.
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/organization/hic/field-groups/voluptate/move-field" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"oldGroupId\": \"reiciendis\",
\"newGroupId\": \"aut\"
}"
const url = new URL(
"http://localhost:8000/api/v1/organization/hic/field-groups/voluptate/move-field"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"oldGroupId": "reiciendis",
"newGroupId": "aut"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Remove a field from a particular field group for a particular organization.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/organization/voluptatum/field-groups/earum/remove-field" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"groupId\": \"perspiciatis\"
}"
const url = new URL(
"http://localhost:8000/api/v1/organization/voluptatum/field-groups/earum/remove-field"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"groupId": "perspiciatis"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get fields groups for a particular company.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/company/autem/field-groups" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/company/autem/field-groups"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Customize an existing global field group for a particular company.
requires authentication
Example request:
curl --request PUT \
"http://localhost:8000/api/v1/company/quia/field-groups/molestias" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"groupName\": \"beatae\"
}"
const url = new URL(
"http://localhost:8000/api/v1/company/quia/field-groups/molestias"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"groupName": "beatae"
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show a customized global field group for a particular company.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/company/et/field-groups/delectus" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"groupName\": \"non\"
}"
const url = new URL(
"http://localhost:8000/api/v1/company/et/field-groups/delectus"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"groupName": "non"
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Revert a customized global field group for a particular company.
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/company/atque/field-groups/et" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"groupName\": \"ad\"
}"
const url = new URL(
"http://localhost:8000/api/v1/company/atque/field-groups/et"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"groupName": "ad"
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Add a field to a field group for a particular company.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/company/est/field-groups/est/add-field" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"groupId\": \"ut\"
}"
const url = new URL(
"http://localhost:8000/api/v1/company/est/field-groups/est/add-field"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"groupId": "ut"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Move a field from one field group to another for a particular company.
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/company/ea/field-groups/ipsa/move-field" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"oldGroupId\": \"quis\",
\"newGroupId\": \"rerum\"
}"
const url = new URL(
"http://localhost:8000/api/v1/company/ea/field-groups/ipsa/move-field"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"oldGroupId": "quis",
"newGroupId": "rerum"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Remove a field from a field group for a particular company.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/company/voluptatem/field-groups/reprehenderit/remove-field" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"groupId\": \"corrupti\"
}"
const url = new URL(
"http://localhost:8000/api/v1/company/voluptatem/field-groups/reprehenderit/remove-field"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"groupId": "corrupti"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Locales
Get locales for a particular organization.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/organization/rem/locales" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"vero\",
\"code\": \"omnis\",
\"enabled\": false
}"
const url = new URL(
"http://localhost:8000/api/v1/organization/rem/locales"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "vero",
"code": "omnis",
"enabled": false
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Customize an existing global locale for a particular organization.
requires authentication
Example request:
curl --request PUT \
"http://localhost:8000/api/v1/organization/ut/locales/enim" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"sapiente\",
\"code\": \"eos\",
\"enabled\": true
}"
const url = new URL(
"http://localhost:8000/api/v1/organization/ut/locales/enim"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "sapiente",
"code": "eos",
"enabled": true
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show an extended locale for a particular organization.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/organization/dolorem/locales/et" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"labore\",
\"code\": \"omnis\",
\"enabled\": false
}"
const url = new URL(
"http://localhost:8000/api/v1/organization/dolorem/locales/et"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "labore",
"code": "omnis",
"enabled": false
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Customize an existing global locale for a particular company.
requires authentication
Example request:
curl --request PUT \
"http://localhost:8000/api/v1/company/dolores/locales/fugit" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"tenetur\",
\"code\": \"sed\",
\"enabled\": true
}"
const url = new URL(
"http://localhost:8000/api/v1/company/dolores/locales/fugit"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "tenetur",
"code": "sed",
"enabled": true
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show an extended locale for a particular company.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/company/facere/locales/qui" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"adipisci\",
\"code\": \"dignissimos\",
\"enabled\": false
}"
const url = new URL(
"http://localhost:8000/api/v1/company/facere/locales/qui"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "adipisci",
"code": "dignissimos",
"enabled": false
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get locales for a particular company.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/company/id/locales" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"veniam\",
\"code\": \"et\",
\"enabled\": true
}"
const url = new URL(
"http://localhost:8000/api/v1/company/id/locales"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "veniam",
"code": "et",
"enabled": true
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.EmployeeFieldMaps
Get employee field maps for a particular organization.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/organization/accusamus/employee-field-maps" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"externalEmployeeFieldId\": \"repellat\",
\"employeeFieldId\": \"quaerat\"
}"
const url = new URL(
"http://localhost:8000/api/v1/organization/accusamus/employee-field-maps"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"externalEmployeeFieldId": "repellat",
"employeeFieldId": "quaerat"
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Customize an existing global employee field map for a particular organization.
requires authentication
Example request:
curl --request PUT \
"http://localhost:8000/api/v1/organization/in/employee-field-maps/reiciendis" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"externalEmployeeFieldId\": \"non\",
\"employeeFieldId\": \"mollitia\"
}"
const url = new URL(
"http://localhost:8000/api/v1/organization/in/employee-field-maps/reiciendis"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"externalEmployeeFieldId": "non",
"employeeFieldId": "mollitia"
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show an extended employee field map for a particular organization.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/organization/aliquam/employee-field-maps/quo" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"externalEmployeeFieldId\": \"sunt\",
\"employeeFieldId\": \"culpa\"
}"
const url = new URL(
"http://localhost:8000/api/v1/organization/aliquam/employee-field-maps/quo"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"externalEmployeeFieldId": "sunt",
"employeeFieldId": "culpa"
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Revert an extended employee field map for a particular organization.
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/organization/omnis/employee-field-maps/odit" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"externalEmployeeFieldId\": \"aut\",
\"employeeFieldId\": \"et\"
}"
const url = new URL(
"http://localhost:8000/api/v1/organization/omnis/employee-field-maps/odit"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"externalEmployeeFieldId": "aut",
"employeeFieldId": "et"
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Customize an existing global employee field map for a particular company.
requires authentication
Example request:
curl --request PUT \
"http://localhost:8000/api/v1/company/voluptas/employee-field-maps/aliquam" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"externalEmployeeFieldId\": \"ducimus\",
\"employeeFieldId\": \"consequatur\"
}"
const url = new URL(
"http://localhost:8000/api/v1/company/voluptas/employee-field-maps/aliquam"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"externalEmployeeFieldId": "ducimus",
"employeeFieldId": "consequatur"
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Revert an extended employee field map for a particular company.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/company/unde/employee-field-maps/asperiores/revert" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"externalEmployeeFieldId\": \"esse\",
\"employeeFieldId\": \"dolor\"
}"
const url = new URL(
"http://localhost:8000/api/v1/company/unde/employee-field-maps/asperiores/revert"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"externalEmployeeFieldId": "esse",
"employeeFieldId": "dolor"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show an extended employee field map for a particular company.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/company/aut/employee-field-maps/totam" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"externalEmployeeFieldId\": \"omnis\",
\"employeeFieldId\": \"cupiditate\"
}"
const url = new URL(
"http://localhost:8000/api/v1/company/aut/employee-field-maps/totam"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"externalEmployeeFieldId": "omnis",
"employeeFieldId": "cupiditate"
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get employee field maps for a particular company.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/company/et/employee-field-maps" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"externalEmployeeFieldId\": \"tenetur\",
\"employeeFieldId\": \"reiciendis\"
}"
const url = new URL(
"http://localhost:8000/api/v1/company/et/employee-field-maps"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"externalEmployeeFieldId": "tenetur",
"employeeFieldId": "reiciendis"
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.PersonalCardProfiles
Customize an existing global personal card profile for an integration.
requires authentication
Example request:
curl --request PUT \
"http://localhost:8000/api/v1/external-integration/fugiat/personal-card-profiles/quas" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"ut\",
\"description\": \"Sapiente sit qui laudantium voluptas omnis architecto excepturi.\",
\"tabs\": [
{
\"order\": 40577.202534807,
\"personalCardProfileTabId\": \"nihil\",
\"grids\": [
{
\"order\": 105937.16556,
\"personalCardProfileTabGridId\": \"itaque\",
\"fieldGroupId\": \"nihil\",
\"fields\": [
{
\"order\": 464910.04717,
\"fieldId\": \"possimus\"
}
]
}
]
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/external-integration/fugiat/personal-card-profiles/quas"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "ut",
"description": "Sapiente sit qui laudantium voluptas omnis architecto excepturi.",
"tabs": [
{
"order": 40577.202534807,
"personalCardProfileTabId": "nihil",
"grids": [
{
"order": 105937.16556,
"personalCardProfileTabGridId": "itaque",
"fieldGroupId": "nihil",
"fields": [
{
"order": 464910.04717,
"fieldId": "possimus"
}
]
}
]
}
]
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Revert an extended personal card profile for an integration.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/external-integration/iure/personal-card-profiles/aliquid/revert" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"et\",
\"description\": \"Dolorem qui praesentium quia dolorem maiores expedita.\",
\"tabs\": [
{
\"order\": 1,
\"personalCardProfileTabId\": \"omnis\",
\"grids\": [
{
\"order\": 23.26744221,
\"personalCardProfileTabGridId\": \"ab\",
\"fieldGroupId\": \"dolor\",
\"fields\": [
{
\"order\": 15858,
\"fieldId\": \"non\"
}
]
}
]
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/external-integration/iure/personal-card-profiles/aliquid/revert"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "et",
"description": "Dolorem qui praesentium quia dolorem maiores expedita.",
"tabs": [
{
"order": 1,
"personalCardProfileTabId": "omnis",
"grids": [
{
"order": 23.26744221,
"personalCardProfileTabGridId": "ab",
"fieldGroupId": "dolor",
"fields": [
{
"order": 15858,
"fieldId": "non"
}
]
}
]
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show an extended personal card profile for an integration.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/external-integration/iure/personal-card-profiles/quae" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"deleniti\",
\"description\": \"Inventore molestiae voluptatum veniam deleniti.\",
\"tabs\": [
{
\"order\": 4310926.585052,
\"personalCardProfileTabId\": \"optio\",
\"grids\": [
{
\"order\": 0,
\"personalCardProfileTabGridId\": \"ipsam\",
\"fieldGroupId\": \"sed\",
\"fields\": [
{
\"order\": 383316.2,
\"fieldId\": \"est\"
}
]
}
]
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/external-integration/iure/personal-card-profiles/quae"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "deleniti",
"description": "Inventore molestiae voluptatum veniam deleniti.",
"tabs": [
{
"order": 4310926.585052,
"personalCardProfileTabId": "optio",
"grids": [
{
"order": 0,
"personalCardProfileTabGridId": "ipsam",
"fieldGroupId": "sed",
"fields": [
{
"order": 383316.2,
"fieldId": "est"
}
]
}
]
}
]
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get extended personal card profiles for an integration.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/external-integration/necessitatibus/personal-card-profiles" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"quisquam\",
\"description\": \"Doloribus aut et aliquid iure et.\",
\"tabs\": [
{
\"order\": 5394446.81971752,
\"personalCardProfileTabId\": \"voluptatum\",
\"grids\": [
{
\"order\": 236237.04926,
\"personalCardProfileTabGridId\": \"accusantium\",
\"fieldGroupId\": \"explicabo\",
\"fields\": [
{
\"order\": 3471358.53,
\"fieldId\": \"earum\"
}
]
}
]
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/external-integration/necessitatibus/personal-card-profiles"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "quisquam",
"description": "Doloribus aut et aliquid iure et.",
"tabs": [
{
"order": 5394446.81971752,
"personalCardProfileTabId": "voluptatum",
"grids": [
{
"order": 236237.04926,
"personalCardProfileTabGridId": "accusantium",
"fieldGroupId": "explicabo",
"fields": [
{
"order": 3471358.53,
"fieldId": "earum"
}
]
}
]
}
]
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Customize an existing global personal card profile for an organization.
requires authentication
Example request:
curl --request PUT \
"http://localhost:8000/api/v1/organization/omnis/personal-card-profiles/eum" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"voluptatem\",
\"description\": \"Vel iure deserunt neque deserunt veniam doloribus labore molestiae.\",
\"tabs\": [
{
\"order\": 18693.1599,
\"personalCardProfileTabId\": \"occaecati\",
\"grids\": [
{
\"order\": 45448.6,
\"personalCardProfileTabGridId\": \"vitae\",
\"fieldGroupId\": \"possimus\",
\"fields\": [
{
\"order\": 5737645.30019053,
\"fieldId\": \"libero\"
}
]
}
]
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/organization/omnis/personal-card-profiles/eum"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "voluptatem",
"description": "Vel iure deserunt neque deserunt veniam doloribus labore molestiae.",
"tabs": [
{
"order": 18693.1599,
"personalCardProfileTabId": "occaecati",
"grids": [
{
"order": 45448.6,
"personalCardProfileTabGridId": "vitae",
"fieldGroupId": "possimus",
"fields": [
{
"order": 5737645.30019053,
"fieldId": "libero"
}
]
}
]
}
]
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Revert an extended personal card profile for an organization.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/organization/quos/personal-card-profiles/in/revert" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"id\",
\"description\": \"Veniam aut quisquam delectus quo voluptas dolorum.\",
\"tabs\": [
{
\"order\": 99267,
\"personalCardProfileTabId\": \"dicta\",
\"grids\": [
{
\"order\": 130258.5963,
\"personalCardProfileTabGridId\": \"occaecati\",
\"fieldGroupId\": \"ducimus\",
\"fields\": [
{
\"order\": 0.8516,
\"fieldId\": \"sit\"
}
]
}
]
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/organization/quos/personal-card-profiles/in/revert"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "id",
"description": "Veniam aut quisquam delectus quo voluptas dolorum.",
"tabs": [
{
"order": 99267,
"personalCardProfileTabId": "dicta",
"grids": [
{
"order": 130258.5963,
"personalCardProfileTabGridId": "occaecati",
"fieldGroupId": "ducimus",
"fields": [
{
"order": 0.8516,
"fieldId": "sit"
}
]
}
]
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show an extended personal card profile for an organization.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/organization/quod/personal-card-profiles/exercitationem" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"voluptatem\",
\"description\": \"Error ut illo laboriosam nihil aut enim delectus aut.\",
\"tabs\": [
{
\"order\": 35.756475,
\"personalCardProfileTabId\": \"nobis\",
\"grids\": [
{
\"order\": 198041.188,
\"personalCardProfileTabGridId\": \"non\",
\"fieldGroupId\": \"dolorem\",
\"fields\": [
{
\"order\": 16804421.0237242,
\"fieldId\": \"culpa\"
}
]
}
]
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/organization/quod/personal-card-profiles/exercitationem"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "voluptatem",
"description": "Error ut illo laboriosam nihil aut enim delectus aut.",
"tabs": [
{
"order": 35.756475,
"personalCardProfileTabId": "nobis",
"grids": [
{
"order": 198041.188,
"personalCardProfileTabGridId": "non",
"fieldGroupId": "dolorem",
"fields": [
{
"order": 16804421.0237242,
"fieldId": "culpa"
}
]
}
]
}
]
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get extended personal card profiles for an organization.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/organization/incidunt/personal-card-profiles" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"hic\",
\"description\": \"Dolores minima laborum veritatis sit quae.\",
\"tabs\": [
{
\"order\": 98.44,
\"personalCardProfileTabId\": \"sunt\",
\"grids\": [
{
\"order\": 5147.358,
\"personalCardProfileTabGridId\": \"rerum\",
\"fieldGroupId\": \"eveniet\",
\"fields\": [
{
\"order\": 18827.137,
\"fieldId\": \"sit\"
}
]
}
]
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/organization/incidunt/personal-card-profiles"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "hic",
"description": "Dolores minima laborum veritatis sit quae.",
"tabs": [
{
"order": 98.44,
"personalCardProfileTabId": "sunt",
"grids": [
{
"order": 5147.358,
"personalCardProfileTabGridId": "rerum",
"fieldGroupId": "eveniet",
"fields": [
{
"order": 18827.137,
"fieldId": "sit"
}
]
}
]
}
]
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Customize an existing global personal card profile for a company.
requires authentication
Example request:
curl --request PUT \
"http://localhost:8000/api/v1/company/quod/personal-card-profiles/non" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"numquam\",
\"description\": \"Tenetur et commodi at aut.\",
\"tabs\": [
{
\"order\": 37668.618,
\"personalCardProfileTabId\": \"dolorem\",
\"grids\": [
{
\"order\": 2808415.268,
\"personalCardProfileTabGridId\": \"quasi\",
\"fieldGroupId\": \"ut\",
\"fields\": [
{
\"order\": 54.6,
\"fieldId\": \"incidunt\"
}
]
}
]
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/company/quod/personal-card-profiles/non"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "numquam",
"description": "Tenetur et commodi at aut.",
"tabs": [
{
"order": 37668.618,
"personalCardProfileTabId": "dolorem",
"grids": [
{
"order": 2808415.268,
"personalCardProfileTabGridId": "quasi",
"fieldGroupId": "ut",
"fields": [
{
"order": 54.6,
"fieldId": "incidunt"
}
]
}
]
}
]
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Revert an extended personal card profile for a company.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/company/eveniet/personal-card-profiles/expedita/revert" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"qui\",
\"description\": \"Deleniti aut id eum rem accusantium possimus voluptatem.\",
\"tabs\": [
{
\"order\": 115,
\"personalCardProfileTabId\": \"laboriosam\",
\"grids\": [
{
\"order\": 389373159.4034657,
\"personalCardProfileTabGridId\": \"vel\",
\"fieldGroupId\": \"voluptatem\",
\"fields\": [
{
\"order\": 0,
\"fieldId\": \"facilis\"
}
]
}
]
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/company/eveniet/personal-card-profiles/expedita/revert"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "qui",
"description": "Deleniti aut id eum rem accusantium possimus voluptatem.",
"tabs": [
{
"order": 115,
"personalCardProfileTabId": "laboriosam",
"grids": [
{
"order": 389373159.4034657,
"personalCardProfileTabGridId": "vel",
"fieldGroupId": "voluptatem",
"fields": [
{
"order": 0,
"fieldId": "facilis"
}
]
}
]
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show an extended personal card profile for a company.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/company/laudantium/personal-card-profiles/quia" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"libero\",
\"description\": \"Id autem cupiditate provident dolorem accusamus recusandae.\",
\"tabs\": [
{
\"order\": 14743102.56,
\"personalCardProfileTabId\": \"dicta\",
\"grids\": [
{
\"order\": 676317093.7505,
\"personalCardProfileTabGridId\": \"consequatur\",
\"fieldGroupId\": \"molestiae\",
\"fields\": [
{
\"order\": 586.15483761,
\"fieldId\": \"distinctio\"
}
]
}
]
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/company/laudantium/personal-card-profiles/quia"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "libero",
"description": "Id autem cupiditate provident dolorem accusamus recusandae.",
"tabs": [
{
"order": 14743102.56,
"personalCardProfileTabId": "dicta",
"grids": [
{
"order": 676317093.7505,
"personalCardProfileTabGridId": "consequatur",
"fieldGroupId": "molestiae",
"fields": [
{
"order": 586.15483761,
"fieldId": "distinctio"
}
]
}
]
}
]
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get extended personal card profiles for a company.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/company/beatae/personal-card-profiles" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"dolor\",
\"description\": \"Alias rem officiis porro corrupti delectus error qui esse.\",
\"tabs\": [
{
\"order\": 29526.81,
\"personalCardProfileTabId\": \"rerum\",
\"grids\": [
{
\"order\": 4476.059749,
\"personalCardProfileTabGridId\": \"explicabo\",
\"fieldGroupId\": \"error\",
\"fields\": [
{
\"order\": 71218781.4178,
\"fieldId\": \"odio\"
}
]
}
]
}
]
}"
const url = new URL(
"http://localhost:8000/api/v1/company/beatae/personal-card-profiles"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "dolor",
"description": "Alias rem officiis porro corrupti delectus error qui esse.",
"tabs": [
{
"order": 29526.81,
"personalCardProfileTabId": "rerum",
"grids": [
{
"order": 4476.059749,
"personalCardProfileTabGridId": "explicabo",
"fieldGroupId": "error",
"fields": [
{
"order": 71218781.4178,
"fieldId": "odio"
}
]
}
]
}
]
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Organization
List companies that can be used as parent companies in an organization (Stability Score: 0.5)
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/organizations/illo/available-parents?include=companies" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/organizations/illo/available-parents"
);
const params = {
"include": "companies",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Import
List companies for an Agda connection (Stability Score: 0.3)
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/import/agda-company-list/sit" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/import/agda-company-list/sit"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Import company details (Stability Score: 0.1)
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/import/company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"companyId\": \"quasi\",
\"companyIntegrationId\": \"omnis\",
\"async\": false
}"
const url = new URL(
"http://localhost:8000/api/v1/import/company"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"companyId": "quasi",
"companyIntegrationId": "omnis",
"async": false
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Import employees (Stability Score: 0.1)
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/import/employees" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"companyId\": \"dicta\",
\"companyIntegrationId\": \"at\",
\"async\": false
}"
const url = new URL(
"http://localhost:8000/api/v1/import/employees"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"companyId": "dicta",
"companyIntegrationId": "at",
"async": false
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Import roles (Stability Score: 0.1)
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/import/roles" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"companyId\": \"eaque\",
\"companyIntegrationId\": \"voluptatem\",
\"async\": true
}"
const url = new URL(
"http://localhost:8000/api/v1/import/roles"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"companyId": "eaque",
"companyIntegrationId": "voluptatem",
"async": true
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Import transactions. (Stability Score: 0.1)
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/import/transactions" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"companyId\": \"veritatis\",
\"companyIntegrationId\": \"possimus\",
\"period\": \"1652106\"
}"
const url = new URL(
"http://localhost:8000/api/v1/import/transactions"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"companyId": "veritatis",
"companyIntegrationId": "possimus",
"period": "1652106"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Import salary types.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/import/salary-types" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"companyId\": \"architecto\"
}"
const url = new URL(
"http://localhost:8000/api/v1/import/salary-types"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"companyId": "architecto"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Import transactions to the cloud.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/import/cloud/transactions" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/import/cloud/transactions"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Employee
Transfer Changes
requires authentication
This endpoint lets you transfer changes to the employee document
Example request:
curl --request POST \
"http://localhost:8000/api/v1/employees/transfer-changes" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/employees/transfer-changes"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Export
Export employees (Stability Score: 0.1)
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/export/employees" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"companyId\": \"aperiam\",
\"companyIntegrationId\": \"quaerat\",
\"recordIds\": [
\"doloremque\"
]
}"
const url = new URL(
"http://localhost:8000/api/v1/export/employees"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"companyId": "aperiam",
"companyIntegrationId": "quaerat",
"recordIds": [
"doloremque"
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Cache
Refresh the cache.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/cache/refresh" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/cache/refresh"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Warm the cache.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/cache/warm" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/cache/warm"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Clear the cache.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/cache/clear" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/cache/clear"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Real Time
Generate connection token for Centrifugo.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/real-time/connection-token" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/real-time/connection-token"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Generate subscription token for Centrifugo.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/real-time/subscription-token" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"channel\": \"fuga\"
}"
const url = new URL(
"http://localhost:8000/api/v1/real-time/subscription-token"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"channel": "fuga"
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.EndpointPermissions
Add/update an endpoint permission to/in an endpoint permission group. (Stability Score: 0.1)
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/permissions/endpoint-permission-groups/distinctio/assign" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"endpoint_id\": 12,
\"permission\": \"100\"
}"
const url = new URL(
"http://localhost:8000/api/v1/permissions/endpoint-permission-groups/distinctio/assign"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"endpoint_id": 12,
"permission": "100"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Remove and endpoint permission from an endpoint permission group. (Stability Score: 0.1)
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/permissions/endpoint-permission-groups/sint/remove" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"endpoint_id\": 19
}"
const url = new URL(
"http://localhost:8000/api/v1/permissions/endpoint-permission-groups/sint/remove"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"endpoint_id": 19
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get all available endpoints. (Stability Score: 0.1)
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/permissions/endpoints" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/permissions/endpoints"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Roles
Attach a personal card profile to a role.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/role-profiles/attach" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"role_id\": 473693617.28223,
\"personal_card_profile_id\": \"quia\",
\"company_id\": \"quia\"
}"
const url = new URL(
"http://localhost:8000/api/v1/role-profiles/attach"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"role_id": 473693617.28223,
"personal_card_profile_id": "quia",
"company_id": "quia"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Detach a personal card profile from a role.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/role-profiles/detach" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"role_id\": 6.567503709,
\"personal_card_profile_id\": \"et\",
\"company_id\": \"nam\"
}"
const url = new URL(
"http://localhost:8000/api/v1/role-profiles/detach"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"role_id": 6.567503709,
"personal_card_profile_id": "et",
"company_id": "nam"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Ability
Assign a role to a user. (Stability Score: 0.1)
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/abilities/roles/1/assign" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/abilities/roles/1/assign"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Retract a role from a user. (Stability Score: 0.1)
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/abilities/roles/1/retract" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/abilities/roles/1/retract"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Endpoints
Refresh endpoints list. (Stability Score: 0.5)
requires authentication
This endpoint lets you refresh the endpoints list.
Example request:
curl --request POST \
"http://localhost:8000/api/v1/refresh-endpoints" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/refresh-endpoints"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Endpoints
All other endpoints
Filters, sorts, and fetches the list of resources.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/permissions/endpoint-permission-groups/search" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/permissions/endpoint-permission-groups/search"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Creates a batch of new resources in a transaction-safe way.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/permissions/endpoint-permission-groups/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": []
}"
const url = new URL(
"http://localhost:8000/api/v1/permissions/endpoint-permission-groups/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": []
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a batch of resources in a transaction-safe way.
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/permissions/endpoint-permission-groups/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": []
}"
const url = new URL(
"http://localhost:8000/api/v1/permissions/endpoint-permission-groups/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": []
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Deletes a batch of resources in a transaction-safe way.
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/permissions/endpoint-permission-groups/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/permissions/endpoint-permission-groups/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetches the list of resources.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/permissions/endpoint-permission-groups" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/permissions/endpoint-permission-groups"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Creates new resource in a transaction-safe way.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/permissions/endpoint-permission-groups" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/permissions/endpoint-permission-groups"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetches resource.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/permissions/endpoint-permission-groups/natus" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/permissions/endpoint-permission-groups/natus"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a resource in a transaction-safe way.
requires authentication
Example request:
curl --request PUT \
"http://localhost:8000/api/v1/permissions/endpoint-permission-groups/sapiente" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/permissions/endpoint-permission-groups/sapiente"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Deletes a resource.
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/permissions/endpoint-permission-groups/in" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/permissions/endpoint-permission-groups/in"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Filters, sorts, and fetches the list of resources.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/permissions/endpoint-permissions/search" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/permissions/endpoint-permissions/search"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Creates a batch of new resources in a transaction-safe way.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/permissions/endpoint-permissions/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": []
}"
const url = new URL(
"http://localhost:8000/api/v1/permissions/endpoint-permissions/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": []
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a batch of resources in a transaction-safe way.
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/permissions/endpoint-permissions/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": []
}"
const url = new URL(
"http://localhost:8000/api/v1/permissions/endpoint-permissions/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": []
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Deletes a batch of resources in a transaction-safe way.
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/permissions/endpoint-permissions/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/permissions/endpoint-permissions/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetches the list of resources.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/permissions/endpoint-permissions" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/permissions/endpoint-permissions"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Creates new resource in a transaction-safe way.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/permissions/endpoint-permissions" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/permissions/endpoint-permissions"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetches resource.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/permissions/endpoint-permissions/nostrum" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/permissions/endpoint-permissions/nostrum"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a resource in a transaction-safe way.
requires authentication
Example request:
curl --request PUT \
"http://localhost:8000/api/v1/permissions/endpoint-permissions/necessitatibus" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/permissions/endpoint-permissions/necessitatibus"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Deletes a resource.
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/permissions/endpoint-permissions/consequuntur" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/permissions/endpoint-permissions/consequuntur"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Creates a batch of new resources in a transaction-safe way.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/pg-users/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": []
}"
const url = new URL(
"http://localhost:8000/api/v1/pg-users/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": []
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a batch of resources in a transaction-safe way.
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/pg-users/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": []
}"
const url = new URL(
"http://localhost:8000/api/v1/pg-users/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": []
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Deletes a batch of resources in a transaction-safe way.
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/pg-users/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/pg-users/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Restores a batch of resources in a transaction-safe way.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/pg-users/batch/restore" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/pg-users/batch/restore"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Filters, sorts, and fetches the list of resources.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/abilities/roles/search" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/abilities/roles/search"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Creates a batch of new resources in a transaction-safe way.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/abilities/roles/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": []
}"
const url = new URL(
"http://localhost:8000/api/v1/abilities/roles/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": []
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a batch of resources in a transaction-safe way.
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/abilities/roles/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": []
}"
const url = new URL(
"http://localhost:8000/api/v1/abilities/roles/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": []
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Deletes a batch of resources in a transaction-safe way.
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/abilities/roles/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/abilities/roles/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetches the list of resources.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/abilities/roles" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/abilities/roles"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Creates new resource in a transaction-safe way.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/abilities/roles" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/abilities/roles"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetches resource.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/abilities/roles/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/abilities/roles/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a resource in a transaction-safe way.
requires authentication
Example request:
curl --request PUT \
"http://localhost:8000/api/v1/abilities/roles/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/abilities/roles/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Deletes a resource.
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/abilities/roles/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/abilities/roles/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Orion Endpoints
Filters, sorts, and fetches the list of resources.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/orion/transactions/search" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/orion/transactions/search"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Creates a batch of new resources in a transaction-safe way.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/orion/transactions/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": []
}"
const url = new URL(
"http://localhost:8000/api/v1/orion/transactions/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": []
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a batch of resources in a transaction-safe way.
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/orion/transactions/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"resources\": []
}"
const url = new URL(
"http://localhost:8000/api/v1/orion/transactions/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"resources": []
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Deletes a batch of resources in a transaction-safe way.
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/orion/transactions/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/orion/transactions/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetches the list of resources.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/orion/transactions" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/orion/transactions"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Creates new resource in a transaction-safe way.
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/orion/transactions" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/orion/transactions"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Fetches resource.
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/orion/transactions/maxime" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/orion/transactions/maxime"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a resource in a transaction-safe way.
requires authentication
Example request:
curl --request PUT \
"http://localhost:8000/api/v1/orion/transactions/et" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/orion/transactions/et"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Deletes a resource.
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/orion/transactions/dolores" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/orion/transactions/dolores"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Uncategorized Endpoints
All other endpoints
GET api/octane-firebase-concurrently
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/octane-firebase-concurrently" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/octane-firebase-concurrently"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.PATCH api/v1/user
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/user" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/user"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PATCH",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.POST api/v1/admin/createToken
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/admin/createToken" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/admin/createToken"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.POST api/v1/websocket
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/websocket" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/websocket"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.GET api/v1/queue/jobs
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/queue/jobs" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/queue/jobs"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.GET api/v1/queue/jobs/trigger-failing
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/queue/jobs/trigger-failing" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/queue/jobs/trigger-failing"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.GET api/v1/queue/jobs/{jobId}
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/queue/jobs/voluptatem" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/queue/jobs/voluptatem"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.GET api/v1/queue/jobs_uuid/{jobId}
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/queue/jobs_uuid/sint" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/queue/jobs_uuid/sint"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.POST api/v1/queue/jobs/{jobId}/retry
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/queue/jobs/cum/retry" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/queue/jobs/cum/retry"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.POST api/v1/behaviour/dispatch
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/behaviour/dispatch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/behaviour/dispatch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.POST api/v1/persons/{personId}/merge
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/persons/a/merge?include=companies%2Cemployees" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/persons/a/merge"
);
const params = {
"include": "companies,employees",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.POST api/v1/exports/{exportId}/revert
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/exports/corrupti/revert?include=" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/exports/corrupti/revert"
);
const params = {
"include": "",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.POST api/v1/companies/{companyId}/employees/apply-changes
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/companies/modi/employees/apply-changes" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/companies/modi/employees/apply-changes"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.POST api/v1/companies/{companyId}/recalculate-is-draft
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/companies/quia/recalculate-is-draft?include=companies%2CfieldMaps%2CcompanyIntegration%2CcompanyIntegration.externalIntegration%2CparentCompany%2CdefaultGridView%2Ccountry%2Cteams%2CcustomerTypes" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/companies/quia/recalculate-is-draft"
);
const params = {
"include": "companies,fieldMaps,companyIntegration,companyIntegration.externalIntegration,parentCompany,defaultGridView,country,teams,customerTypes",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.POST api/v1/companies/{companyId}/field-changes
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/companies/inventore/field-changes" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"effectiveDate\": 1,
\"changeId\": \"eos\",
\"changeType\": \"delete\",
\"fieldName\": \"similique\",
\"oldValue\": \"vero\",
\"comment\": \"eius\"
}"
const url = new URL(
"http://localhost:8000/api/v1/companies/inventore/field-changes"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"effectiveDate": 1,
"changeId": "eos",
"changeType": "delete",
"fieldName": "similique",
"oldValue": "vero",
"comment": "eius"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.POST api/v1/companies/{companyId}/field-changes/batch
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/companies/amet/field-changes/batch" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"effectiveDate\": 1,
\"changeId\": \"enim\",
\"changeType\": \"delete\",
\"fieldName\": \"neque\",
\"oldValue\": \"ea\",
\"comment\": \"et\"
}"
const url = new URL(
"http://localhost:8000/api/v1/companies/amet/field-changes/batch"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"effectiveDate": 1,
"changeId": "enim",
"changeType": "delete",
"fieldName": "neque",
"oldValue": "ea",
"comment": "et"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.POST api/v1/company-transfer
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/company-transfer" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/company-transfer"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.POST api/v1/pg-users/search
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/pg-users/search" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/pg-users/search"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.GET api/v1/pg-users
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/pg-users" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/pg-users"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.POST api/v1/pg-users
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/pg-users" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/pg-users"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.GET api/v1/pg-users/{id}
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/v1/pg-users/eum" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/pg-users/eum"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.PUT api/v1/pg-users/{id}
requires authentication
Example request:
curl --request PUT \
"http://localhost:8000/api/v1/pg-users/consequuntur" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/pg-users/consequuntur"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.DELETE api/v1/pg-users/{id}
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/v1/pg-users/consequatur" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/pg-users/consequatur"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.POST api/v1/pg-users/{pg_user}/restore
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/pg-users/voluptatem/restore" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/pg-users/voluptatem/restore"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.POST api/v1/role-profiles/search
requires authentication
Example request:
curl --request POST \
"http://localhost:8000/api/v1/role-profiles/search" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/role-profiles/search"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.PATCH api/v1/role-profiles/{roleProfileId}
requires authentication
Example request:
curl --request PATCH \
"http://localhost:8000/api/v1/role-profiles/error" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/v1/role-profiles/error"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PATCH",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.