Introduction

This documentation aims to provide all the information you need to work with our API.

<aside>As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile).
You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).</aside>

Authenticating requests

This API is not authenticated.

Endpoints

GET api/v1

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1"
);

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

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

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Server Error"
}
 

Request    Try it out ⚡   

GET api/v1

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/transaction/type/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/transaction/type/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/transaction/type/enum"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/transaction/type/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/appointment/status/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/appointment/status/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/appointment/status/enum"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/appointment/status/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/appointment/available/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/appointment/available/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/appointment/available/enum"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/appointment/available/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/appointment/frequency/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/appointment/frequency/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/appointment/frequency/enum"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/appointment/frequency/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/appointment/recurrence_frequency/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/appointment/recurrence_frequency/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/appointment/recurrence_frequency/enum"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/appointment/recurrence_frequency/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/appointment/recurrence_limit/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/appointment/recurrence_limit/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/appointment/recurrence_limit/enum"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/appointment/recurrence_limit/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/inscription

Example request:

curl --request POST \
    "http://core.localhost/api/v1/inscription" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"society\": \"vmqeopfuudtdsufvyvddq\",
    \"ifu_number\": \"amniihfqcoynlazghdtqt\",
    \"society_email\": \"andreanne00@example.org\",
    \"society_phone\": \"wbpilpmufinllwloauydl\",
    \"society_phone_code\": \"smsjuryvojcybzvrbyick\",
    \"responsable_gender\": \"female\",
    \"responsable_lastname\": \"znkygloigmkwxphlvazjr\",
    \"responsable_firstname\": \"cnfbaqywuxhgjjmzuxjub\",
    \"responsable_email\": \"oma98@example.net\",
    \"responsable_phone\": \"wiwxtrkimfcatbxsp\",
    \"responsable_phone_code\": \"zmraz\",
    \"address\": \"sroyjpxmqesedyghenqco\",
    \"city\": \"pwvownkbamlnfngefbeil\",
    \"zipcode\": \"fzsyuxoezbdtabptcyyer\",
    \"tva_number\": \"evrljcbwkthjnescwsest\",
    \"rccm_number\": \"couxpqsydkigioyoyprjk\",
    \"gender\": \"male\",
    \"lastname\": \"fdjsneawgaavuiwlezlcr\",
    \"firstname\": \"aoooxrrjhbduowtbaqrrt\",
    \"email\": \"ena.sanford@example.net\",
    \"phone\": \"ujtzcirplnfqsaymx\",
    \"phone_code\": \"payeb\",
    \"website\": \"lqozckazplqjijwkuzgpj\",
    \"country_id\": \"3d811a06-afda-3339-b1d9-5fd26000af91\",
    \"currency_id\": \"8fea7898-b6d7-3ee2-b99b-9e0c1a090a3e\",
    \"siren\": \"fsmqnmbek\",
    \"siret\": \"hsobzoqisjmbiu\",
    \"capital\": 58,
    \"headquarters_address\": \"xdnvttnwpjqkxxmutyzaa\",
    \"legal_form\": \"dbjkbosusobdoqhlrecwg\"
}"

const url = new URL(
    "http://core.localhost/api/v1/inscription"
);

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

let body = {
    "society": "vmqeopfuudtdsufvyvddq",
    "ifu_number": "amniihfqcoynlazghdtqt",
    "society_email": "andreanne00@example.org",
    "society_phone": "wbpilpmufinllwloauydl",
    "society_phone_code": "smsjuryvojcybzvrbyick",
    "responsable_gender": "female",
    "responsable_lastname": "znkygloigmkwxphlvazjr",
    "responsable_firstname": "cnfbaqywuxhgjjmzuxjub",
    "responsable_email": "oma98@example.net",
    "responsable_phone": "wiwxtrkimfcatbxsp",
    "responsable_phone_code": "zmraz",
    "address": "sroyjpxmqesedyghenqco",
    "city": "pwvownkbamlnfngefbeil",
    "zipcode": "fzsyuxoezbdtabptcyyer",
    "tva_number": "evrljcbwkthjnescwsest",
    "rccm_number": "couxpqsydkigioyoyprjk",
    "gender": "male",
    "lastname": "fdjsneawgaavuiwlezlcr",
    "firstname": "aoooxrrjhbduowtbaqrrt",
    "email": "ena.sanford@example.net",
    "phone": "ujtzcirplnfqsaymx",
    "phone_code": "payeb",
    "website": "lqozckazplqjijwkuzgpj",
    "country_id": "3d811a06-afda-3339-b1d9-5fd26000af91",
    "currency_id": "8fea7898-b6d7-3ee2-b99b-9e0c1a090a3e",
    "siren": "fsmqnmbek",
    "siret": "hsobzoqisjmbiu",
    "capital": 58,
    "headquarters_address": "xdnvttnwpjqkxxmutyzaa",
    "legal_form": "dbjkbosusobdoqhlrecwg"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/inscription

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

society   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

ifu_number   string   

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

society_email   string   

Must be a valid email address. Must match the regex /^.+@.+$/i. Must not be greater than 255 characters. Example: andreanne00@example.org

society_phone   string   

Must not be greater than 255 characters. Example: wbpilpmufinllwloauydl

society_phone_code   string   

Must not be greater than 255 characters. Example: smsjuryvojcybzvrbyick

responsable_gender   string   

Example: female

Must be one of:

• male
• female

responsable_lastname   string   

Must not be greater than 255 characters. Example: znkygloigmkwxphlvazjr

responsable_firstname   string   

Must not be greater than 255 characters. Example: cnfbaqywuxhgjjmzuxjub

responsable_email   string   

Must be a valid email address. Must not be greater than 255 characters. Example: oma98@example.net

responsable_phone   string  optional  

This field is required when responsable_phone_code is present. Must not be greater than 20 characters. Example: wiwxtrkimfcatbxsp

responsable_phone_code   string  optional  

This field is required when responsable_phone is present. Must not be greater than 5 characters. Example: zmraz

address   string   

Must not be greater than 255 characters. Example: sroyjpxmqesedyghenqco

city   string   

Must not be greater than 255 characters. Example: pwvownkbamlnfngefbeil

zipcode   string  optional  

Must not be greater than 255 characters. Example: fzsyuxoezbdtabptcyyer

tva_number   string  optional  

Must not be greater than 255 characters. Example: evrljcbwkthjnescwsest

rccm_number   string   

Must not be greater than 255 characters. Example: couxpqsydkigioyoyprjk

gender   string   

Example: male

Must be one of:

• male
• female

lastname   string   

Must not be greater than 255 characters. Example: fdjsneawgaavuiwlezlcr

firstname   string   

Must not be greater than 255 characters. Example: aoooxrrjhbduowtbaqrrt

email   string   

Must be a valid email address. Must not be greater than 255 characters. Example: ena.sanford@example.net

phone   string  optional  

This field is required when phone_code is present. Must not be greater than 20 characters. Example: ujtzcirplnfqsaymx

phone_code   string  optional  

This field is required when phone is present. Must not be greater than 5 characters. Example: payeb

website   string  optional  

Must not be greater than 255 characters. Example: lqozckazplqjijwkuzgpj

country_id   string   

Must be a valid UUID. The id of an existing record in the countries table. Example: 3d811a06-afda-3339-b1d9-5fd26000af91

currency_id   string   

Must be a valid UUID. The id of an existing record in the currencies table. Example: 8fea7898-b6d7-3ee2-b99b-9e0c1a090a3e

siren   string  optional  

Must match the regex /^\d{9}$/. Must be 9 characters. Example: fsmqnmbek

siret   string  optional  

Must match the regex /^\d{14}$/. Must be 14 characters. Example: hsobzoqisjmbiu

capital   number  optional  

Must be at least 0. Example: 58

headquarters_address   string  optional  

Must not be greater than 255 characters. Example: xdnvttnwpjqkxxmutyzaa

legal_form   string  optional  

Must not be greater than 100 characters. Example: dbjkbosusobdoqhlrecwg

GET api/v1/get/countries

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/countries" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/countries"
);

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

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

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Server Error"
}
 

Request    Try it out ⚡   

GET api/v1/get/countries

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/currencies/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/currencies/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/currencies/collection"
);

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

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

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Server Error"
}
 

Request    Try it out ⚡   

GET api/v1/get/currencies/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/gender/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/gender/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/gender/enum"
);

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

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

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Server Error"
}
 

Request    Try it out ⚡   

GET api/v1/get/gender/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

PATCH api/v1/update/company

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/company" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "society=vmqeopfuudtdsufvyvddq"\
    --form "society_email=kunde.eloisa@example.com"\
    --form "address=hfqcoynlazghdtqtqxbaj"\
    --form "city=wbpilpmufinllwloauydl"\
    --form "zipcode=smsjuryvojcybzvrbyick"\
    --form "society_phone=znkygloigmkwxphlv"\
    --form "society_phone_code=azjrc"\
    --form "website=nfbaqywuxhgjjmzuxjubq"\
    --form "currency_id=consequatur"\
    --form "siren=mqeopfuud"\
    --form "siret=tdsufvyvddqamn"\
    --form "capital=28"\
    --form "headquarters_address=ihfqcoynlazghdtqtqxba"\
    --form "legal_form=jwbpilpmufinllwloauyd"\
    --form "logo=@/tmp/phpkRLlX0" 

const url = new URL(
    "http://core.localhost/api/v1/update/company"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('society', 'vmqeopfuudtdsufvyvddq');
body.append('society_email', 'kunde.eloisa@example.com');
body.append('address', 'hfqcoynlazghdtqtqxbaj');
body.append('city', 'wbpilpmufinllwloauydl');
body.append('zipcode', 'smsjuryvojcybzvrbyick');
body.append('society_phone', 'znkygloigmkwxphlv');
body.append('society_phone_code', 'azjrc');
body.append('website', 'nfbaqywuxhgjjmzuxjubq');
body.append('currency_id', 'consequatur');
body.append('siren', 'mqeopfuud');
body.append('siret', 'tdsufvyvddqamn');
body.append('capital', '28');
body.append('headquarters_address', 'ihfqcoynlazghdtqtqxba');
body.append('legal_form', 'jwbpilpmufinllwloauyd');
body.append('logo', document.querySelector('input[name="logo"]').files[0]);

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

Request    Try it out ⚡   

PATCH api/v1/update/company

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

society   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

society_email   string  optional  

Must be a valid email address. Must match the regex /^.+@.+$/i. Must not be greater than 255 characters. Example: kunde.eloisa@example.com

address   string   

Must not be greater than 255 characters. Example: hfqcoynlazghdtqtqxbaj

city   string   

Must not be greater than 255 characters. Example: wbpilpmufinllwloauydl

zipcode   string  optional  

Must not be greater than 255 characters. Example: smsjuryvojcybzvrbyick

society_phone   string  optional  

This field is required when phone_code is present. Must not be greater than 20 characters. Example: znkygloigmkwxphlv

society_phone_code   string  optional  

This field is required when phone is present. Must not be greater than 5 characters. Example: azjrc

website   string  optional  

Must not be greater than 255 characters. Example: nfbaqywuxhgjjmzuxjubq

currency_id   string  optional  

Example: consequatur

logo   file  optional  

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/phpkRLlX0

siren   string  optional  

Must match the regex /^\d{9}$/. Must be 9 characters. Example: mqeopfuud

siret   string  optional  

Must match the regex /^\d{14}$/. Must be 14 characters. Example: tdsufvyvddqamn

capital   number  optional  

Must be at least 0. Example: 28

headquarters_address   string   

Must not be greater than 255 characters. Example: ihfqcoynlazghdtqtqxba

legal_form   string   

Must not be greater than 100 characters. Example: jwbpilpmufinllwloauyd

GET api/v1/get/banks/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/banks/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/banks/collection"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/banks/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/bank

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/bank" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"bank_name\": \"vmqeopfuudtdsufvyvddq\",
    \"account_holder_name\": \"amniihfqcoynlazghdtqt\",
    \"rib\": \"qxbajwbpilpmufinllwlo\",
    \"iban\": \"auydlsmsjuryvojcybzvr\",
    \"bic\": \"byickznky\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/bank"
);

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

let body = {
    "bank_name": "vmqeopfuudtdsufvyvddq",
    "account_holder_name": "amniihfqcoynlazghdtqt",
    "rib": "qxbajwbpilpmufinllwlo",
    "iban": "auydlsmsjuryvojcybzvr",
    "bic": "byickznky"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/bank

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

bank_name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

account_holder_name   string   

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

rib   string  optional  

Must not be greater than 255 characters. Example: qxbajwbpilpmufinllwlo

iban   string  optional  

Must not be greater than 34 characters. Example: auydlsmsjuryvojcybzvr

bic   string  optional  

Must not be greater than 11 characters. Example: byickznky

PATCH api/v1/update/{bankDetail}/bank

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/bank" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"bank_name\": \"vmqeopfuudtdsufvyvddq\",
    \"account_holder_name\": \"amniihfqcoynlazghdtqt\",
    \"rib\": \"qxbajwbpilpmufinllwlo\",
    \"iban\": \"auydlsmsjuryvojcybzvr\",
    \"bic\": \"byickznky\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/bank"
);

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

let body = {
    "bank_name": "vmqeopfuudtdsufvyvddq",
    "account_holder_name": "amniihfqcoynlazghdtqt",
    "rib": "qxbajwbpilpmufinllwlo",
    "iban": "auydlsmsjuryvojcybzvr",
    "bic": "byickznky"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{bankDetail}/bank

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

bankDetail   string   

Example: consequatur

Body Parameters

bank_name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

account_holder_name   string   

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

rib   string  optional  

Must not be greater than 255 characters. Example: qxbajwbpilpmufinllwlo

iban   string  optional  

Must not be greater than 34 characters. Example: auydlsmsjuryvojcybzvr

bic   string  optional  

Must not be greater than 11 characters. Example: byickznky

GET api/v1/get/smtpsettings

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/smtpsettings" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/smtpsettings"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/smtpsettings

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/smtpsettings

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/smtpsettings" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"host\": \"vmqeopfuudtdsufvyvddq\",
    \"name\": \"consequatur\",
    \"port\": 45,
    \"encryption\": \"tls\",
    \"username\": \"qeopfuudtdsufvyvddqam\",
    \"email\": \"evert28@example.com\",
    \"password\": \"*UyPJ\\\"}6<,h]fZt\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/smtpsettings"
);

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

let body = {
    "host": "vmqeopfuudtdsufvyvddq",
    "name": "consequatur",
    "port": 45,
    "encryption": "tls",
    "username": "qeopfuudtdsufvyvddqam",
    "email": "evert28@example.com",
    "password": "*UyPJ\"}6<,h]fZt"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/smtpsettings

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

host   string  optional  

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

name   string   

Example: consequatur

port   integer   

Must be at least 1. Example: 45

encryption   string  optional  

Example: tls

Must be one of:

• tls
• ssl

username   string   

Must not be greater than 255 characters. Example: qeopfuudtdsufvyvddqam

email   string   

Must be a valid email address. Must not be greater than 255 characters. Example: evert28@example.com

password   string   

Must be at least 8 characters. Example: *UyPJ"}6<,h]fZt

GET api/v1/get/modules/notices

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/modules/notices" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/modules/notices"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/modules/notices

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/receive/notice

Example request:

curl --request POST \
    "http://core.localhost/api/v1/receive/notice" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/receive/notice"
);

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

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

Request    Try it out ⚡   

POST api/v1/receive/notice

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/play/{message_id}/audio

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/play/17/audio" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/play/17/audio"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/play/{message_id}/audio

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

message_id   integer   

The ID of the message. Example: 17

GET api/v1/chat/all/users

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/chat/all/users" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/chat/all/users"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/chat/all/users

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Display a listing of the resource.

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/chat/conversations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/chat/conversations"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/chat/conversations

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/chat/conversations

Example request:

curl --request POST \
    "http://core.localhost/api/v1/chat/conversations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_type\": \"consequatur\",
    \"user_id\": \"98adc52b-966d-39db-809a-55902ee7228f\",
    \"module_class\": \"consequatur\",
    \"module_id\": \"98adc52b-966d-39db-809a-55902ee7228f\"
}"

const url = new URL(
    "http://core.localhost/api/v1/chat/conversations"
);

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

let body = {
    "user_type": "consequatur",
    "user_id": "98adc52b-966d-39db-809a-55902ee7228f",
    "module_class": "consequatur",
    "module_id": "98adc52b-966d-39db-809a-55902ee7228f"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/chat/conversations

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

user_type   string  optional  

Example: consequatur

user_id   string   

Must be a valid UUID. Example: 98adc52b-966d-39db-809a-55902ee7228f

module_class   string  optional  

Example: consequatur

module_id   string  optional  

Must be a valid UUID. Example: 98adc52b-966d-39db-809a-55902ee7228f

POST api/v1/chat/group/conversations

Example request:

curl --request POST \
    "http://core.localhost/api/v1/chat/group/conversations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"group_type\": \"PUBLIC\",
    \"users\": [
        {
            \"user_id\": \"462ee709-6d9f-345a-95e6-76f833111fb8\",
            \"user_type\": \"consequatur\"
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/chat/group/conversations"
);

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

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "group_type": "PUBLIC",
    "users": [
        {
            "user_id": "462ee709-6d9f-345a-95e6-76f833111fb8",
            "user_type": "consequatur"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/chat/group/conversations

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

users   object[]  optional  

user_id   string   

Must be a valid UUID. Example: 462ee709-6d9f-345a-95e6-76f833111fb8

user_type   string   

Example: consequatur

group_type   string   

Example: PUBLIC

Must be one of:

• PUBLIC
• PRIVATE
• CLIENT_SERVICE

POST api/v1/chat/conversations/{conversation_id}/messages/file

Example request:

curl --request POST \
    "http://core.localhost/api/v1/chat/conversations/consequatur/messages/file" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/chat/conversations/consequatur/messages/file"
);

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

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

Request    Try it out ⚡   

POST api/v1/chat/conversations/{conversation_id}/messages/file

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

conversation_id   string   

The ID of the conversation. Example: consequatur

POST api/v1/chat/conversations/{conversation_id}/messages/audio

Example request:

curl --request POST \
    "http://core.localhost/api/v1/chat/conversations/consequatur/messages/audio" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/chat/conversations/consequatur/messages/audio"
);

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

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

Request    Try it out ⚡   

POST api/v1/chat/conversations/{conversation_id}/messages/audio

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

conversation_id   string   

The ID of the conversation. Example: consequatur

POST api/v1/chat/conversations/{conversation_id}/messages

Example request:

curl --request POST \
    "http://core.localhost/api/v1/chat/conversations/consequatur/messages" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/chat/conversations/consequatur/messages"
);

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

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

Request    Try it out ⚡   

POST api/v1/chat/conversations/{conversation_id}/messages

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

conversation_id   string   

The ID of the conversation. Example: consequatur

POST api/v1/transfer/chat/conversation

Example request:

curl --request POST \
    "http://core.localhost/api/v1/transfer/chat/conversation" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"messages\": [
        {
            \"id\": \"consequatur\",
            \"type\": \"consequatur\"
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/transfer/chat/conversation"
);

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

let body = {
    "messages": [
        {
            "id": "consequatur",
            "type": "consequatur"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/transfer/chat/conversation

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

conversation_ids   string[]  optional  

The id of an existing record in the conversations table.

messages   object[]   

id   string   

The id of an existing record in the messages table. Example: consequatur

type   string   

Example: consequatur

GET api/v1/chat/conversations/{conversation_id}/messages

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/chat/conversations/consequatur/messages" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/chat/conversations/consequatur/messages"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/chat/conversations/{conversation_id}/messages

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

conversation_id   string   

The ID of the conversation. Example: consequatur

GET api/v1/chat/users/{conversation_id}/conversations

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/chat/users/consequatur/conversations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/chat/users/consequatur/conversations"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/chat/users/{conversation_id}/conversations

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

conversation_id   string   

The ID of the conversation. Example: consequatur

POST api/v1/chat/group/{conversation_id}/add/members

Example request:

curl --request POST \
    "http://core.localhost/api/v1/chat/group/consequatur/add/members" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/chat/group/consequatur/add/members"
);

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

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

Request    Try it out ⚡   

POST api/v1/chat/group/{conversation_id}/add/members

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

conversation_id   string   

The ID of the conversation. Example: consequatur

POST api/v1/chat/group/{conversation_id}/remove/members

Example request:

curl --request POST \
    "http://core.localhost/api/v1/chat/group/consequatur/remove/members" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/chat/group/consequatur/remove/members"
);

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

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

Request    Try it out ⚡   

POST api/v1/chat/group/{conversation_id}/remove/members

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

conversation_id   string   

The ID of the conversation. Example: consequatur

PUT api/v1/chat/update/message/{message_id}

Example request:

curl --request PUT \
    "http://core.localhost/api/v1/chat/update/message/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/chat/update/message/17"
);

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

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

Request    Try it out ⚡   

PUT api/v1/chat/update/message/{message_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

message_id   integer   

The ID of the message. Example: 17

DELETE api/v1/chat/remove/conversation/{conversation_id}

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/chat/remove/conversation/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/chat/remove/conversation/consequatur"
);

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

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

Request    Try it out ⚡   

DELETE api/v1/chat/remove/conversation/{conversation_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

conversation_id   string   

The ID of the conversation. Example: consequatur

DELETE api/v1/chat/remove/message/{message_id}

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/chat/remove/message/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/chat/remove/message/17"
);

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

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

Request    Try it out ⚡   

DELETE api/v1/chat/remove/message/{message_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

message_id   integer   

The ID of the message. Example: 17

GET api/v1/chat/conversation/{conversation_id}/actions

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/chat/conversation/consequatur/actions" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/chat/conversation/consequatur/actions"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/chat/conversation/{conversation_id}/actions

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

conversation_id   string   

The ID of the conversation. Example: consequatur

POST api/v1/chat/call/start

Example request:

curl --request POST \
    "http://core.localhost/api/v1/chat/call/start" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"conversation_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"link\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/chat/call/start"
);

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

let body = {
    "conversation_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "link": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/chat/call/start

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

conversation_id   string   

Must be a valid UUID. The id of an existing record in the conversations table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

link   string   

Example: consequatur

POST api/v1/chat/call/{call}/join

Example request:

curl --request POST \
    "http://core.localhost/api/v1/chat/call/consequatur/join" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/chat/call/consequatur/join"
);

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

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

Request    Try it out ⚡   

POST api/v1/chat/call/{call}/join

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

call   string   

The call. Example: consequatur

POST api/v1/chat/call/{call}/stop

Example request:

curl --request POST \
    "http://core.localhost/api/v1/chat/call/consequatur/stop" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/chat/call/consequatur/stop"
);

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

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

Request    Try it out ⚡   

POST api/v1/chat/call/{call}/stop

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

call   string   

The call. Example: consequatur

POST api/v1/chat/call/{call}/reject

Example request:

curl --request POST \
    "http://core.localhost/api/v1/chat/call/consequatur/reject" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/chat/call/consequatur/reject"
);

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

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

Request    Try it out ⚡   

POST api/v1/chat/call/{call}/reject

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

call   string   

The call. Example: consequatur

GET api/v1/chat/conversation/{conversation_id}/calls

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/chat/conversation/consequatur/calls" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/chat/conversation/consequatur/calls"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/chat/conversation/{conversation_id}/calls

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

conversation_id   string   

The ID of the conversation. Example: consequatur

GET api/v1/chat/module/types

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/chat/module/types" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/chat/module/types"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/chat/module/types

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/client/play/{message_id}/audio

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/client/play/17/audio" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/client/play/17/audio"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/client/play/{message_id}/audio

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

message_id   integer   

The ID of the message. Example: 17

GET api/v1/client/chat/all/users

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/client/chat/all/users" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/client/chat/all/users"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/client/chat/all/users

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Display a listing of the resource.

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/client/chat/conversations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/client/chat/conversations"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/client/chat/conversations

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/client/chat/conversations

Example request:

curl --request POST \
    "http://core.localhost/api/v1/client/chat/conversations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_type\": \"consequatur\",
    \"user_id\": \"98adc52b-966d-39db-809a-55902ee7228f\",
    \"module_class\": \"consequatur\",
    \"module_id\": \"98adc52b-966d-39db-809a-55902ee7228f\"
}"

const url = new URL(
    "http://core.localhost/api/v1/client/chat/conversations"
);

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

let body = {
    "user_type": "consequatur",
    "user_id": "98adc52b-966d-39db-809a-55902ee7228f",
    "module_class": "consequatur",
    "module_id": "98adc52b-966d-39db-809a-55902ee7228f"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/client/chat/conversations

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

user_type   string  optional  

Example: consequatur

user_id   string   

Must be a valid UUID. Example: 98adc52b-966d-39db-809a-55902ee7228f

module_class   string  optional  

Example: consequatur

module_id   string  optional  

Must be a valid UUID. Example: 98adc52b-966d-39db-809a-55902ee7228f

POST api/v1/client/chat/group/conversations

Example request:

curl --request POST \
    "http://core.localhost/api/v1/client/chat/group/conversations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"group_type\": \"PUBLIC\",
    \"users\": [
        {
            \"user_id\": \"462ee709-6d9f-345a-95e6-76f833111fb8\",
            \"user_type\": \"consequatur\"
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/client/chat/group/conversations"
);

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

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "group_type": "PUBLIC",
    "users": [
        {
            "user_id": "462ee709-6d9f-345a-95e6-76f833111fb8",
            "user_type": "consequatur"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/client/chat/group/conversations

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

users   object[]  optional  

user_id   string   

Must be a valid UUID. Example: 462ee709-6d9f-345a-95e6-76f833111fb8

user_type   string   

Example: consequatur

group_type   string   

Example: PUBLIC

Must be one of:

• PUBLIC
• PRIVATE
• CLIENT_SERVICE

POST api/v1/client/chat/conversations/{conversation_id}/messages/file

Example request:

curl --request POST \
    "http://core.localhost/api/v1/client/chat/conversations/consequatur/messages/file" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/client/chat/conversations/consequatur/messages/file"
);

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

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

Request    Try it out ⚡   

POST api/v1/client/chat/conversations/{conversation_id}/messages/file

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

conversation_id   string   

The ID of the conversation. Example: consequatur

POST api/v1/client/chat/conversations/{conversation_id}/messages/audio

Example request:

curl --request POST \
    "http://core.localhost/api/v1/client/chat/conversations/consequatur/messages/audio" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/client/chat/conversations/consequatur/messages/audio"
);

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

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

Request    Try it out ⚡   

POST api/v1/client/chat/conversations/{conversation_id}/messages/audio

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

conversation_id   string   

The ID of the conversation. Example: consequatur

POST api/v1/client/chat/conversations/{conversation_id}/messages

Example request:

curl --request POST \
    "http://core.localhost/api/v1/client/chat/conversations/consequatur/messages" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/client/chat/conversations/consequatur/messages"
);

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

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

Request    Try it out ⚡   

POST api/v1/client/chat/conversations/{conversation_id}/messages

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

conversation_id   string   

The ID of the conversation. Example: consequatur

POST api/v1/client/transfer/chat/conversation

Example request:

curl --request POST \
    "http://core.localhost/api/v1/client/transfer/chat/conversation" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"messages\": [
        {
            \"id\": \"consequatur\",
            \"type\": \"consequatur\"
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/client/transfer/chat/conversation"
);

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

let body = {
    "messages": [
        {
            "id": "consequatur",
            "type": "consequatur"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/client/transfer/chat/conversation

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

conversation_ids   string[]  optional  

The id of an existing record in the conversations table.

messages   object[]   

id   string   

The id of an existing record in the messages table. Example: consequatur

type   string   

Example: consequatur

GET api/v1/client/chat/conversations/{conversation_id}/messages

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/client/chat/conversations/consequatur/messages" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/client/chat/conversations/consequatur/messages"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/client/chat/conversations/{conversation_id}/messages

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

conversation_id   string   

The ID of the conversation. Example: consequatur

GET api/v1/client/chat/users/{conversation_id}/conversations

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/client/chat/users/consequatur/conversations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/client/chat/users/consequatur/conversations"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/client/chat/users/{conversation_id}/conversations

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

conversation_id   string   

The ID of the conversation. Example: consequatur

POST api/v1/client/chat/group/{conversation_id}/add/members

Example request:

curl --request POST \
    "http://core.localhost/api/v1/client/chat/group/consequatur/add/members" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/client/chat/group/consequatur/add/members"
);

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

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

Request    Try it out ⚡   

POST api/v1/client/chat/group/{conversation_id}/add/members

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

conversation_id   string   

The ID of the conversation. Example: consequatur

POST api/v1/client/chat/group/{conversation_id}/remove/members

Example request:

curl --request POST \
    "http://core.localhost/api/v1/client/chat/group/consequatur/remove/members" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/client/chat/group/consequatur/remove/members"
);

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

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

Request    Try it out ⚡   

POST api/v1/client/chat/group/{conversation_id}/remove/members

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

conversation_id   string   

The ID of the conversation. Example: consequatur

GET api/v1/client/chat/conversation/{conversation_id}/actions

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/client/chat/conversation/consequatur/actions" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/client/chat/conversation/consequatur/actions"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/client/chat/conversation/{conversation_id}/actions

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

conversation_id   string   

The ID of the conversation. Example: consequatur

POST api/v1/client/chat/call/start

Example request:

curl --request POST \
    "http://core.localhost/api/v1/client/chat/call/start" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"conversation_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"link\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/client/chat/call/start"
);

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

let body = {
    "conversation_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "link": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/client/chat/call/start

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

conversation_id   string   

Must be a valid UUID. The id of an existing record in the conversations table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

link   string   

Example: consequatur

POST api/v1/client/chat/call/{call}/join

Example request:

curl --request POST \
    "http://core.localhost/api/v1/client/chat/call/consequatur/join" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/client/chat/call/consequatur/join"
);

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

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

Request    Try it out ⚡   

POST api/v1/client/chat/call/{call}/join

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

call   string   

The call. Example: consequatur

POST api/v1/client/chat/call/{call}/stop

Example request:

curl --request POST \
    "http://core.localhost/api/v1/client/chat/call/consequatur/stop" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/client/chat/call/consequatur/stop"
);

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

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

Request    Try it out ⚡   

POST api/v1/client/chat/call/{call}/stop

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

call   string   

The call. Example: consequatur

POST api/v1/client/chat/call/{call}/reject

Example request:

curl --request POST \
    "http://core.localhost/api/v1/client/chat/call/consequatur/reject" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/client/chat/call/consequatur/reject"
);

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

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

Request    Try it out ⚡   

POST api/v1/client/chat/call/{call}/reject

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

call   string   

The call. Example: consequatur

GET api/v1/client/chat/conversation/{conversation_id}/calls

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/client/chat/conversation/consequatur/calls" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/client/chat/conversation/consequatur/calls"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/client/chat/conversation/{conversation_id}/calls

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

conversation_id   string   

The ID of the conversation. Example: consequatur

GET api/v1/client/chat/module/types

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/client/chat/module/types" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/client/chat/module/types"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/client/chat/module/types

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/client/botman

Example request:

curl --request POST \
    "http://core.localhost/api/v1/client/botman" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/client/botman"
);

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

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

Request    Try it out ⚡   

POST api/v1/client/botman

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/countries/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/countries/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/countries/collection"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/countries/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/contact/scroll

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/contact/scroll" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/contact/scroll"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/contact/scroll

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/contacts/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/contacts/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/contacts/collection"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/contacts/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/contacts/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/contacts/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/contacts/datatables"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/contacts/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/contact/upload-avatar

Example request:

curl --request POST \
    "http://core.localhost/api/v1/contact/upload-avatar" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "contact_id=66529e01-d113-3473-8d6f-9e11e09332ea"\
    --form "delete_image=1"\
    --form "avatar=@/tmp/phpjDyStD" 

const url = new URL(
    "http://core.localhost/api/v1/contact/upload-avatar"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('contact_id', '66529e01-d113-3473-8d6f-9e11e09332ea');
body.append('delete_image', '1');
body.append('avatar', document.querySelector('input[name="avatar"]').files[0]);

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

Request    Try it out ⚡   

POST api/v1/contact/upload-avatar

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

contact_id   string   

Must be a valid UUID. The id of an existing record in the contacts table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

avatar   file  optional  

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/phpjDyStD

delete_image   boolean  optional   true false

Example: true

PATCH api/v1/contact/{contact}/set/address

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/contact/consequatur/set/address" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"contact\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"action\": \"edit\",
    \"address\": {
        \"id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
        \"city_id\": \"fa010f60-df29-3f05-8bc7-bed48f550d13\",
        \"country\": \"57357f37-0ea3-38e5-8a6c-9de9d06e75fd\",
        \"street\": \"fuudtdsufvyvddqamniih\",
        \"street2\": \"fqcoynlazghdtqtqxbajw\",
        \"zipcode\": \"bpilpmufinllwloauydls\"
    }
}"

const url = new URL(
    "http://core.localhost/api/v1/contact/consequatur/set/address"
);

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

let body = {
    "contact": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "action": "edit",
    "address": {
        "id": "66529e01-d113-3473-8d6f-9e11e09332ea",
        "city_id": "fa010f60-df29-3f05-8bc7-bed48f550d13",
        "country": "57357f37-0ea3-38e5-8a6c-9de9d06e75fd",
        "street": "fuudtdsufvyvddqamniih",
        "street2": "fqcoynlazghdtqtqxbajw",
        "zipcode": "bpilpmufinllwloauydls"
    }
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/contact/{contact}/set/address

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

contact   string   

The contact. Example: consequatur

Body Parameters

contact   string   

Must be a valid UUID. The id of an existing record in the contacts table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

action   string   

Example: edit

Must be one of:

• edit
• create

address   object   

id   string  optional  

This field is required when action is == or edit. Must be a valid UUID. The id of an existing record in the addresses table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

city_id   string  optional  

Must be a valid UUID. The id of an existing record in the cities table. Example: fa010f60-df29-3f05-8bc7-bed48f550d13

country   string  optional  

Must be a valid UUID. The id of an existing record in the countries table. Example: 57357f37-0ea3-38e5-8a6c-9de9d06e75fd

street   string  optional  

Must not be greater than 255 characters. Example: fuudtdsufvyvddqamniih

street2   string  optional  

Must not be greater than 255 characters. Example: fqcoynlazghdtqtqxbajw

zipcode   string  optional  

Must not be greater than 255 characters. Example: bpilpmufinllwloauydls

GET api/v1/contact/{contact}/details

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/contact/consequatur/details" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/contact/consequatur/details"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/contact/{contact}/details

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

contact   string   

The contact. Example: consequatur

GET api/v1/get/contact/supplier/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/contact/supplier/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/contact/supplier/collection"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/contact/supplier/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/contact/{contact}/invoices/stats

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/contact/consequatur/invoices/stats" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/contact/consequatur/invoices/stats"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/contact/{contact}/invoices/stats

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

contact   string   

The contact. Example: consequatur

GET api/v1/get/contact/{contact}/stats

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/contact/consequatur/stats" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/contact/consequatur/stats"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/contact/{contact}/stats

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

contact   string   

The contact. Example: consequatur

GET api/v1/contact/{contact}/collaborators

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/contact/consequatur/collaborators" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/contact/consequatur/collaborators"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/contact/{contact}/collaborators

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

contact   string   

The contact. Example: consequatur

GET api/v1/get/contact/without/company

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/contact/without/company" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/contact/without/company"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/contact/without/company

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/contact/{contact}/add/collaborators

Example request:

curl --request POST \
    "http://core.localhost/api/v1/contact/consequatur/add/collaborators" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/contact/consequatur/add/collaborators"
);

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

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

Request    Try it out ⚡   

POST api/v1/contact/{contact}/add/collaborators

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

contact   string   

The contact. Example: consequatur

PATCH api/v1/contact/{contact}/update/collaborators

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/contact/consequatur/update/collaborators" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/contact/consequatur/update/collaborators"
);

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

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

Request    Try it out ⚡   

PATCH api/v1/contact/{contact}/update/collaborators

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

contact   string   

The contact. Example: consequatur

DELETE api/v1/contact/{contact}/delete/collaborators

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/contact/consequatur/delete/collaborators" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/contact/consequatur/delete/collaborators"
);

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

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

Request    Try it out ⚡   

DELETE api/v1/contact/{contact}/delete/collaborators

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

contact   string   

The contact. Example: consequatur

DELETE api/v1/contact/{contact}/address/{address}/delete

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/contact/consequatur/address/consequatur/delete" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/contact/consequatur/address/consequatur/delete"
);

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

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

Request    Try it out ⚡   

DELETE api/v1/contact/{contact}/address/{address}/delete

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

contact   string   

The contact. Example: consequatur

address   string   

The address. Example: consequatur

PATCH api/v1/contact/{contact}/address/{address}/set/default

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/contact/consequatur/address/consequatur/set/default" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/contact/consequatur/address/consequatur/set/default"
);

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

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

Request    Try it out ⚡   

PATCH api/v1/contact/{contact}/address/{address}/set/default

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

contact   string   

The contact. Example: consequatur

address   string   

The address. Example: consequatur

GET api/v1/download-contact-model

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/download-contact-model" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/download-contact-model"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/download-contact-model

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/import/contacts

Example request:

curl --request POST \
    "http://core.localhost/api/v1/import/contacts" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/import/contacts"
);

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

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

Request    Try it out ⚡   

POST api/v1/import/contacts

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/export/contacts

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/export/contacts" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/export/contacts"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/export/contacts

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/cities/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/cities/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/cities/collection"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/cities/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/gender/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/gender/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/gender/enum"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/gender/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/contactType/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/contactType/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/contactType/enum"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/contactType/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/download/contactsSheet

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/download/contactsSheet" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/download/contactsSheet"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/download/contactsSheet

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/customer/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/customer/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/customer/collection"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/customer/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/customer/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/customer/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/customer/datatables"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/customer/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/validate/{customer_id}/customer/account

Example request:

curl --request POST \
    "http://core.localhost/api/v1/validate/consequatur/customer/account" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/validate/consequatur/customer/account"
);

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

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

Request    Try it out ⚡   

POST api/v1/validate/{customer_id}/customer/account

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

customer_id   string   

The ID of the customer. Example: consequatur

DELETE api/v1/reject/{customer_id}/customer/account

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/reject/consequatur/customer/account" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/reject/consequatur/customer/account"
);

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

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

Request    Try it out ⚡   

DELETE api/v1/reject/{customer_id}/customer/account

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

customer_id   string   

The ID of the customer. Example: consequatur

POST api/v1/login/contact

Example request:

curl --request POST \
    "http://core.localhost/api/v1/login/contact" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"qkunze@example.com\",
    \"password\": \"O[2UZ5ij-e\\/dl4m{o,\"
}"

const url = new URL(
    "http://core.localhost/api/v1/login/contact"
);

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

let body = {
    "email": "qkunze@example.com",
    "password": "O[2UZ5ij-e\/dl4m{o,"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/login/contact

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

Must be a valid email address. The email of an existing record in the contacts table. Example: qkunze@example.com

password   string   

Example: O[2UZ5ij-e/dl4m{o,

POST api/v1/create/contact/password

Example request:

curl --request POST \
    "http://core.localhost/api/v1/create/contact/password" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"token\": \"consequatur\",
    \"password\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/create/contact/password"
);

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

let body = {
    "token": "consequatur",
    "password": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/create/contact/password

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

token   string   

The confirmation_token of an existing record in the contacts table. Example: consequatur

password   string   

Example: consequatur

POST api/v1/reset/customer/password

Example request:

curl --request POST \
    "http://core.localhost/api/v1/reset/customer/password" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"token\": \"consequatur\",
    \"password\": \"O[2UZ5ij-e\\/dl4m{o,\"
}"

const url = new URL(
    "http://core.localhost/api/v1/reset/customer/password"
);

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

let body = {
    "token": "consequatur",
    "password": "O[2UZ5ij-e\/dl4m{o,"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/reset/customer/password

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

token   string   

Example: consequatur

password   string   

Example: O[2UZ5ij-e/dl4m{o,

POST api/v1/send/verification/mail

Example request:

curl --request POST \
    "http://core.localhost/api/v1/send/verification/mail" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"qkunze@example.com\"
}"

const url = new URL(
    "http://core.localhost/api/v1/send/verification/mail"
);

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

let body = {
    "email": "qkunze@example.com"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/send/verification/mail

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

Must be a valid email address. Example: qkunze@example.com

POST api/v1/register/customer

Example request:

curl --request POST \
    "http://core.localhost/api/v1/register/customer" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "gender=female"\
    --form "contactType=society"\
    --form "lastname=vmqeopfuudtdsufvyvddq"\
    --form "firstname=amniihfqcoynlazghdtqt"\
    --form "token=consequatur"\
    --form "phone_code=consequatur"\
    --form "phone=consequatur"\
    --form "birthday=2019-10-08"\
    --form "website=mqeopfuudtdsufvyvddqa"\
    --form "address[city_id]=87582a71-8e82-3d56-919d-d5863651492b"\
    --form "address[country]=77d66ab0-ed8e-31b6-bb6b-acfbf3e0d8a0"\
    --form "address[street]=hfqcoynlazghdtqtqxbaj"\
    --form "address[street2]=wbpilpmufinllwloauydl"\
    --form "address[zipcode]=smsjuryvojcybzvrbyick"\
    --form "avatar=@/tmp/phpxORYfU" 

const url = new URL(
    "http://core.localhost/api/v1/register/customer"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('gender', 'female');
body.append('contactType', 'society');
body.append('lastname', 'vmqeopfuudtdsufvyvddq');
body.append('firstname', 'amniihfqcoynlazghdtqt');
body.append('token', 'consequatur');
body.append('phone_code', 'consequatur');
body.append('phone', 'consequatur');
body.append('birthday', '2019-10-08');
body.append('website', 'mqeopfuudtdsufvyvddqa');
body.append('address[city_id]', '87582a71-8e82-3d56-919d-d5863651492b');
body.append('address[country]', '77d66ab0-ed8e-31b6-bb6b-acfbf3e0d8a0');
body.append('address[street]', 'hfqcoynlazghdtqtqxbaj');
body.append('address[street2]', 'wbpilpmufinllwloauydl');
body.append('address[zipcode]', 'smsjuryvojcybzvrbyick');
body.append('avatar', document.querySelector('input[name="avatar"]').files[0]);

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

Request    Try it out ⚡   

POST api/v1/register/customer

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

gender   string  optional  

Example: female

Must be one of:

• male
• female

contactType   string   

Example: society

Must be one of:

• particular
• society

lastname   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

firstname   string  optional  

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

token   string   

Example: consequatur

phone_code   string   

Example: consequatur

phone   string   

Example: consequatur

birthday   string  optional  

Must be a valid date. Must be a date before today. Example: 2019-10-08

avatar   file  optional  

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/phpxORYfU

website   string  optional  

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

address   object  optional  

city_id   string  optional  

Must be a valid UUID. The id of an existing record in the cities table. Example: 87582a71-8e82-3d56-919d-d5863651492b

country   string  optional  

Must be a valid UUID. The id of an existing record in the countries table. Example: 77d66ab0-ed8e-31b6-bb6b-acfbf3e0d8a0

street   string  optional  

Must not be greater than 255 characters. Example: hfqcoynlazghdtqtqxbaj

street2   string  optional  

Must not be greater than 255 characters. Example: wbpilpmufinllwloauydl

zipcode   string  optional  

Must not be greater than 255 characters. Example: smsjuryvojcybzvrbyick

POST api/v1/logout/customer

Example request:

curl --request POST \
    "http://core.localhost/api/v1/logout/customer" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/logout/customer"
);

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

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

Request    Try it out ⚡   

POST api/v1/logout/customer

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/customer

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/customer" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/customer"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/customer

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/update/customer/info

Example request:

curl --request POST \
    "http://core.localhost/api/v1/update/customer/info" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "lastname=vmqeopfuudtdsufvyvddq"\
    --form "firstname=amniihfqcoynlazghdtqt"\
    --form "phone=qxbajwbpilpmufinllwlo"\
    --form "birthday=2019-10-08"\
    --form "website=mqeopfuudtdsufvyvddqa"\
    --form "address[][city]=mniihfqcoynlazghdtqtq"\
    --form "address[][country]=1966a04b-5bf2-32bc-a8b3-7835ce5688d2"\
    --form "address[][street]=ajwbpilpmufinllwloauy"\
    --form "address[][street2]=dlsmsjuryvojcybzvrbyi"\
    --form "address[][zipcode]=ckznkygloigmkwxphlvaz"\
    --form "address[][default]="\
    --form "avatar=@/tmp/phpR8pWla" 

const url = new URL(
    "http://core.localhost/api/v1/update/customer/info"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('lastname', 'vmqeopfuudtdsufvyvddq');
body.append('firstname', 'amniihfqcoynlazghdtqt');
body.append('phone', 'qxbajwbpilpmufinllwlo');
body.append('birthday', '2019-10-08');
body.append('website', 'mqeopfuudtdsufvyvddqa');
body.append('address[][city]', 'mniihfqcoynlazghdtqtq');
body.append('address[][country]', '1966a04b-5bf2-32bc-a8b3-7835ce5688d2');
body.append('address[][street]', 'ajwbpilpmufinllwloauy');
body.append('address[][street2]', 'dlsmsjuryvojcybzvrbyi');
body.append('address[][zipcode]', 'ckznkygloigmkwxphlvaz');
body.append('address[][default]', '');
body.append('avatar', document.querySelector('input[name="avatar"]').files[0]);

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

Request    Try it out ⚡   

POST api/v1/update/customer/info

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

lastname   string  optional  

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

firstname   string  optional  

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

phone   string   

Must not be greater than 255 characters. Example: qxbajwbpilpmufinllwlo

birthday   string   

Must be a valid date. Must be a date before today. Example: 2019-10-08

website   string  optional  

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

address   object[]  optional  

city   string  optional  

Must not be greater than 255 characters. Example: mniihfqcoynlazghdtqtq

country   string  optional  

Must be a valid UUID. The id of an existing record in the countries table. Example: 1966a04b-5bf2-32bc-a8b3-7835ce5688d2

street   string  optional  

Must not be greater than 255 characters. Example: ajwbpilpmufinllwloauy

street2   string  optional  

Must not be greater than 255 characters. Example: dlsmsjuryvojcybzvrbyi

zipcode   string  optional  

Must not be greater than 255 characters. Example: ckznkygloigmkwxphlvaz

default   boolean  optional   true false

Example: false

avatar   file  optional  

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/phpR8pWla

POST api/v1/update/customer/avatar

Example request:

curl --request POST \
    "http://core.localhost/api/v1/update/customer/avatar" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/update/customer/avatar"
);

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

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

Request    Try it out ⚡   

POST api/v1/update/customer/avatar

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/customer/updatePassword

Example request:

curl --request POST \
    "http://core.localhost/api/v1/customer/updatePassword" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"old_password\": \"consequatur\",
    \"password\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/customer/updatePassword"
);

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

let body = {
    "old_password": "consequatur",
    "password": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/customer/updatePassword

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

old_password   string   

Example: consequatur

password   string   

Example: consequatur

GET api/v1/get/publications/customer

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/publications/customer" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/publications/customer"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/publications/customer

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/{publication}/publication/customer

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/publication/customer" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/publication/customer"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{publication}/publication/customer

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

publication   string   

Example: consequatur

GET api/v1/get/{publication}/comments/customer

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/comments/customer" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/comments/customer"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{publication}/comments/customer

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

publication   string   

Example: consequatur

GET api/v1/download/{publication_id}/publication/files/customer

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/download/consequatur/publication/files/customer" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/download/consequatur/publication/files/customer"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/download/{publication_id}/publication/files/customer

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

publication_id   string   

The ID of the publication. Example: consequatur

GET api/v1/get/{nps}/customer/portal/nps

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/customer/portal/nps" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/customer/portal/nps"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{nps}/customer/portal/nps

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

nps   string   

Example: consequatur

GET api/v1/get/customer/nps

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/customer/nps" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/customer/nps"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/customer/nps

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/customer/response/{nps}/nps

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/customer/response/consequatur/nps" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/customer/response/consequatur/nps"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/customer/response/{nps}/nps

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

nps   string   

Example: consequatur

GET api/v1/contact/get/project/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/contact/get/project/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/contact/get/project/collection"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/contact/get/project/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/contact/store/reaction

Example request:

curl --request POST \
    "http://core.localhost/api/v1/contact/store/reaction" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"😎\",
    \"model\": \"PUBLICATION\",
    \"model_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\"
}"

const url = new URL(
    "http://core.localhost/api/v1/contact/store/reaction"
);

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

let body = {
    "type": "😎",
    "model": "PUBLICATION",
    "model_id": "66529e01-d113-3473-8d6f-9e11e09332ea"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/contact/store/reaction

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

type   string   

Example: 😎

Must be one of:

• 😐
• 🙂
• 😄
• 😎

model   string   

Example: PUBLICATION

Must be one of:

• PUBLICATION
• COMMENT

model_id   string  optional  

Must be a valid UUID. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

POST api/v1/contact/store/comment

Example request:

curl --request POST \
    "http://core.localhost/api/v1/contact/store/comment" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"content\": \"consequatur\",
    \"publication_id\": \"98adc52b-966d-39db-809a-55902ee7228f\",
    \"mention_ids\": [
        \"d48a46b6-3a18-3763-951d-66b7fdb284ae\"
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/contact/store/comment"
);

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

let body = {
    "content": "consequatur",
    "publication_id": "98adc52b-966d-39db-809a-55902ee7228f",
    "mention_ids": [
        "d48a46b6-3a18-3763-951d-66b7fdb284ae"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/contact/store/comment

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

content   string   

Example: consequatur

publication_id   string   

Must be a valid UUID. The id of an existing record in the publications table. Example: 98adc52b-966d-39db-809a-55902ee7228f

mention_ids   string[]  optional  

Must be a valid UUID. The id of an existing record in the users table.

POST api/v1/contact/reply/to/comment/{commentId}

Example request:

curl --request POST \
    "http://core.localhost/api/v1/contact/reply/to/comment/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"content\": \"consequatur\",
    \"publication_id\": \"98adc52b-966d-39db-809a-55902ee7228f\",
    \"mention_ids\": [
        \"d48a46b6-3a18-3763-951d-66b7fdb284ae\"
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/contact/reply/to/comment/consequatur"
);

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

let body = {
    "content": "consequatur",
    "publication_id": "98adc52b-966d-39db-809a-55902ee7228f",
    "mention_ids": [
        "d48a46b6-3a18-3763-951d-66b7fdb284ae"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/contact/reply/to/comment/{commentId}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

commentId   string   

Example: consequatur

Body Parameters

content   string   

Example: consequatur

publication_id   string   

Must be a valid UUID. The id of an existing record in the publications table. Example: 98adc52b-966d-39db-809a-55902ee7228f

mention_ids   string[]  optional  

Must be a valid UUID. The id of an existing record in the users table.

GET api/v1/get/customer/project/{project}/folders

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/customer/project/consequatur/folders" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/customer/project/consequatur/folders"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/customer/project/{project}/folders

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project   string   

The project. Example: consequatur

GET api/v1/get/customer/projectFolder/{projectFolder}/files/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/customer/projectFolder/consequatur/files/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/customer/projectFolder/consequatur/files/datatables"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/customer/projectFolder/{projectFolder}/files/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

projectFolder   string   

The projectFolder. Example: consequatur

GET api/v1/get/customer/projectFolder/{projectFolder}/files

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/customer/projectFolder/consequatur/files" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/customer/projectFolder/consequatur/files"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/customer/projectFolder/{projectFolder}/files

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

projectFolder   string   

The projectFolder. Example: consequatur

GET api/v1/customer/download/file/{id}

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/customer/download/file/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/customer/download/file/consequatur"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/customer/download/file/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the file. Example: consequatur

POST api/v1/customer/download/multiple-files

Example request:

curl --request POST \
    "http://core.localhost/api/v1/customer/download/multiple-files" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"files\": [
        \"66529e01-d113-3473-8d6f-9e11e09332ea\"
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/customer/download/multiple-files"
);

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

let body = {
    "files": [
        "66529e01-d113-3473-8d6f-9e11e09332ea"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/customer/download/multiple-files

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

files   string[]  optional  

Must be a valid UUID. The id of an existing record in the project_folder_files table.

GET api/v1/dashboard/statistics

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/dashboard/statistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/dashboard/statistics"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/dashboard/statistics

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/bests/customers/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/bests/customers/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/bests/customers/datatables"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/bests/customers/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/download/statistics/dashboard

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/download/statistics/dashboard" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/download/statistics/dashboard"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/download/statistics/dashboard

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/family/status/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/family/status/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/family/status/collection"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/family/status/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/family/status/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/family/status/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/family/status/datatables"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/family/status/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/family/status

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/family/status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/family/status"
);

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

let body = {
    "title": "vmqeopfuudtdsufvyvddq"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/family/status

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

PATCH api/v1/update/{id}/family/status

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/family/status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"id\": \"462ee709-6d9f-345a-95e6-76f833111fb8\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/family/status"
);

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

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "id": "462ee709-6d9f-345a-95e6-76f833111fb8"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{id}/family/status

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the update. Example: consequatur

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

id   string   

Must be a valid UUID. The id of an existing record in the employee_family_statuses table. Example: 462ee709-6d9f-345a-95e6-76f833111fb8

DELETE api/v1/delete/{id}/family/status

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/family/status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/family/status"
);

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

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

Request    Try it out ⚡   

DELETE api/v1/delete/{id}/family/status

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the delete. Example: consequatur

GET api/v1/get/post/categories/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/post/categories/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/post/categories/collection"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/post/categories/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/post/categories/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/post/categories/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/post/categories/datatables"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/post/categories/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/post/category

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/post/category" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/post/category"
);

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

let body = {
    "title": "vmqeopfuudtdsufvyvddq"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/post/category

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

PATCH api/v1/update/{id}/post/category

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/post/category" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"id\": \"462ee709-6d9f-345a-95e6-76f833111fb8\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/post/category"
);

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

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "id": "462ee709-6d9f-345a-95e6-76f833111fb8"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{id}/post/category

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the update. Example: consequatur

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

id   string   

Must be a valid UUID. The id of an existing record in the employee_post_categories table. Example: 462ee709-6d9f-345a-95e6-76f833111fb8

DELETE api/v1/delete/{id}/post/category

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/post/category" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/post/category"
);

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

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

Request    Try it out ⚡   

DELETE api/v1/delete/{id}/post/category

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the delete. Example: consequatur

GET api/v1/get/{office}/society/employee

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/society/employee" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/society/employee"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{office}/society/employee

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

office   string   

Example: consequatur

GET api/v1/get/employee/contract/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/employee/contract/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/employee/contract/collection"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/employee/contract/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/employee/contract/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/employee/contract/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/employee/contract/datatables"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/employee/contract/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/user/employee/contract/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/user/employee/contract/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/user/employee/contract/datatables"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/user/employee/contract/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/download/{contract}/employee/contract

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/download/consequatur/employee/contract" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/download/consequatur/employee/contract"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/download/{contract}/employee/contract

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

contract   string   

Example: consequatur

GET api/v1/download/{contract}/employee

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/download/consequatur/employee" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/download/consequatur/employee"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/download/{contract}/employee

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

contract   string   

Example: consequatur

POST api/v1/store/employee/contract

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/employee/contract" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"contract_type\": \"cdi\",
    \"salary\": 73,
    \"start_date\": \"2025-06-12T12:56:29\",
    \"end_date\": \"2106-07-12\",
    \"notes\": \"consequatur\",
    \"file\": \"mqeopfuudtdsufvyvddqa\",
    \"employee_id\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/employee/contract"
);

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

let body = {
    "contract_type": "cdi",
    "salary": 73,
    "start_date": "2025-06-12T12:56:29",
    "end_date": "2106-07-12",
    "notes": "consequatur",
    "file": "mqeopfuudtdsufvyvddqa",
    "employee_id": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/employee/contract

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

contract_type   string   

Example: cdi

Must be one of:

• cdi
• cdd
• stage
• interim
• partiel
• freelance

salary   number   

Must be at least 0. Example: 73

start_date   string   

Must be a valid date. Example: 2025-06-12T12:56:29

end_date   string  optional  

Must be a valid date. Must be a date after or equal to start_date. Example: 2106-07-12

notes   string  optional  

Example: consequatur

file   string   

Must not be greater than 2048 characters. Example: mqeopfuudtdsufvyvddqa

employee_id   string   

The id of an existing record in the users table. Example: consequatur

POST api/v1/update/{contract}/employee/contract

Example request:

curl --request POST \
    "http://core.localhost/api/v1/update/consequatur/employee/contract" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"contract_type\": \"cdi\",
    \"salary\": 73,
    \"start_date\": \"2025-06-12T12:56:29\",
    \"end_date\": \"2106-07-12\",
    \"notes\": \"consequatur\",
    \"file\": \"mqeopfuudtdsufvyvddqa\",
    \"employee_id\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/employee/contract"
);

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

let body = {
    "contract_type": "cdi",
    "salary": 73,
    "start_date": "2025-06-12T12:56:29",
    "end_date": "2106-07-12",
    "notes": "consequatur",
    "file": "mqeopfuudtdsufvyvddqa",
    "employee_id": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/update/{contract}/employee/contract

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

contract   string   

Example: consequatur

Body Parameters

contract_type   string   

Example: cdi

Must be one of:

• cdi
• cdd
• stage
• interim
• partiel
• freelance

salary   number   

Must be at least 0. Example: 73

start_date   string   

Must be a valid date. Example: 2025-06-12T12:56:29

end_date   string  optional  

Must be a valid date. Must be a date after or equal to start_date. Example: 2106-07-12

notes   string  optional  

Example: consequatur

file   string  optional  

Must not be greater than 2048 characters. Example: mqeopfuudtdsufvyvddqa

employee_id   string   

The id of an existing record in the users table. Example: consequatur

GET api/v1/get/{contract}/employee/contract

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/employee/contract" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/employee/contract"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{contract}/employee/contract

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

contract   string   

Example: consequatur

DELETE api/v1/delete/{contract}/employee/contract

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/employee/contract" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/employee/contract"
);

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

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

Request    Try it out ⚡   

DELETE api/v1/delete/{contract}/employee/contract

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

contract   string   

Example: consequatur

GET api/v1/employee/contract/type/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/employee/contract/type/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/employee/contract/type/enum"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/employee/contract/type/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/employee/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/employee/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/employee/datatables"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/employee/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/employee

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/employee" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"lastname\": \"qeopfuudtdsufvyvddqam\",
    \"firstname\": \"niihfqcoynlazghdtqtqx\",
    \"phone_code\": \"consequatur\",
    \"phone\": \"mqeopfuudtdsufvyv\",
    \"department_id\": \"92f7c094-3063-3c79-bbfc-7e096d42f6dd\",
    \"post_id\": \"consequatur\",
    \"birthday\": \"2019-10-08\",
    \"address\": \"mqeopfuudtdsufvyvddqa\",
    \"date_in_service\": \"12-06-2025\",
    \"social_security_number\": \"mniihfqcoynlazghdtqtq\",
    \"employee_family_status_id\": \"1966a04b-5bf2-32bc-a8b3-7835ce5688d2\",
    \"employee_post_category_id\": \"ba3a31ce-1e9f-3aa8-8b6f-424fe4033b3d\",
    \"nationality_id\": \"6014938f-4620-3891-98c2-feef003bc1ba\",
    \"nbrHolidays\": 11613.31890586
}"

const url = new URL(
    "http://core.localhost/api/v1/store/employee"
);

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

let body = {
    "user_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "lastname": "qeopfuudtdsufvyvddqam",
    "firstname": "niihfqcoynlazghdtqtqx",
    "phone_code": "consequatur",
    "phone": "mqeopfuudtdsufvyv",
    "department_id": "92f7c094-3063-3c79-bbfc-7e096d42f6dd",
    "post_id": "consequatur",
    "birthday": "2019-10-08",
    "address": "mqeopfuudtdsufvyvddqa",
    "date_in_service": "12-06-2025",
    "social_security_number": "mniihfqcoynlazghdtqtq",
    "employee_family_status_id": "1966a04b-5bf2-32bc-a8b3-7835ce5688d2",
    "employee_post_category_id": "ba3a31ce-1e9f-3aa8-8b6f-424fe4033b3d",
    "nationality_id": "6014938f-4620-3891-98c2-feef003bc1ba",
    "nbrHolidays": 11613.31890586
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/employee

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

user_id   string   

Must be a valid UUID. The id of an existing record in the users table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

lastname   string   

Must not be greater than 255 characters. Example: qeopfuudtdsufvyvddqam

firstname   string   

Must not be greater than 255 characters. Example: niihfqcoynlazghdtqtqx

phone_code   string  optional  

This field is required when phone is present. Example: consequatur

phone   string  optional  

This field is required when phone_code is present. Must not be greater than 20 characters. Example: mqeopfuudtdsufvyv

department_id   string  optional  

Must be a valid UUID. The id of an existing record in the departments table. Example: 92f7c094-3063-3c79-bbfc-7e096d42f6dd

post_id   string  optional  

The id of an existing record in the post_offices table. Example: consequatur

birthday   string  optional  

Must be a valid date. Must be a date before today. Example: 2019-10-08

address   string  optional  

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

date_in_service   string  optional  

Must be a valid date. Must be a valid date in the format d-m-Y. Example: 12-06-2025

social_security_number   string  optional  

Must not be greater than 50 characters. Example: mniihfqcoynlazghdtqtq

employee_family_status_id   string  optional  

Must be a valid UUID. The id of an existing record in the employee_family_statuses table. Example: 1966a04b-5bf2-32bc-a8b3-7835ce5688d2

employee_post_category_id   string  optional  

Must be a valid UUID. The id of an existing record in the employee_post_categories table. Example: ba3a31ce-1e9f-3aa8-8b6f-424fe4033b3d

nationality_id   string   

Must be a valid UUID. The id of an existing record in the nationalities table. Example: 6014938f-4620-3891-98c2-feef003bc1ba

nbrHolidays   number  optional  

Example: 11613.31890586

GET api/v1/get/{employee}/employee

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/employee" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/employee"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{employee}/employee

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

employee   string   

Example: consequatur

POST api/v1/change/{employee}/status

Example request:

curl --request POST \
    "http://core.localhost/api/v1/change/consequatur/status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/change/consequatur/status"
);

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

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

Request    Try it out ⚡   

POST api/v1/change/{employee}/status

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

employee   string   

Example: consequatur

GET api/v1/change/{employee}/status/active

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/change/consequatur/status/active" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/change/consequatur/status/active"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/change/{employee}/status/active

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

employee   string   

Example: consequatur

GET api/v1/change/{employee}/status/inactive

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/change/consequatur/status/inactive" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/change/consequatur/status/inactive"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/change/{employee}/status/inactive

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

employee   string   

Example: consequatur

GET api/v1/change/{employee}/status/employee

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/change/consequatur/status/employee" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/change/consequatur/status/employee"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/change/{employee}/status/employee

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

employee   string   

Example: consequatur

GET api/v1/get/nationalities

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/nationalities" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/nationalities"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/nationalities

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/estimate

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/estimate" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"estimate_date\": \"2019-10-08\",
    \"due_date\": \"2106-07-12\",
    \"notes\": \"consequatur\",
    \"exchange_rate\": 11613.31890586,
    \"discount\": 11613.31890586,
    \"contact_id\": \"57357f37-0ea3-38e5-8a6c-9de9d06e75fd\",
    \"currency_id\": \"c2cdda66-81e5-3060-a4eb-049b4a810d76\",
    \"items\": [
        \"udtdsufvyvddqamniihfq\"
    ],
    \"opportunity_id\": \"consequatur\",
    \"payment_type_id\": \"consequatur\",
    \"validated\": true,
    \"payment_delay\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/estimate"
);

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

let body = {
    "estimate_date": "2019-10-08",
    "due_date": "2106-07-12",
    "notes": "consequatur",
    "exchange_rate": 11613.31890586,
    "discount": 11613.31890586,
    "contact_id": "57357f37-0ea3-38e5-8a6c-9de9d06e75fd",
    "currency_id": "c2cdda66-81e5-3060-a4eb-049b4a810d76",
    "items": [
        "udtdsufvyvddqamniihfq"
    ],
    "opportunity_id": "consequatur",
    "payment_type_id": "consequatur",
    "validated": true,
    "payment_delay": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/estimate

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

estimate_date   string   

Must be a valid date in the format d-m-Y. Must be a date before or equal to due_date. Example: 2019-10-08

due_date   string   

Must be a valid date in the format d-m-Y. Must be a date after or equal to estimate_date. Example: 2106-07-12

notes   string  optional  

Example: consequatur

exchange_rate   number  optional  

Example: 11613.31890586

discount   number  optional  

Example: 11613.31890586

contact_id   string   

Must be a valid UUID. The id of an existing record in the contacts table. Example: 57357f37-0ea3-38e5-8a6c-9de9d06e75fd

currency_id   string   

Must be a valid UUID. The id of an existing record in the currencies table. Example: c2cdda66-81e5-3060-a4eb-049b4a810d76

items   string[]   

Must not be greater than 255 characters.

product_id   string   

Must be a valid UUID. The id of an existing record in the product_sale_elements table. Example: 98adc52b-966d-39db-809a-55902ee7228f

description   string  optional  

quantity   number   

Example: 11613.31890586

price   number   

Example: 11613.31890586

discount_type   string  optional  

Example: amount

Must be one of:

• amount
• percent

discount_value   number  optional  

Example: 11613.31890586

taxes   string[]  optional  

The id of an existing record in the taxes table.

opportunity_id   string  optional  

Must be a valid UUID. The id of an existing record in the opportunities table. Example: consequatur

payment_type_id   string   

Must be a valid UUID. The id of an existing record in the payment_types table. Example: consequatur

validated   boolean  optional   true false

Example: true

payment_delay   string  optional  

Example: consequatur

PATCH api/v1/update/{estimate}/estimate

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/estimate" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"estimate_date\": \"2019-10-08\",
    \"due_date\": \"2106-07-12\",
    \"notes\": \"consequatur\",
    \"exchange_rate\": 11613.31890586,
    \"discount\": 11613.31890586,
    \"contact_id\": \"57357f37-0ea3-38e5-8a6c-9de9d06e75fd\",
    \"currency_id\": \"c2cdda66-81e5-3060-a4eb-049b4a810d76\",
    \"items\": [
        \"udtdsufvyvddqamniihfq\"
    ],
    \"opportunity_id\": \"consequatur\",
    \"payment_type_id\": \"consequatur\",
    \"validated\": false,
    \"payment_delay\": \"consequatur\",
    \"estimate_id\": \"98adc52b-966d-39db-809a-55902ee7228f\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/estimate"
);

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

let body = {
    "estimate_date": "2019-10-08",
    "due_date": "2106-07-12",
    "notes": "consequatur",
    "exchange_rate": 11613.31890586,
    "discount": 11613.31890586,
    "contact_id": "57357f37-0ea3-38e5-8a6c-9de9d06e75fd",
    "currency_id": "c2cdda66-81e5-3060-a4eb-049b4a810d76",
    "items": [
        "udtdsufvyvddqamniihfq"
    ],
    "opportunity_id": "consequatur",
    "payment_type_id": "consequatur",
    "validated": false,
    "payment_delay": "consequatur",
    "estimate_id": "98adc52b-966d-39db-809a-55902ee7228f"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{estimate}/estimate

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

estimate   string   

Example: consequatur

Body Parameters

estimate_date   string   

Must be a valid date in the format d-m-Y. Must be a date before or equal to due_date. Example: 2019-10-08

due_date   string   

Must be a valid date in the format d-m-Y. Must be a date after or equal to estimate_date. Example: 2106-07-12

notes   string  optional  

Example: consequatur

exchange_rate   number  optional  

Example: 11613.31890586

discount   number  optional  

Example: 11613.31890586

contact_id   string   

Must be a valid UUID. The id of an existing record in the contacts table. Example: 57357f37-0ea3-38e5-8a6c-9de9d06e75fd

currency_id   string   

Must be a valid UUID. The id of an existing record in the currencies table. Example: c2cdda66-81e5-3060-a4eb-049b4a810d76

items   string[]   

Must not be greater than 255 characters.

product_id   string   

Must be a valid UUID. The id of an existing record in the product_sale_elements table. Example: d48a46b6-3a18-3763-951d-66b7fdb284ae

description   string  optional  

quantity   number   

Example: 11613.31890586

price   number   

Example: 11613.31890586

discount_type   string  optional  

Example: percent

Must be one of:

• amount
• percent

discount_value   number  optional  

Example: 11613.31890586

taxes   string[]  optional  

The id of an existing record in the taxes table.

opportunity_id   string  optional  

Must be a valid UUID. The id of an existing record in the opportunities table. Example: consequatur

payment_type_id   string   

Must be a valid UUID. The id of an existing record in the payment_types table. Example: consequatur

validated   boolean  optional   true false

Example: false

payment_delay   string  optional  

Example: consequatur

estimate_id   string   

Must be a valid UUID. The id of an existing record in the estimates table. Example: 98adc52b-966d-39db-809a-55902ee7228f

GET api/v1/get/estimates/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/estimates/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/estimates/datatables"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/estimates/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/approved/estimates/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/approved/estimates/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/approved/estimates/datatables"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/approved/estimates/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/estimate/{estimate}

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/estimate/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/estimate/consequatur"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/estimate/{estimate}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

estimate   string   

The estimate. Example: consequatur

GET api/v1/get/estimate/pdf/{estimate}

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/estimate/pdf/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/estimate/pdf/consequatur"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/estimate/pdf/{estimate}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

estimate   string   

Example: consequatur

POST api/v1/send/estimate/{estimate}/email

Example request:

curl --request POST \
    "http://core.localhost/api/v1/send/estimate/consequatur/email" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"body\": \"consequatur\",
    \"subject\": \"consequatur\",
    \"from\": \"carolyne.luettgen@example.org\",
    \"to\": [
        \"russel.bert@example.net\"
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/send/estimate/consequatur/email"
);

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

let body = {
    "body": "consequatur",
    "subject": "consequatur",
    "from": "carolyne.luettgen@example.org",
    "to": [
        "russel.bert@example.net"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/send/estimate/{estimate}/email

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

estimate   string   

The estimate. Example: consequatur

Body Parameters

body   string   

Example: consequatur

subject   string   

Example: consequatur

from   string   

Must be a valid email address. Example: carolyne.luettgen@example.org

to   string[]  optional  

Must be a valid email address.

POST api/v1/cancel-email/estimate/{estimate}/email

Example request:

curl --request POST \
    "http://core.localhost/api/v1/cancel-email/estimate/consequatur/email" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/cancel-email/estimate/consequatur/email"
);

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

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

Request    Try it out ⚡   

POST api/v1/cancel-email/estimate/{estimate}/email

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

estimate   string   

The estimate. Example: consequatur

DELETE api/v1/delete/{estimate}/estimate

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/estimate" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/estimate"
);

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

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

Request    Try it out ⚡   

DELETE api/v1/delete/{estimate}/estimate

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

estimate   string   

Example: consequatur

POST api/v1/store/estimate/{estimate}/invoice

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/estimate/consequatur/invoice" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/store/estimate/consequatur/invoice"
);

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

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

Request    Try it out ⚡   

POST api/v1/store/estimate/{estimate}/invoice

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

estimate   string   

The estimate. Example: consequatur

PATCH api/v1/set/estimate/{estimate}/validated

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/set/estimate/consequatur/validated" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/set/estimate/consequatur/validated"
);

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

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

Request    Try it out ⚡   

PATCH api/v1/set/estimate/{estimate}/validated

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

estimate   string   

The estimate. Example: consequatur

POST api/v1/upload/validated/estimate/{invoice}/files

Example request:

curl --request POST \
    "http://core.localhost/api/v1/upload/validated/estimate/consequatur/files" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/upload/validated/estimate/consequatur/files"
);

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

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

Request    Try it out ⚡   

POST api/v1/upload/validated/estimate/{invoice}/files

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

invoice   string   

Example: consequatur

PATCH api/v1/update/estimate/{estimate}/status

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/estimate/cc2b2bc3-dfd1-1a07-8554-3a18f870f341/status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/update/estimate/cc2b2bc3-dfd1-1a07-8554-3a18f870f341/status"
);

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

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

Request    Try it out ⚡   

PATCH api/v1/update/estimate/{estimate}/status

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

estimate   string   

The estimate. Example: cc2b2bc3-dfd1-1a07-8554-3a18f870f341

GET api/v1/estimate/status/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/estimate/status/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/estimate/status/enum"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/estimate/status/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/event/{get/validated/event}/invitation/from/link

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/event/consequatur/invitation/from/link" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"qkunze@example.com\",
    \"phone\": \"opfuudtdsufvyvddq\",
    \"phone_code\": \"amnii\",
    \"company\": \"hfqcoynlazghdtqtqxbaj\",
    \"sector\": \"wbpilpmufinllwloauydl\",
    \"post\": \"smsjuryvojcybzvrbyick\",
    \"firstname\": \"znkygloigmkwxphlvazjr\",
    \"lastname\": \"cnfbaqywuxhgjjmzuxjub\",
    \"event_id\": \"consequatur\",
    \"type\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/event/consequatur/invitation/from/link"
);

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

let body = {
    "email": "qkunze@example.com",
    "phone": "opfuudtdsufvyvddq",
    "phone_code": "amnii",
    "company": "hfqcoynlazghdtqtqxbaj",
    "sector": "wbpilpmufinllwloauydl",
    "post": "smsjuryvojcybzvrbyick",
    "firstname": "znkygloigmkwxphlvazjr",
    "lastname": "cnfbaqywuxhgjjmzuxjub",
    "event_id": "consequatur",
    "type": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/event/{get/validated/event}/invitation/from/link

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

get/validated/event   string   

Example: consequatur

Body Parameters

gender   string  optional  

email   string   

Must be a valid email address. Must not be greater than 255 characters. Example: qkunze@example.com

phone   string  optional  

This field is required when phone_code is present. Must not be greater than 20 characters. Example: opfuudtdsufvyvddq

phone_code   string  optional  

This field is required when phone is present. Must not be greater than 5 characters. Example: amnii

company   string  optional  

Must not be greater than 255 characters. Example: hfqcoynlazghdtqtqxbaj

sector   string  optional  

Must not be greater than 255 characters. Example: wbpilpmufinllwloauydl

post   string  optional  

Must not be greater than 255 characters. Example: smsjuryvojcybzvrbyick

firstname   string   

Must not be greater than 255 characters. Example: znkygloigmkwxphlvazjr

lastname   string   

Must not be greater than 255 characters. Example: cnfbaqywuxhgjjmzuxjub

event_id   string   

The id of an existing record in the events table. Example: consequatur

type   string   

Example: consequatur

POST api/v1/register/participator

Example request:

curl --request POST \
    "http://core.localhost/api/v1/register/participator" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"username\": \"consequatur\",
    \"password\": \"156277\",
    \"id\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/register/participator"
);

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

let body = {
    "username": "consequatur",
    "password": "156277",
    "id": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/register/participator

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

username   string   

Example: consequatur

password   string   

Must match the regex /^\d{6}$/. Example: 156277

id   string   

Example: consequatur

POST api/v1/create/participator/password

Example request:

curl --request POST \
    "http://core.localhost/api/v1/create/participator/password" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"participator_id\": \"consequatur\",
    \"username\": \"mqeopfuudtdsufvyvddqa\",
    \"password\": \"156277\"
}"

const url = new URL(
    "http://core.localhost/api/v1/create/participator/password"
);

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

let body = {
    "participator_id": "consequatur",
    "username": "mqeopfuudtdsufvyvddqa",
    "password": "156277"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/create/participator/password

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

participator_id   string   

The id of an existing record in the participators table. Example: consequatur

username   string   

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

password   string   

Must match the regex /^\d{6}$/. Example: 156277

POST api/v1/login/participator

Example request:

curl --request POST \
    "http://core.localhost/api/v1/login/participator" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"username\": \"consequatur\",
    \"password\": \"O[2UZ5ij-e\\/dl4m{o,\"
}"

const url = new URL(
    "http://core.localhost/api/v1/login/participator"
);

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

let body = {
    "username": "consequatur",
    "password": "O[2UZ5ij-e\/dl4m{o,"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/login/participator

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

username   string   

The username of an existing record in the participators table. Example: consequatur

password   string   

Example: O[2UZ5ij-e/dl4m{o,

POST api/v1/login/participator/byScan

Example request:

curl --request POST \
    "http://core.localhost/api/v1/login/participator/byScan" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"password\": \"O[2UZ5ij-e\\/dl4m{o,\"
}"

const url = new URL(
    "http://core.localhost/api/v1/login/participator/byScan"
);

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

let body = {
    "id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "password": "O[2UZ5ij-e\/dl4m{o,"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/login/participator/byScan

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

id   string   

Must be a valid UUID. The id of an existing record in the participators table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

password   string   

Example: O[2UZ5ij-e/dl4m{o,

POST api/v1/set/identifier/participator

Example request:

curl --request POST \
    "http://core.localhost/api/v1/set/identifier/participator" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"qkunze@example.com\",
    \"username\": \"consequatur\",
    \"password\": \"consequatur\",
    \"confirm\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/set/identifier/participator"
);

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

let body = {
    "email": "qkunze@example.com",
    "username": "consequatur",
    "password": "consequatur",
    "confirm": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/set/identifier/participator

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

Example: qkunze@example.com

username   string   

Example: consequatur

password   string   

Example: consequatur

confirm   string   

The value and password must match. Example: consequatur

POST api/v1/login/with/qrcode

Example request:

curl --request POST \
    "http://core.localhost/api/v1/login/with/qrcode" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/login/with/qrcode"
);

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

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

Request    Try it out ⚡   

POST api/v1/login/with/qrcode

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/participant/{participatorId}/portal

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/participant/consequatur/portal" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/participant/consequatur/portal"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/participant/{participatorId}/portal

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

participatorId   string   

Example: consequatur

POST api/v1/reset/participator/password

Example request:

curl --request POST \
    "http://core.localhost/api/v1/reset/participator/password" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"token\": \"consequatur\",
    \"password\": \"156277\"
}"

const url = new URL(
    "http://core.localhost/api/v1/reset/participator/password"
);

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

let body = {
    "token": "consequatur",
    "password": "156277"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/reset/participator/password

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

token   string   

Example: consequatur

password   string   

Must match the regex /^\d{6}$/. Example: 156277

GET api/v1/get/event/{event}/details

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/event/consequatur/details" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/event/consequatur/details"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/event/{event}/details

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event   string   

The event. Example: consequatur

GET api/v1/get/{eventForm}/event/form

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/event/form" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/event/form"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{eventForm}/event/form

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

eventForm   string   

Example: consequatur

POST api/v1/send/form/contact

Example request:

curl --request POST \
    "http://core.localhost/api/v1/send/form/contact" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"email\": \"kunde.eloisa@example.com\",
    \"message\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/send/form/contact"
);

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

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "email": "kunde.eloisa@example.com",
    "message": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/send/form/contact

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

email   string   

Must be a valid email address. Example: kunde.eloisa@example.com

message   string   

Example: consequatur

GET api/v1/check/participator/{participator}/before/connect

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/check/participator/consequatur/before/connect" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/check/participator/consequatur/before/connect"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/check/participator/{participator}/before/connect

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

participator   string   

The participator. Example: consequatur

POST api/v1/connect/participator/{participator}

Example request:

curl --request POST \
    "http://core.localhost/api/v1/connect/participator/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"define_password\": false,
    \"username\": \"vmqeopfuudtdsufvyvddq\",
    \"password\": \"156277\"
}"

const url = new URL(
    "http://core.localhost/api/v1/connect/participator/consequatur"
);

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

let body = {
    "define_password": false,
    "username": "vmqeopfuudtdsufvyvddq",
    "password": "156277"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/connect/participator/{participator}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

participator   string   

The participator. Example: consequatur

Body Parameters

define_password   boolean    true false

Example: false

username   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

password   string   

Must match the regex /^\d{6}$/. Example: 156277

GET api/v1/get/participator

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/participator" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/participator"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/participator

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/logout/participator

Example request:

curl --request POST \
    "http://core.localhost/api/v1/logout/participator" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/logout/participator"
);

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

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

Request    Try it out ⚡   

POST api/v1/logout/participator

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/update/participator/profil

Example request:

curl --request POST \
    "http://core.localhost/api/v1/update/participator/profil" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"gender\": \"male\",
    \"firstname\": \"vmqeopfuudtdsufvyvddq\",
    \"lastname\": \"amniihfqcoynlazghdtqt\",
    \"email\": \"andreanne00@example.org\",
    \"phone_code\": \"consequatur\",
    \"phone\": \"consequatur\",
    \"company\": \"mqeopfuudtdsufvyvddqa\",
    \"post\": \"mniihfqcoynlazghdtqtq\",
    \"sector\": \"xbajwbpilpmufinllwloa\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/participator/profil"
);

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

let body = {
    "gender": "male",
    "firstname": "vmqeopfuudtdsufvyvddq",
    "lastname": "amniihfqcoynlazghdtqt",
    "email": "andreanne00@example.org",
    "phone_code": "consequatur",
    "phone": "consequatur",
    "company": "mqeopfuudtdsufvyvddqa",
    "post": "mniihfqcoynlazghdtqtq",
    "sector": "xbajwbpilpmufinllwloa"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/update/participator/profil

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

gender   string  optional  

Example: male

Must be one of:

• male
• female

firstname   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

lastname   string   

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

email   string   

Must be a valid email address. Example: andreanne00@example.org

phone_code   string   

Example: consequatur

phone   string   

Example: consequatur

company   string  optional  

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

post   string  optional  

Must not be greater than 255 characters. Example: mniihfqcoynlazghdtqtq

sector   string  optional  

Must not be greater than 255 characters. Example: xbajwbpilpmufinllwloa

GET api/v1/get/{atelier}/detail

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/detail" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/detail"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{atelier}/detail

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

atelier   string   

Example: consequatur

POST api/v1/add/{participator}/to/carnet

Example request:

curl --request POST \
    "http://core.localhost/api/v1/add/consequatur/to/carnet" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"note\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/add/consequatur/to/carnet"
);

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

let body = {
    "note": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/add/{participator}/to/carnet

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

participator   string   

Example: consequatur

Body Parameters

note   string  optional  

Example: consequatur

GET api/v1/get/events

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/events" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/events"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/events

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/{events}/event/detail

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/event/detail" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/event/detail"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{events}/event/detail

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

events   string   

Example: consequatur

GET api/v1/get/participator/from/Carnet

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/participator/from/Carnet" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/participator/from/Carnet"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/participator/from/Carnet

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/carnet/addresses

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/carnet/addresses" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/carnet/addresses"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/carnet/addresses

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/add/note

Example request:

curl --request POST \
    "http://core.localhost/api/v1/add/note" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/add/note"
);

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

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

Request    Try it out ⚡   

POST api/v1/add/note

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/connect/participator/to/{atelier}/atelier

Example request:

curl --request POST \
    "http://core.localhost/api/v1/connect/participator/to/consequatur/atelier" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/connect/participator/to/consequatur/atelier"
);

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

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

Request    Try it out ⚡   

POST api/v1/connect/participator/to/{atelier}/atelier

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

atelier   string   

Example: consequatur

GET api/v1/get/participator/to/{atelier}/atelier

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/participator/to/consequatur/atelier" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/participator/to/consequatur/atelier"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/participator/to/{atelier}/atelier

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

atelier   string   

Example: consequatur

GET api/v1/get/participator/to/{event}/event

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/participator/to/consequatur/event" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/participator/to/consequatur/event"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/participator/to/{event}/event

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event   string   

Example: consequatur

POST api/v1/send/message/{atelier}/participator

Example request:

curl --request POST \
    "http://core.localhost/api/v1/send/message/consequatur/participator" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/send/message/consequatur/participator"
);

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

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

Request    Try it out ⚡   

POST api/v1/send/message/{atelier}/participator

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

atelier   string   

Example: consequatur

GET api/v1/get/questions/{atelier}/participator

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/questions/consequatur/participator" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/questions/consequatur/participator"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/questions/{atelier}/participator

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

atelier   string   

Example: consequatur

GET api/v1/list/participator/questions/{atelier}/atelier

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/list/participator/questions/consequatur/atelier" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/list/participator/questions/consequatur/atelier"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/list/participator/questions/{atelier}/atelier

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

atelier   string   

Example: consequatur

POST api/v1/select/question/{question}

Example request:

curl --request POST \
    "http://core.localhost/api/v1/select/question/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/select/question/consequatur"
);

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

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

Request    Try it out ⚡   

POST api/v1/select/question/{question}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

question   string   

The question. Example: consequatur

GET api/v1/get/selected/questions/{atelier}

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/selected/questions/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/selected/questions/consequatur"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/selected/questions/{atelier}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

atelier   string   

Example: consequatur

POST api/v1/connect/participator/{guest}/to/private/{atelier}/atelier

Example request:

curl --request POST \
    "http://core.localhost/api/v1/connect/participator/consequatur/to/private/consequatur/atelier" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/connect/participator/consequatur/to/private/consequatur/atelier"
);

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

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

Request    Try it out ⚡   

POST api/v1/connect/participator/{guest}/to/private/{atelier}/atelier

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

guest   string   

Example: consequatur

atelier   string   

Example: consequatur

GET api/v1/get/participator/to/private/{atelier}/atelier

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/participator/to/private/consequatur/atelier" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/participator/to/private/consequatur/atelier"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/participator/to/private/{atelier}/atelier

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

atelier   string   

Example: consequatur

GET api/v1/get/private/{atelier}/atelier/presence

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/private/consequatur/atelier/presence" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/private/consequatur/atelier/presence"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/private/{atelier}/atelier/presence

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

atelier   string   

Example: consequatur

GET api/v1/get/private/{event}/atelier

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/private/consequatur/atelier" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/private/consequatur/atelier"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/private/{event}/atelier

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event   string   

Example: consequatur

GET api/v1/get/atelier/{atelier}/detail

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/atelier/consequatur/detail" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/atelier/consequatur/detail"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/atelier/{atelier}/detail

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

atelier   string   

The atelier. Example: consequatur

GET api/v1/get/atelier/{atelier}/program/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/atelier/consequatur/program/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/atelier/consequatur/program/collection"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/atelier/{atelier}/program/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

atelier   string   

The atelier. Example: consequatur

GET api/v1/show/{atelier}/atelier/program/{programId}

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/show/consequatur/atelier/program/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/show/consequatur/atelier/program/consequatur"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/show/{atelier}/atelier/program/{programId}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

atelier   string   

Example: consequatur

programId   string   

Example: consequatur

GET api/v1/get/private/atelier/{atelier}/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/private/atelier/consequatur/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/private/atelier/consequatur/datatables"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/private/atelier/{atelier}/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

atelier   string   

The atelier. Example: consequatur

GET api/v1/get/event/{event}/program/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/event/consequatur/program/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"event_id\": \"consequatur\",
    \"search\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/get/event/consequatur/program/collection"
);

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

let body = {
    "event_id": "consequatur",
    "search": "consequatur"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/event/{event}/program/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event   string   

The event. Example: consequatur

Body Parameters

event_id   string   

The id of an existing record in the events table. Example: consequatur

search   string  optional  

Example: consequatur

GET api/v1/show/{event}/event/program/{programId}

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/show/consequatur/event/program/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/show/consequatur/event/program/consequatur"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/show/{event}/event/program/{programId}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event   string   

Example: consequatur

programId   string   

Example: consequatur

GET api/v1/get/current/events/participator

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/current/events/participator" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/current/events/participator"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/current/events/participator

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/connect/participator/to/{event}/event

Example request:

curl --request POST \
    "http://core.localhost/api/v1/connect/participator/to/consequatur/event" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/connect/participator/to/consequatur/event"
);

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

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

Request    Try it out ⚡   

POST api/v1/connect/participator/to/{event}/event

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event   string   

Example: consequatur

GET api/v1/get/stand/{shopId}/members

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/stand/consequatur/members" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/stand/consequatur/members"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/stand/{shopId}/members

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shopId   string   

Example: consequatur

GET api/v1/get/event/nps

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/event/nps" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/event/nps"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/event/nps

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/atelier/notes/{atelier}

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/atelier/notes/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/atelier/notes/consequatur"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/atelier/notes/{atelier}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

atelier   string   

Example: consequatur

POST api/v1/store/atelier/notes

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/atelier/notes" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"content\": \"consequatur\",
    \"atelier_id\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/atelier/notes"
);

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

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "content": "consequatur",
    "atelier_id": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/atelier/notes

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

content   string   

Example: consequatur

atelier_id   string   

The id of an existing record in the ateliers table. Example: consequatur

PATCH api/v1/update/atelier/notes/{note}

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/atelier/notes/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"content\": \"consequatur\",
    \"atelier_id\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/atelier/notes/consequatur"
);

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

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "content": "consequatur",
    "atelier_id": "consequatur"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/atelier/notes/{note}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

note   string   

The note. Example: consequatur

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

content   string   

Example: consequatur

atelier_id   string   

The id of an existing record in the ateliers table. Example: consequatur

DELETE api/v1/delete/atelier/notes/{note}

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/atelier/notes/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/atelier/notes/consequatur"
);

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

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

Request    Try it out ⚡   

DELETE api/v1/delete/atelier/notes/{note}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

note   string   

The note. Example: consequatur

POST api/v1/login/seller

Example request:

curl --request POST \
    "http://core.localhost/api/v1/login/seller" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"username\": \"consequatur\",
    \"password\": \"O[2UZ5ij-e\\/dl4m{o,\"
}"

const url = new URL(
    "http://core.localhost/api/v1/login/seller"
);

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

let body = {
    "username": "consequatur",
    "password": "O[2UZ5ij-e\/dl4m{o,"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/login/seller

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

username   string   

The username of an existing record in the participators table. Example: consequatur

password   string   

Example: O[2UZ5ij-e/dl4m{o,

shop   string  optional  

The id of an existing record in the shops table.

POST api/v1/logout/seller

Example request:

curl --request POST \
    "http://core.localhost/api/v1/logout/seller" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/logout/seller"
);

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

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

Request    Try it out ⚡   

POST api/v1/logout/seller

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/seller

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/seller" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/seller"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/seller

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/events/send/mail

Example request:

curl --request POST \
    "http://core.localhost/api/v1/events/send/mail" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"emails\": [
        \"qkunze@example.com\"
    ],
    \"subject\": \"consequatur\",
    \"message\": \"consequatur\",
    \"from\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/events/send/mail"
);

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

let body = {
    "emails": [
        "qkunze@example.com"
    ],
    "subject": "consequatur",
    "message": "consequatur",
    "from": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/events/send/mail

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

emails   string[]   

Must be a valid email address.

subject   string   

Example: consequatur

message   string   

Example: consequatur

from   string   

Example: consequatur

POST api/v1/events/send/invitation/whatsapp

Example request:

curl --request POST \
    "http://core.localhost/api/v1/events/send/invitation/whatsapp" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"invitation\": [
        {
            \"phone\": \"consequatur\",
            \"gender\": \"consequatur\",
            \"firstname\": \"consequatur\",
            \"lastname\": \"consequatur\"
        }
    ],
    \"message\": \"consequatur\",
    \"event_id\": \"98adc52b-966d-39db-809a-55902ee7228f\"
}"

const url = new URL(
    "http://core.localhost/api/v1/events/send/invitation/whatsapp"
);

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

let body = {
    "invitation": [
        {
            "phone": "consequatur",
            "gender": "consequatur",
            "firstname": "consequatur",
            "lastname": "consequatur"
        }
    ],
    "message": "consequatur",
    "event_id": "98adc52b-966d-39db-809a-55902ee7228f"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/events/send/invitation/whatsapp

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

invitation   object[]   

phone   string   

Example: consequatur

gender   string  optional  

Example: consequatur

firstname   string  optional  

Example: consequatur

lastname   string  optional  

Example: consequatur

message   string  optional  

Example: consequatur

event_id   string  optional  

Must be a valid UUID. The id of an existing record in the events table. Example: 98adc52b-966d-39db-809a-55902ee7228f

POST api/v1/store/event/{eventId}/invitation

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/event/consequatur/invitation" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"gender\": \"female\",
    \"email\": \"qkunze@example.com\",
    \"phone\": \"opfuudtdsufvyvddq\",
    \"phone_code\": \"amnii\",
    \"company\": \"hfqcoynlazghdtqtqxbaj\",
    \"sector\": \"wbpilpmufinllwloauydl\",
    \"post\": \"smsjuryvojcybzvrbyick\",
    \"firstname\": \"znkygloigmkwxphlvazjr\",
    \"lastname\": \"cnfbaqywuxhgjjmzuxjub\",
    \"event_id\": \"consequatur\",
    \"company_id\": \"consequatur\",
    \"status_id\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/event/consequatur/invitation"
);

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

let body = {
    "gender": "female",
    "email": "qkunze@example.com",
    "phone": "opfuudtdsufvyvddq",
    "phone_code": "amnii",
    "company": "hfqcoynlazghdtqtqxbaj",
    "sector": "wbpilpmufinllwloauydl",
    "post": "smsjuryvojcybzvrbyick",
    "firstname": "znkygloigmkwxphlvazjr",
    "lastname": "cnfbaqywuxhgjjmzuxjub",
    "event_id": "consequatur",
    "company_id": "consequatur",
    "status_id": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/event/{eventId}/invitation

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

eventId   string   

Example: consequatur

Body Parameters

gender   string   

Example: female

Must be one of:

• male
• female

email   string  optional  

Must be a valid email address. Must not be greater than 255 characters. Example: qkunze@example.com

phone   string  optional  

Must not be greater than 20 characters. Example: opfuudtdsufvyvddq

phone_code   string  optional  

This field is required when phone is present. Must not be greater than 5 characters. Example: amnii

company   string  optional  

Must not be greater than 255 characters. Example: hfqcoynlazghdtqtqxbaj

sector   string  optional  

Must not be greater than 255 characters. Example: wbpilpmufinllwloauydl

post   string  optional  

Must not be greater than 255 characters. Example: smsjuryvojcybzvrbyick

firstname   string   

Must not be greater than 255 characters. Example: znkygloigmkwxphlvazjr

lastname   string   

Must not be greater than 255 characters. Example: cnfbaqywuxhgjjmzuxjub

event_id   string   

The id of an existing record in the events table. Example: consequatur

company_id   string  optional  

The id of an existing record in the contacts table. Example: consequatur

status_id   string   

The id of an existing record in the event_statuses table. Example: consequatur

POST api/v1/update/event/{id}/invitation

Example request:

curl --request POST \
    "http://core.localhost/api/v1/update/event/consequatur/invitation" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"gender\": \"female\",
    \"email\": \"justice61@example.com\",
    \"phone\": \"uudtdsufvyvddqamn\",
    \"phone_code\": \"iihfq\",
    \"company\": \"coynlazghdtqtqxbajwbp\",
    \"sector\": \"ilpmufinllwloauydlsms\",
    \"post\": \"juryvojcybzvrbyickznk\",
    \"firstname\": \"ygloigmkwxphlvazjrcnf\",
    \"lastname\": \"baqywuxhgjjmzuxjubqou\",
    \"event_id\": \"consequatur\",
    \"company_id\": \"consequatur\",
    \"type\": \"PARTICIPANT\",
    \"status_id\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/event/consequatur/invitation"
);

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

let body = {
    "id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "gender": "female",
    "email": "justice61@example.com",
    "phone": "uudtdsufvyvddqamn",
    "phone_code": "iihfq",
    "company": "coynlazghdtqtqxbajwbp",
    "sector": "ilpmufinllwloauydlsms",
    "post": "juryvojcybzvrbyickznk",
    "firstname": "ygloigmkwxphlvazjrcnf",
    "lastname": "baqywuxhgjjmzuxjubqou",
    "event_id": "consequatur",
    "company_id": "consequatur",
    "type": "PARTICIPANT",
    "status_id": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/update/event/{id}/invitation

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the event. Example: consequatur

Body Parameters

id   string   

Must be a valid UUID. The id of an existing record in the participators table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

gender   string   

Example: female

Must be one of:

• male
• female

email   string  optional  

Must be a valid email address. Must not be greater than 255 characters. Example: justice61@example.com

phone   string  optional  

Must not be greater than 20 characters. Example: uudtdsufvyvddqamn

phone_code   string  optional  

This field is required when phone is present. Must not be greater than 5 characters. Example: iihfq

company   string  optional  

Must not be greater than 255 characters. Example: coynlazghdtqtqxbajwbp

sector   string  optional  

Must not be greater than 255 characters. Example: ilpmufinllwloauydlsms

post   string  optional  

Must not be greater than 255 characters. Example: juryvojcybzvrbyickznk

firstname   string   

Must not be greater than 255 characters. Example: ygloigmkwxphlvazjrcnf

lastname   string   

Must not be greater than 255 characters. Example: baqywuxhgjjmzuxjubqou

event_id   string  optional  

The id of an existing record in the events table. Example: consequatur

company_id   string  optional  

The id of an existing record in the contacts table. Example: consequatur

type   string  optional  

Example: PARTICIPANT

Must be one of:

• EXPONENT
• PARTICIPANT
• SPONSOR

status_id   string  optional  

The id of an existing record in the event_statuses table. Example: consequatur

GET api/v1/resend/{eventId}/event/{participatorId}/invitation

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/resend/consequatur/event/consequatur/invitation" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/resend/consequatur/event/consequatur/invitation"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/resend/{eventId}/event/{participatorId}/invitation

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

eventId   string   

Example: consequatur

participatorId   string   

Example: consequatur

POST api/v1/validate/participator/{participatorId}/invitation

Example request:

curl --request POST \
    "http://core.localhost/api/v1/validate/participator/consequatur/invitation" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/validate/participator/consequatur/invitation"
);

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

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

Request    Try it out ⚡   

POST api/v1/validate/participator/{participatorId}/invitation

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

participatorId   string   

Example: consequatur

GET api/v1/get/event/{eventId}/invitations

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/event/consequatur/invitations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"invitation_status\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/get/event/consequatur/invitations"
);

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

let body = {
    "invitation_status": "consequatur"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/event/{eventId}/invitations

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

eventId   string   

Example: consequatur

Body Parameters

invitation_status   string  optional  

Example: consequatur

GET api/v1/get/event/{eventId}/invitations/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/event/consequatur/invitations/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/event/consequatur/invitations/datatables"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/event/{eventId}/invitations/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

eventId   string   

Example: consequatur

GET api/v1/get/validated/event/{eventId}/invitations/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/validated/event/consequatur/invitations/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/validated/event/consequatur/invitations/datatables"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/validated/event/{eventId}/invitations/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

eventId   string   

Example: consequatur

GET api/v1/get/event/permission/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/event/permission/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/event/permission/collection"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/event/permission/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/event/status/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/event/status/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/event/status/collection"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/event/status/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/event/status/datatable

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/event/status/datatable" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/event/status/datatable"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/event/status/datatable

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/event/status

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/event/status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\",
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"permission_ids\": [
        \"fefb079f-5b81-3552-831f-ed3f89669781\"
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/store/event/status"
);

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

let body = {
    "name": "consequatur",
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "permission_ids": [
        "fefb079f-5b81-3552-831f-ed3f89669781"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/event/status

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Example: consequatur

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

permission_ids   string[]  optional  

Must be a valid UUID. The id of an existing record in the event_permissions table.

PATCH api/v1/update/{eventStatus}/event/status

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/event/status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\",
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"permission_ids\": [
        \"fefb079f-5b81-3552-831f-ed3f89669781\"
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/event/status"
);

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

let body = {
    "name": "consequatur",
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "permission_ids": [
        "fefb079f-5b81-3552-831f-ed3f89669781"
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{eventStatus}/event/status

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

eventStatus   string   

Example: consequatur

Body Parameters

name   string   

Example: consequatur

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

permission_ids   string[]  optional  

Must be a valid UUID. The id of an existing record in the event_permissions table.

GET api/v1/get/{eventStatus}/event/status

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/event/status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/event/status"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{eventStatus}/event/status

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

eventStatus   string   

Example: consequatur

GET api/v1/delete/{eventStatus}/event/status

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/delete/consequatur/event/status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/event/status"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/delete/{eventStatus}/event/status

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

eventStatus   string   

Example: consequatur

GET api/v1/get/{atelier}/atelier

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/atelier" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/atelier"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{atelier}/atelier

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

atelier   string   

Example: consequatur

PATCH api/v1/done/{atelier}/atelier

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/done/consequatur/atelier" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/done/consequatur/atelier"
);

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

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

Request    Try it out ⚡   

PATCH api/v1/done/{atelier}/atelier

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

atelier   string   

Example: consequatur

GET api/v1/get/{atelier}/atelier/presence/datatable

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/atelier/presence/datatable" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/atelier/presence/datatable"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{atelier}/atelier/presence/datatable

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

atelier   string   

Example: consequatur

GET api/v1/get/ateliers/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/ateliers/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/ateliers/collection"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/ateliers/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/event/{event}/ateliers/datatable

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/event/consequatur/ateliers/datatable" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/event/consequatur/ateliers/datatable"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/event/{event}/ateliers/datatable

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event   string   

The event. Example: consequatur

GET api/v1/get/{event_id}/event/ateliers

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/event/ateliers" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/event/ateliers"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{event_id}/event/ateliers

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event_id   string   

The ID of the event. Example: consequatur

DELETE api/v1/delete/{atelier_id}/atelier

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/atelier" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/atelier"
);

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

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

Request    Try it out ⚡   

DELETE api/v1/delete/{atelier_id}/atelier

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

atelier_id   string   

The ID of the atelier. Example: consequatur

GET api/v1/generate/{atelier}/atelier/qrCode

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/generate/consequatur/atelier/qrCode" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/generate/consequatur/atelier/qrCode"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/generate/{atelier}/atelier/qrCode

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

atelier   string   

Example: consequatur

GET api/v1/download/{atelier}/atelier/qrCode

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/download/consequatur/atelier/qrCode" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/download/consequatur/atelier/qrCode"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/download/{atelier}/atelier/qrCode

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

atelier   string   

Example: consequatur

POST api/v1/add/guests/to/private/{atelier}/atelier

Example request:

curl --request POST \
    "http://core.localhost/api/v1/add/guests/to/private/consequatur/atelier" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"invitation\": [
        {
            \"email\": \"qkunze@example.com\",
            \"gender\": \"female\"
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/add/guests/to/private/consequatur/atelier"
);

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

let body = {
    "invitation": [
        {
            "email": "qkunze@example.com",
            "gender": "female"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/add/guests/to/private/{atelier}/atelier

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

atelier   string   

Example: consequatur

Body Parameters

guests   string[]  optional  

The id of an existing record in the participators table.

invitation   object[]  optional  

email   string  optional  

Must be a valid email address. Example: qkunze@example.com

gender   string  optional  

This field is required when invitation.*.email is present. Example: female

Must be one of:

• male
• female

firstname   string  optional  

This field is required when invitation.*.email is present.

lastname   string  optional  

This field is required when invitation.*.email is present.

POST api/v1/send/invitation/guest/{guest}/to/private/{atelier}/atelier

Example request:

curl --request POST \
    "http://core.localhost/api/v1/send/invitation/guest/consequatur/to/private/consequatur/atelier" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/send/invitation/guest/consequatur/to/private/consequatur/atelier"
);

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

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

Request    Try it out ⚡   

POST api/v1/send/invitation/guest/{guest}/to/private/{atelier}/atelier

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

guest   string   

The guest. Example: consequatur

atelier   string   

Example: consequatur

POST api/v1/send/invitation/guests/to/private/{atelier}/atelier

Example request:

curl --request POST \
    "http://core.localhost/api/v1/send/invitation/guests/to/private/consequatur/atelier" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"body\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/send/invitation/guests/to/private/consequatur/atelier"
);

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

let body = {
    "body": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/send/invitation/guests/to/private/{atelier}/atelier

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

atelier   string   

Example: consequatur

Body Parameters

body   string   

Example: consequatur

guest_ids   string[]  optional  

The id of an existing record in the participators table.

POST api/v1/remove/guests/to/private/{atelier}/atelier

Example request:

curl --request POST \
    "http://core.localhost/api/v1/remove/guests/to/private/consequatur/atelier" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"guests\": [
        \"66529e01-d113-3473-8d6f-9e11e09332ea\"
    ],
    \"emails\": [
        \"qeopfuudtdsufvyvddqam\"
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/remove/guests/to/private/consequatur/atelier"
);

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

let body = {
    "guests": [
        "66529e01-d113-3473-8d6f-9e11e09332ea"
    ],
    "emails": [
        "qeopfuudtdsufvyvddqam"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/remove/guests/to/private/{atelier}/atelier

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

atelier   string   

Example: consequatur

Body Parameters

guests   string[]  optional  

Must be a valid UUID. The id of an existing record in the participators table.

emails   string[]  optional  

Must be a valid email address. Must not be greater than 255 characters.

GET api/v1/get/atelier/note/{atelier}

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/atelier/note/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/atelier/note/consequatur"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/atelier/note/{atelier}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

atelier   string   

Example: consequatur

POST api/v1/store/atelier/note

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/atelier/note" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"content\": \"consequatur\",
    \"atelier_id\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/atelier/note"
);

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

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "content": "consequatur",
    "atelier_id": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/atelier/note

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

content   string   

Example: consequatur

atelier_id   string   

The id of an existing record in the ateliers table. Example: consequatur

PATCH api/v1/update/atelier/note/{note}

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/atelier/note/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"content\": \"consequatur\",
    \"atelier_id\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/atelier/note/consequatur"
);

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

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "content": "consequatur",
    "atelier_id": "consequatur"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/atelier/note/{note}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

note   string   

The note. Example: consequatur

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

content   string   

Example: consequatur

atelier_id   string   

The id of an existing record in the ateliers table. Example: consequatur

DELETE api/v1/delete/atelier/note/{note}

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/atelier/note/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/atelier/note/consequatur"
);

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

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

Request    Try it out ⚡   

DELETE api/v1/delete/atelier/note/{note}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

note   string   

The note. Example: consequatur

GET api/v1/get/event/{event}/atelier

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/event/consequatur/atelier" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/event/consequatur/atelier"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/event/{event}/atelier

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event   string   

The event. Example: consequatur

PATCH api/v1/update/{participator}/status/atelier

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/status/atelier" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status_id\": \"consequatur\",
    \"event_id\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/status/atelier"
);

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

let body = {
    "status_id": "consequatur",
    "event_id": "consequatur"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{participator}/status/atelier

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

participator   string   

Example: consequatur

Body Parameters

status_id   string   

The id of an existing record in the event_statuses table. Example: consequatur

event_id   string   

The id of an existing record in the events table. Example: consequatur

POST api/v1/store/event

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/event" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "title=vmqeopfuudtdsufvyvddq"\
    --form "place=amniihfqcoynlazghdtqt"\
    --form "latitude=-89"\
    --form "longitude=-179"\
    --form "number_of_places=6"\
    --form "timezone_id=consequatur"\
    --form "description=Dolorum amet iste laborum eius est dolor."\
    --form "website_link=consequatur"\
    --form "is_free=1"\
    --form "days[][date]=12-06-2025"\
    --form "days[][startHour]=12:56"\
    --form "days[][endHour]=12:56"\
    --form "logo=@/tmp/phpe6NGGC" \
    --form "banner=@/tmp/php20d6yp" 

const url = new URL(
    "http://core.localhost/api/v1/store/event"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('title', 'vmqeopfuudtdsufvyvddq');
body.append('place', 'amniihfqcoynlazghdtqt');
body.append('latitude', '-89');
body.append('longitude', '-179');
body.append('number_of_places', '6');
body.append('timezone_id', 'consequatur');
body.append('description', 'Dolorum amet iste laborum eius est dolor.');
body.append('website_link', 'consequatur');
body.append('is_free', '1');
body.append('days[][date]', '12-06-2025');
body.append('days[][startHour]', '12:56');
body.append('days[][endHour]', '12:56');
body.append('logo', document.querySelector('input[name="logo"]').files[0]);
body.append('banner', document.querySelector('input[name="banner"]').files[0]);

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

Request    Try it out ⚡   

POST api/v1/store/event

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

place   string   

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

latitude   number  optional  

Must be between -90 and 90. Example: -89

longitude   number  optional  

Must be between -180 and 180. Example: -179

logo   file  optional  

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/phpe6NGGC

banner   file  optional  

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/php20d6yp

number_of_places   integer  optional  

Must be at least 0. Example: 6

timezone_id   string   

The id of an existing record in the time_zones table. Example: consequatur

description   string   

Must not be greater than 5000 characters. Example: Dolorum amet iste laborum eius est dolor.

website_link   string  optional  

Example: consequatur

is_free   boolean  optional   true false

Example: true

days   object[]   

date   string   

Must be a valid date in the format d-m-Y. Example: 12-06-2025

startHour   string   

Must be a valid date in the format H:i. Example: 12:56

endHour   string   

Must be a valid date in the format H:i. Example: 12:56

POST api/v1/update/{event_id}/event

Example request:

curl --request POST \
    "http://core.localhost/api/v1/update/consequatur/event" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "title=vmqeopfuudtdsufvyvddq"\
    --form "place=amniihfqcoynlazghdtqt"\
    --form "latitude=-89"\
    --form "longitude=-179"\
    --form "timezone_id=consequatur"\
    --form "number_of_places=45"\
    --form "description=Amet iste laborum eius est dolor dolores."\
    --form "website_link=consequatur"\
    --form "is_free=1"\
    --form "days[][date]=12-06-2025"\
    --form "days[][startHour]=12:56"\
    --form "days[][endHour]=12:56"\
    --form "remove[]=consequatur"\
    --form "logo=@/tmp/phpUnNAis" 

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/event"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('title', 'vmqeopfuudtdsufvyvddq');
body.append('place', 'amniihfqcoynlazghdtqt');
body.append('latitude', '-89');
body.append('longitude', '-179');
body.append('timezone_id', 'consequatur');
body.append('number_of_places', '45');
body.append('description', 'Amet iste laborum eius est dolor dolores.');
body.append('website_link', 'consequatur');
body.append('is_free', '1');
body.append('days[][date]', '12-06-2025');
body.append('days[][startHour]', '12:56');
body.append('days[][endHour]', '12:56');
body.append('remove[]', 'consequatur');
body.append('logo', document.querySelector('input[name="logo"]').files[0]);

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

Request    Try it out ⚡   

POST api/v1/update/{event_id}/event

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

event_id   string   

The ID of the event. Example: consequatur

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

place   string   

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

latitude   number  optional  

Must be between -90 and 90. Example: -89

longitude   number  optional  

Must be between -180 and 180. Example: -179

logo   file  optional  

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/phpUnNAis

timezone_id   string   

The id of an existing record in the time_zones table. Example: consequatur

number_of_places   integer  optional  

Must be at least 0. Example: 45

description   string   

Must not be greater than 5000 characters. Example: Amet iste laborum eius est dolor dolores.

website_link   string  optional  

Example: consequatur

is_free   boolean    true false

Example: true

days   object[]   

hour_id   string  optional  

date   string   

Must be a valid date in the format d-m-Y. Example: 12-06-2025

startHour   string   

Must be a valid date in the format H:i. Example: 12:56

endHour   string   

Must be a valid date in the format H:i. Example: 12:56

remove   string[]   

The id of an existing record in the event_dates table.

DELETE api/v1/delete/{event_id}/event

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/event" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/event"
);

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

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

Request    Try it out ⚡   

DELETE api/v1/delete/{event_id}/event

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event_id   string   

The ID of the event. Example: consequatur

GET api/v1/get/list/event

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/list/event" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/list/event"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/list/event

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/detail/{event}/event

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/detail/consequatur/event" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/detail/consequatur/event"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/detail/{event}/event

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event   string   

Example: consequatur

GET api/v1/get/events/datatable

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/events/datatable" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/events/datatable"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/events/datatable

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/generate/{event}/event/qrCode

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/generate/consequatur/event/qrCode" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/generate/consequatur/event/qrCode"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/generate/{event}/event/qrCode

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event   string   

Example: consequatur

GET api/v1/download/{event}/event/qrCode

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/download/consequatur/event/qrCode" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/download/consequatur/event/qrCode"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/download/{event}/event/qrCode

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event   string   

Example: consequatur

POST api/v1/update/{event}/event/banner

Example request:

curl --request POST \
    "http://core.localhost/api/v1/update/consequatur/event/banner" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "banner=@/tmp/phpSaAoSN" 

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/event/banner"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('banner', document.querySelector('input[name="banner"]').files[0]);

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

Request    Try it out ⚡   

POST api/v1/update/{event}/event/banner

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

event   string   

Example: consequatur

Body Parameters

banner   file   

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/phpSaAoSN

POST api/v1/update/{event}/event/logo

Example request:

curl --request POST \
    "http://core.localhost/api/v1/update/consequatur/event/logo" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "logo=@/tmp/phpBYzuS4" 

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/event/logo"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('logo', document.querySelector('input[name="logo"]').files[0]);

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

Request    Try it out ⚡   

POST api/v1/update/{event}/event/logo

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

event   string   

Example: consequatur

Body Parameters

logo   file   

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/phpBYzuS4

GET api/v1/get/event/{event}/programs/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/event/consequatur/programs/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"event_id\": \"consequatur\",
    \"search\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/get/event/consequatur/programs/collection"
);

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

let body = {
    "event_id": "consequatur",
    "search": "consequatur"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/event/{event}/programs/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event   string   

The event. Example: consequatur

Body Parameters

event_id   string   

The id of an existing record in the events table. Example: consequatur

search   string  optional  

Example: consequatur

DELETE api/v1/delete/event/{event}/program/{programId}

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/event/consequatur/program/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/event/consequatur/program/consequatur"
);

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

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

Request    Try it out ⚡   

DELETE api/v1/delete/event/{event}/program/{programId}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event   string   

The event. Example: consequatur

programId   string   

Example: consequatur

GET api/v1/get/atelier/{atelier}/programs/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/atelier/consequatur/programs/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/atelier/consequatur/programs/collection"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/atelier/{atelier}/programs/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

atelier   string   

The atelier. Example: consequatur

POST api/v1/store/atelier/{atelier}/program

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/atelier/consequatur/program" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"program\": [
        {
            \"title\": \"vmqeopfuudtdsufvyvddq\",
            \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
            \"start_time\": \"12:56\",
            \"end_time\": \"2106-07-12\",
            \"date\": \"2025-06-12T12:56:30\"
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/store/atelier/consequatur/program"
);

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

let body = {
    "program": [
        {
            "title": "vmqeopfuudtdsufvyvddq",
            "description": "Dolores dolorum amet iste laborum eius est dolor.",
            "start_time": "12:56",
            "end_time": "2106-07-12",
            "date": "2025-06-12T12:56:30"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/atelier/{atelier}/program

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

atelier   string   

The atelier. Example: consequatur

Body Parameters

program   object[]   

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

start_time   string   

Must be a valid date in the format H:i. Example: 12:56

end_time   string   

Must be a valid date in the format H:i. Must be a date after program.*.start_time. Example: 2106-07-12

date   string  optional  

Must be a valid date. Example: 2025-06-12T12:56:30

PATCH api/v1/update/atelier/{atelier}/program/{programId}

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/atelier/consequatur/program/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"start_time\": \"12:56\",
    \"end_time\": \"2106-07-12\",
    \"date\": \"2025-06-12T12:56:30\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/atelier/consequatur/program/consequatur"
);

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

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "start_time": "12:56",
    "end_time": "2106-07-12",
    "date": "2025-06-12T12:56:30"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/atelier/{atelier}/program/{programId}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

atelier   string   

The atelier. Example: consequatur

programId   string   

Example: consequatur

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

start_time   string   

Must be a valid date in the format H:i. Example: 12:56

end_time   string   

Must be a valid date in the format H:i. Must be a date after start_time. Example: 2106-07-12

date   string  optional  

Must be a valid date. Example: 2025-06-12T12:56:30

GET api/v1/show/atelier/{atelier}/program/{programId}

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/show/atelier/consequatur/program/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/show/atelier/consequatur/program/consequatur"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/show/atelier/{atelier}/program/{programId}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

atelier   string   

The atelier. Example: consequatur

programId   string   

Example: consequatur

GET api/v1/delete/atelier/{atelier}/program/{programId}

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/delete/atelier/consequatur/program/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/atelier/consequatur/program/consequatur"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/delete/atelier/{atelier}/program/{programId}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

atelier   string   

The atelier. Example: consequatur

programId   string   

Example: consequatur

GET api/v1/get/{event_id}/event/nps

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/event/nps" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/event/nps"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{event_id}/event/nps

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event_id   string   

The ID of the event. Example: consequatur

POST api/v1/store/event/images

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/event/images" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "event_id=consequatur"\
    --form "images[]=@/tmp/phplHBW9I" 

const url = new URL(
    "http://core.localhost/api/v1/store/event/images"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('event_id', 'consequatur');
body.append('images[]', document.querySelector('input[name="images[]"]').files[0]);

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

Request    Try it out ⚡   

POST api/v1/store/event/images

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

images   file[]   

Must be an image. Must not be greater than 2048 kilobytes.

event_id   string   

The id of an existing record in the events table. Example: consequatur

GET api/v1/get/{event_id}/event/images

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/event/images" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/event/images"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{event_id}/event/images

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event_id   string   

The ID of the event. Example: consequatur

DELETE api/v1/delete/{event_id}/event/images

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/event/images" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/event/images"
);

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

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

Request    Try it out ⚡   

DELETE api/v1/delete/{event_id}/event/images

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event_id   string   

The ID of the event. Example: consequatur

POST api/v1/send/event/invitation

Example request:

curl --request POST \
    "http://core.localhost/api/v1/send/event/invitation" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"event_id\": \"consequatur\",
    \"email\": [
        {
            \"email\": \"qkunze@example.com\",
            \"gender\": \"female\",
            \"firstname\": \"opfuudtdsufvyvddqamni\",
            \"lastname\": \"ihfqcoynlazghdtqtqxba\"
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/send/event/invitation"
);

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

let body = {
    "event_id": "consequatur",
    "email": [
        {
            "email": "qkunze@example.com",
            "gender": "female",
            "firstname": "opfuudtdsufvyvddqamni",
            "lastname": "ihfqcoynlazghdtqtqxba"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/send/event/invitation

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

event_id   string   

The id of an existing record in the events table. Example: consequatur

email   object[]   

email   string   

Must be a valid email address. Example: qkunze@example.com

gender   string  optional  

Example: female

Must be one of:

• male
• female

firstname   string  optional  

Must not be greater than 255 characters. Example: opfuudtdsufvyvddqamni

lastname   string  optional  

Must not be greater than 255 characters. Example: ihfqcoynlazghdtqtqxba

POST api/v1/send/event/invitation/by/import

Example request:

curl --request POST \
    "http://core.localhost/api/v1/send/event/invitation/by/import" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "event_id=consequatur"\
    --form "file=@/tmp/phpXoNB6j" 

const url = new URL(
    "http://core.localhost/api/v1/send/event/invitation/by/import"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('event_id', 'consequatur');
body.append('file', document.querySelector('input[name="file"]').files[0]);

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

Request    Try it out ⚡   

POST api/v1/send/event/invitation/by/import

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

file   file   

Must be a file. Must not be greater than 10240 kilobytes. Example: /tmp/phpXoNB6j

event_id   string   

The id of an existing record in the events table. Example: consequatur

GET api/v1/event/invitation/{event}/datatable

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/event/invitation/consequatur/datatable" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/event/invitation/consequatur/datatable"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/event/invitation/{event}/datatable

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event   string   

Example: consequatur

POST api/v1/resend/event/invitation/{id}

Example request:

curl --request POST \
    "http://core.localhost/api/v1/resend/event/invitation/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/resend/event/invitation/consequatur"
);

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

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

Request    Try it out ⚡   

POST api/v1/resend/event/invitation/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the invitation. Example: consequatur

PATCH api/v1/update/event/{event}/weblink

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/event/consequatur/weblink" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/update/event/consequatur/weblink"
);

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

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

Request    Try it out ⚡   

PATCH api/v1/update/event/{event}/weblink

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event   string   

The event. Example: consequatur

GET api/v1/get/events/{event}/presence/stats

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/events/consequatur/presence/stats" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/events/consequatur/presence/stats"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/events/{event}/presence/stats

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event   string   

The event. Example: consequatur

POST api/v1/send/invitation/{eventInscription}/payment/reminder

Example request:

curl --request POST \
    "http://core.localhost/api/v1/send/invitation/consequatur/payment/reminder" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/send/invitation/consequatur/payment/reminder"
);

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

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

Request    Try it out ⚡   

POST api/v1/send/invitation/{eventInscription}/payment/reminder

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

eventInscription   string   

Example: consequatur

POST api/v1/import/event/{event_id}/participators

Example request:

curl --request POST \
    "http://core.localhost/api/v1/import/event/consequatur/participators" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/import/event/consequatur/participators"
);

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

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

Request    Try it out ⚡   

POST api/v1/import/event/{event_id}/participators

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event_id   string   

The ID of the event. Example: consequatur

GET api/v1/export/event/{event_id}/participators

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/export/event/consequatur/participators" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/export/event/consequatur/participators"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/export/event/{event_id}/participators

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event_id   string   

The ID of the event. Example: consequatur

GET api/v1/get/participators/{event}/moderator

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/participators/consequatur/moderator" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/participators/consequatur/moderator"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/participators/{event}/moderator

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event   string   

Example: consequatur

GET api/v1/get/participators/{event}/presentator

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/participators/consequatur/presentator" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/participators/consequatur/presentator"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/participators/{event}/presentator

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event   string   

Example: consequatur

GET api/v1/get/participantType/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/participantType/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/participantType/collection"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/participantType/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/event/form

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/event/form" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"event_id\": \"fa010f60-df29-3f05-8bc7-bed48f550d13\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/event/form"
);

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

let body = {
    "type": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "event_id": "fa010f60-df29-3f05-8bc7-bed48f550d13"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/event/form

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

type   string   

Must be a valid UUID. The id of an existing record in the participator_types table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

event_id   string   

Must be a valid UUID. The id of an existing record in the events table. Example: fa010f60-df29-3f05-8bc7-bed48f550d13

PATCH api/v1/update/{eventForm}/event/form

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/event/form" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\",
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"note\": \"consequatur\",
    \"event_form_id\": \"98adc52b-966d-39db-809a-55902ee7228f\",
    \"steps\": [
        {
            \"fields\": [
                {
                    \"label\": \"consequatur\",
                    \"type\": \"select\",
                    \"placeholder\": \"consequatur\",
                    \"help\": \"consequatur\",
                    \"required\": false,
                    \"repeatable\": true
                }
            ],
            \"name\": \"consequatur\",
            \"order\": 17,
            \"repeatable\": false
        }
    ],
    \"fields\": [
        {
            \"label\": \"consequatur\",
            \"type\": \"datetime\",
            \"placeholder\": \"consequatur\",
            \"help\": \"consequatur\",
            \"required\": true,
            \"repeatable\": false
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/event/form"
);

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

let body = {
    "name": "consequatur",
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "note": "consequatur",
    "event_form_id": "98adc52b-966d-39db-809a-55902ee7228f",
    "steps": [
        {
            "fields": [
                {
                    "label": "consequatur",
                    "type": "select",
                    "placeholder": "consequatur",
                    "help": "consequatur",
                    "required": false,
                    "repeatable": true
                }
            ],
            "name": "consequatur",
            "order": 17,
            "repeatable": false
        }
    ],
    "fields": [
        {
            "label": "consequatur",
            "type": "datetime",
            "placeholder": "consequatur",
            "help": "consequatur",
            "required": true,
            "repeatable": false
        }
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{eventForm}/event/form

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

eventForm   string   

Example: consequatur

Body Parameters

name   string   

Example: consequatur

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

steps   object[]  optional  

fields   object[]   

label   string   

Example: consequatur

type   string   

Example: select

Must be one of:

• text
• email
• number
• url
• date
• datetime
• select
• textarea
• select_multiple
• radio
• checkbox

placeholder   string  optional  

Example: consequatur

help   string  optional  

Example: consequatur

required   boolean    true false

Example: false

repeatable   boolean  optional   true false

Example: true

options   object  optional  

name   string   

Example: consequatur

description   string  optional  

order   integer   

Example: 17

repeatable   boolean  optional   true false

Example: false

fields   object[]  optional  

options   object  optional  

label   string   

Example: consequatur

type   string   

Example: datetime

Must be one of:

• text
• email
• number
• url
• date
• datetime
• select
• textarea
• select_multiple
• radio
• checkbox

placeholder   string  optional  

Example: consequatur

help   string  optional  

Example: consequatur

required   boolean    true false

Example: true

repeatable   boolean  optional   true false

Example: false

note   string  optional  

Example: consequatur

event_form_id   string   

Must be a valid UUID. The id of an existing record in the event_forms table. Example: 98adc52b-966d-39db-809a-55902ee7228f

DELETE api/v1/delete/{eventForm}/event/form

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/event/form" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/event/form"
);

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

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

Request    Try it out ⚡   

DELETE api/v1/delete/{eventForm}/event/form

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

eventForm   string   

Example: consequatur

GET api/v1/get/{event}/event/forms

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/event/forms" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/event/forms"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{event}/event/forms

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event   string   

Example: consequatur

GET api/v1/get/invitation/{eventInscription}

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/invitation/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/invitation/consequatur"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/invitation/{eventInscription}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

eventInscription   string   

Example: consequatur

GET api/v1/get/event/{event}/invitation/list

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/event/consequatur/invitation/list" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/event/consequatur/invitation/list"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/event/{event}/invitation/list

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event   string   

The event. Example: consequatur

GET api/v1/get/event/{event}/participators

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/event/consequatur/participators" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/event/consequatur/participators"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/event/{event}/participators

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event   string   

The event. Example: consequatur

PATCH api/v1/update/inscription/{eventInscription}/status

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/inscription/consequatur/status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/update/inscription/consequatur/status"
);

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

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

Request    Try it out ⚡   

PATCH api/v1/update/inscription/{eventInscription}/status

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

eventInscription   string   

Example: consequatur

GET api/v1/get/eventTemplate/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/eventTemplate/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/eventTemplate/collection"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/eventTemplate/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/{eventTemplate}/eventTemplate

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/eventTemplate" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/eventTemplate"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{eventTemplate}/eventTemplate

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

eventTemplate   string   

Example: consequatur

POST api/v1/store/eventTemplate

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/eventTemplate" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"EVENT_INSCRIPTION\",
    \"content\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/eventTemplate"
);

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

let body = {
    "type": "EVENT_INSCRIPTION",
    "content": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/eventTemplate

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

type   string   

Example: EVENT_INSCRIPTION

Must be one of:

• EVENT_INSCRIPTION
• EVENT_INSCRIPTION_SUCCESS
• EVENT_INSCRIPTION_REJECTED
• EVENT_INVITATION
• EVENT_INVITATION_PAYMENT_REMINDER
• PLATFORM_ACCES

content   string   

Example: consequatur

PATCH api/v1/update/{eventTemplate}/eventTemplate

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/eventTemplate" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"content\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/eventTemplate"
);

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

let body = {
    "content": "consequatur"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{eventTemplate}/eventTemplate

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

eventTemplate   string   

Example: consequatur

Body Parameters

content   string   

Example: consequatur

DELETE api/v1/delete/{eventTemplate}/eventTemplate

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/eventTemplate" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/eventTemplate"
);

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

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

Request    Try it out ⚡   

DELETE api/v1/delete/{eventTemplate}/eventTemplate

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

eventTemplate   string   

Example: consequatur

GET api/v1/get/{eventTemplate}/register/eventTemplate

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/register/eventTemplate" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/register/eventTemplate"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{eventTemplate}/register/eventTemplate

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

eventTemplate   string   

Example: consequatur

GET api/v1/get/{eventTemplate}/success/eventTemplate

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/success/eventTemplate" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/success/eventTemplate"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{eventTemplate}/success/eventTemplate

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

eventTemplate   string   

Example: consequatur

GET api/v1/get/{eventTemplate}/rejected/eventTemplate

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/rejected/eventTemplate" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/rejected/eventTemplate"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{eventTemplate}/rejected/eventTemplate

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

eventTemplate   string   

Example: consequatur

POST api/v1/store/stand

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/stand" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"number\": \"consequatur\",
    \"name\": \"mqeopfuudtdsufvyvddqa\",
    \"location\": \"mniihfqcoynlazghdtqtq\",
    \"1\": \"1966a04b-5bf2-32bc-a8b3-7835ce5688d2\",
    \"members\": [
        \"ba3a31ce-1e9f-3aa8-8b6f-424fe4033b3d\"
    ],
    \"event_id\": \"consequatur\",
    \"3\": \"98adc52b-966d-39db-809a-55902ee7228f\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/stand"
);

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

let body = {
    "number": "consequatur",
    "name": "mqeopfuudtdsufvyvddqa",
    "location": "mniihfqcoynlazghdtqtq",
    "1": "1966a04b-5bf2-32bc-a8b3-7835ce5688d2",
    "members": [
        "ba3a31ce-1e9f-3aa8-8b6f-424fe4033b3d"
    ],
    "event_id": "consequatur",
    "3": "98adc52b-966d-39db-809a-55902ee7228f"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/stand

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

number   string   

Example: consequatur

name   string   

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

location   string  optional  

Must not be greater than 5000 characters. Example: mniihfqcoynlazghdtqtq

participator_id   string  optional  

0   string  optional  

The id of an existing record in the events table.

1   string  optional  

Must be a valid UUID. Example: 1966a04b-5bf2-32bc-a8b3-7835ce5688d2

members   string[]  optional  

Must be a valid UUID. The id of an existing record in the participators table.

event_id   string   

Example: consequatur

2   string  optional  

The id of an existing record in the participators table.

3   string  optional  

Must be a valid UUID. Example: 98adc52b-966d-39db-809a-55902ee7228f

PUT api/v1/update/{stand_id}/stand

Example request:

curl --request PUT \
    "http://core.localhost/api/v1/update/consequatur/stand" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"number\": \"consequatur\",
    \"name\": \"mqeopfuudtdsufvyvddqa\",
    \"location\": \"mniihfqcoynlazghdtqtq\",
    \"1\": \"1966a04b-5bf2-32bc-a8b3-7835ce5688d2\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/stand"
);

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

let body = {
    "number": "consequatur",
    "name": "mqeopfuudtdsufvyvddqa",
    "location": "mniihfqcoynlazghdtqtq",
    "1": "1966a04b-5bf2-32bc-a8b3-7835ce5688d2"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PUT api/v1/update/{stand_id}/stand

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

stand_id   string   

The ID of the stand. Example: consequatur

Body Parameters

number   string   

Example: consequatur

name   string   

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

location   string  optional  

Must not be greater than 5000 characters. Example: mniihfqcoynlazghdtqtq

participator_id   string  optional  

0   string  optional  

The id of an existing record in the participators table.

1   string  optional  

Must be a valid UUID. Example: 1966a04b-5bf2-32bc-a8b3-7835ce5688d2

DELETE api/v1/delete/{stand_id}/stand

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/stand" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/stand"
);

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

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

Request    Try it out ⚡   

DELETE api/v1/delete/{stand_id}/stand

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

stand_id   string   

The ID of the stand. Example: consequatur

GET api/v1/get/list/{event}/stand

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/list/consequatur/stand" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/list/consequatur/stand"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/list/{event}/stand

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event   string   

Example: consequatur

GET api/v1/get/detail/{stand}/stand

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/detail/consequatur/stand" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/detail/consequatur/stand"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/detail/{stand}/stand

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

stand   string   

Example: consequatur

GET api/v1/email/invitation/type/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/email/invitation/type/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/email/invitation/type/enum"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/email/invitation/type/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/event/email/template/type/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/event/email/template/type/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/event/email/template/type/enum"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/event/email/template/type/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/event/email/enum/values

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/event/email/enum/values" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/event/email/enum/values"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/event/email/enum/values

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/atelier/status/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/atelier/status/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/atelier/status/enum"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/atelier/status/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/atelier/type/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/atelier/type/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/atelier/type/enum"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/atelier/type/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/event/inscription/status/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/event/inscription/status/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/event/inscription/status/enum"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/event/inscription/status/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/event/participator/type/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/event/participator/type/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/event/participator/type/enum"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/event/participator/type/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/event/status/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/event/status/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/event/status/enum"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/event/status/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/event/program/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/event/program/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/event/program/enum"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/event/program/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/event/invitation/log/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/event/invitation/log/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/event/invitation/log/enum"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/event/invitation/log/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/event/invitation/type/log/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/event/invitation/type/log/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/event/invitation/type/log/enum"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/event/invitation/type/log/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

PATCH api/v1/send/events/{nps}/nps/invitations

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/send/events/consequatur/nps/invitations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/send/events/consequatur/nps/invitations"
);

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

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

Request    Try it out ⚡   

PATCH api/v1/send/events/{nps}/nps/invitations

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

nps   string   

Example: consequatur

GET api/v1/get/event/{event_id}/badge/template

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/event/consequatur/badge/template" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/event/consequatur/badge/template"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/event/{event_id}/badge/template

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event_id   string   

The ID of the event. Example: consequatur

GET api/v1/export/participators/list

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/export/participators/list" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/export/participators/list"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/export/participators/list

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/generate-badge-content/{eventId}

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/generate-badge-content/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"participator_ids\": [
        \"consequatur\"
    ],
    \"status_ids\": [
        \"98adc52b-966d-39db-809a-55902ee7228f\"
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/generate-badge-content/consequatur"
);

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

let body = {
    "participator_ids": [
        "consequatur"
    ],
    "status_ids": [
        "98adc52b-966d-39db-809a-55902ee7228f"
    ]
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/generate-badge-content/{eventId}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

eventId   string   

Example: consequatur

Body Parameters

participator_ids   string[]  optional  

The id of an existing record in the participators table.

status_ids   string[]  optional  

Must be a valid UUID. The id of an existing record in the event_statuses table.

GET api/v1/get/event/{response}/response

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/event/consequatur/response" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/event/consequatur/response"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/event/{response}/response

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

response   string   

Example: consequatur

GET api/v1/get/event/{nps}/nps/responses/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/event/consequatur/nps/responses/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/event/consequatur/nps/responses/collection"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/event/{nps}/nps/responses/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

nps   string   

Example: consequatur

POST api/v1/verify/event/nps/responses

Example request:

curl --request POST \
    "http://core.localhost/api/v1/verify/event/nps/responses" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"participator_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"nps_id\": \"fa010f60-df29-3f05-8bc7-bed48f550d13\"
}"

const url = new URL(
    "http://core.localhost/api/v1/verify/event/nps/responses"
);

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

let body = {
    "participator_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "nps_id": "fa010f60-df29-3f05-8bc7-bed48f550d13"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/verify/event/nps/responses

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

participator_id   string   

Must be a valid UUID. The id of an existing record in the participators table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

nps_id   string   

Must be a valid UUID. The id of an existing record in the nps table. Example: fa010f60-df29-3f05-8bc7-bed48f550d13

GET api/v1/get/event/{nps}/nps/statistics

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/event/consequatur/nps/statistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/event/consequatur/nps/statistics"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/event/{nps}/nps/statistics

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

nps   string   

Example: consequatur

GET api/v1/export/participators/template/excel

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/export/participators/template/excel" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/export/participators/template/excel"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/export/participators/template/excel

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/reasons

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/reasons" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/reasons"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/reasons

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/reason/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/reason/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/reason/datatables"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/reason/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/reason

Example request:

curl --request POST \
    "http://core.localhost/api/v1/reason" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"type\": [
        \"consequatur\"
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/reason"
);

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

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "type": [
        "consequatur"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/reason

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

type   string[]   

The id of an existing record in the expense_types table.

PATCH api/v1/reason/{reason}/update

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/reason/consequatur/update" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"type\": [
        \"consequatur\"
    ],
    \"id\": \"98adc52b-966d-39db-809a-55902ee7228f\"
}"

const url = new URL(
    "http://core.localhost/api/v1/reason/consequatur/update"
);

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

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "type": [
        "consequatur"
    ],
    "id": "98adc52b-966d-39db-809a-55902ee7228f"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/reason/{reason}/update

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

reason   string   

The reason. Example: consequatur

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

type   string[]   

The id of an existing record in the expense_types table.

id   string   

Must be a valid UUID. The id of an existing record in the expense_reasons table. Example: 98adc52b-966d-39db-809a-55902ee7228f

DELETE api/v1/reason/{reason}/delete

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/reason/consequatur/delete" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/reason/consequatur/delete"
);

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

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

Request    Try it out ⚡   

DELETE api/v1/reason/{reason}/delete

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

reason   string   

The reason. Example: consequatur

GET api/v1/types

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/types" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/types"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/types

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/expense/type/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/expense/type/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/expense/type/enum"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/expense/type/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/expense

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/expense" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"type_id\": \"462ee709-6d9f-345a-95e6-76f833111fb8\",
    \"office_id\": \"1915c795-5d1c-3def-965b-5abe034dd150\",
    \"fees\": [
        {
            \"reason_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
            \"amount\": 11613.31890586,
            \"date\": \"2025-06-12T12:56:30\",
            \"invoices\": [
                \"opfuudtdsufvyvddqamni\"
            ]
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/store/expense"
);

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

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "type_id": "462ee709-6d9f-345a-95e6-76f833111fb8",
    "office_id": "1915c795-5d1c-3def-965b-5abe034dd150",
    "fees": [
        {
            "reason_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
            "amount": 11613.31890586,
            "date": "2025-06-12T12:56:30",
            "invoices": [
                "opfuudtdsufvyvddqamni"
            ]
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/expense

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

type_id   string   

Must be a valid UUID. The id of an existing record in the expense_types table. Example: 462ee709-6d9f-345a-95e6-76f833111fb8

office_id   string  optional  

Must be a valid UUID. The id of an existing record in the offices table. Example: 1915c795-5d1c-3def-965b-5abe034dd150

fees   object[]   

reason_id   string   

Must be a valid UUID. The id of an existing record in the expense_reasons table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

amount   number   

Example: 11613.31890586

date   string   

Must be a valid date. Example: 2025-06-12T12:56:30

invoices   string[]  optional  

Must not be greater than 10240 characters.

PATCH api/v1/expense/{expense}/update

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/expense/consequatur/update" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"type_id\": \"consequatur\",
    \"feesToDelete\": [
        \"98adc52b-966d-39db-809a-55902ee7228f\"
    ],
    \"fees\": [
        {
            \"id\": \"d48a46b6-3a18-3763-951d-66b7fdb284ae\",
            \"reason_id\": \"5f74bcbe-0654-30c9-9013-151f9399e192\",
            \"amount\": 11613.31890586,
            \"date\": \"2025-06-12T12:56:30\",
            \"invoices\": [
                \"opfuudtdsufvyvddqamni\"
            ]
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/expense/consequatur/update"
);

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

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "type_id": "consequatur",
    "feesToDelete": [
        "98adc52b-966d-39db-809a-55902ee7228f"
    ],
    "fees": [
        {
            "id": "d48a46b6-3a18-3763-951d-66b7fdb284ae",
            "reason_id": "5f74bcbe-0654-30c9-9013-151f9399e192",
            "amount": 11613.31890586,
            "date": "2025-06-12T12:56:30",
            "invoices": [
                "opfuudtdsufvyvddqamni"
            ]
        }
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/expense/{expense}/update

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

expense   string   

The expense. Example: consequatur

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

type_id   string   

The id of an existing record in the expense_types table. Example: consequatur

office_id   string  optional  

The id of an existing record in the offices table.

feesToDelete   string[]  optional  

Must be a valid UUID. The id of an existing record in the expense_fees table.

fees   object[]  optional  

id   string  optional  

Must be a valid UUID. The id of an existing record in the expense_fees table. Example: d48a46b6-3a18-3763-951d-66b7fdb284ae

reason_id   string   

Must be a valid UUID. The id of an existing record in the expense_reasons table. Example: 5f74bcbe-0654-30c9-9013-151f9399e192

amount   number  optional  

Example: 11613.31890586

date   string  optional  

Must be a valid date. Example: 2025-06-12T12:56:30

invoices   string[]  optional  

Must not be greater than 10240 characters.

removes   object  optional  

GET api/v1/get/{expense}/expense

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/expense" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/expense"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{expense}/expense

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

expense   string   

Example: consequatur

DELETE api/v1/delete/expenses

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/expenses" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/expenses"
);

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

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

Request    Try it out ⚡   

DELETE api/v1/delete/expenses

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/expense/status/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/expense/status/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/expense/status/enum"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/expense/status/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/accounting/expenses/dashboard

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/accounting/expenses/dashboard" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/accounting/expenses/dashboard"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/accounting/expenses/dashboard

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/accounting/office/{office}/users/expenses/statistics

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/accounting/office/consequatur/users/expenses/statistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/accounting/office/consequatur/users/expenses/statistics"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/accounting/office/{office}/users/expenses/statistics

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

office   string   

The office. Example: consequatur

GET api/v1/accounting/users/expenses/scrolling

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/accounting/users/expenses/scrolling" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/accounting/users/expenses/scrolling"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/accounting/users/expenses/scrolling

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/accounting/users/expenses/statistics

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/accounting/users/expenses/statistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/accounting/users/expenses/statistics"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/accounting/users/expenses/statistics

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/accounting/offices/expenses/scrolling

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/accounting/offices/expenses/scrolling" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/accounting/offices/expenses/scrolling"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/accounting/offices/expenses/scrolling

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/accounting/offices/expenses/statistics

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/accounting/offices/expenses/statistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/accounting/offices/expenses/statistics"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/accounting/offices/expenses/statistics

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/expenses/not/approved

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/expenses/not/approved" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/expenses/not/approved"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/expenses/not/approved

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

PATCH api/v1/expense/{expense}/send

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/expense/consequatur/send" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/expense/consequatur/send"
);

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

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

Request    Try it out ⚡   

PATCH api/v1/expense/{expense}/send

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

expense   string   

The expense. Example: consequatur

PATCH api/v1/approve/expenses

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/approve/expenses" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/approve/expenses"
);

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

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

Request    Try it out ⚡   

PATCH api/v1/approve/expenses

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

PATCH api/v1/expense/{expense}/validate

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/expense/consequatur/validate" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/expense/consequatur/validate"
);

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

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

Request    Try it out ⚡   

PATCH api/v1/expense/{expense}/validate

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

expense   string   

The expense. Example: consequatur

PATCH api/v1/expense/{expense}/reject

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/expense/consequatur/reject" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/expense/consequatur/reject"
);

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

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

Request    Try it out ⚡   

PATCH api/v1/expense/{expense}/reject

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

expense   string   

The expense. Example: consequatur

POST api/v1/expense/pay

Example request:

curl --request POST \
    "http://core.localhost/api/v1/expense/pay" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"expense_id\": \"consequatur\",
    \"due_amount\": 11613.31890586,
    \"deposits\": [
        {
            \"type\": \"account\",
            \"id\": \"consequatur\",
            \"amount\": 11613.31890586
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/expense/pay"
);

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

let body = {
    "expense_id": "consequatur",
    "due_amount": 11613.31890586,
    "deposits": [
        {
            "type": "account",
            "id": "consequatur",
            "amount": 11613.31890586
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/expense/pay

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

expense_id   string   

The id of an existing record in the expenses table. Example: consequatur

due_amount   number  optional  

Example: 11613.31890586

deposits   object[]   

type   string   

Example: account

Must be one of:

• account
• box

id   string   

Example: consequatur

amount   number   

Example: 11613.31890586

rate   string  optional  

POST api/v1/accounting/expense/download/request

Example request:

curl --request POST \
    "http://core.localhost/api/v1/accounting/expense/download/request" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/accounting/expense/download/request"
);

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

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

Request    Try it out ⚡   

POST api/v1/accounting/expense/download/request

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/expenses/users/scrolling

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/expenses/users/scrolling" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/expenses/users/scrolling"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/expenses/users/scrolling

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/expenses/users/statistics

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/expenses/users/statistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/expenses/users/statistics"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/expenses/users/statistics

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/{office}/expense/recurrent

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/consequatur/expense/recurrent" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"end_date\": \"2096-01-13\",
    \"start_date\": \"2025-06-12T12:56:30\",
    \"interval\": \"year\",
    \"frequency\": 45,
    \"fees\": [
        {
            \"reason_id\": \"consequatur\",
            \"amount\": \"consequatur\"
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/store/consequatur/expense/recurrent"
);

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

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "end_date": "2096-01-13",
    "start_date": "2025-06-12T12:56:30",
    "interval": "year",
    "frequency": 45,
    "fees": [
        {
            "reason_id": "consequatur",
            "amount": "consequatur"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/{office}/expense/recurrent

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

office   string   

Example: consequatur

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

end_date   string  optional  

Must be a valid date. Must be a valid date in the format d-m-Y. Must be a date after or equal to date_start. Example: 2096-01-13

start_date   string   

Must be a valid date. Example: 2025-06-12T12:56:30

interval   string   

Example: year

Must be one of:

• day
• week
• month
• year

frequency   integer   

Must be at least 1. Example: 45

fees   object[]   

reason_id   string   

The id of an existing record in the expense_reasons table. Example: consequatur

amount   string   

Example: consequatur

invoices   string[]  optional  

GET api/v1/get/{recurrence}/expense/recurrent

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/expense/recurrent" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/expense/recurrent"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{recurrence}/expense/recurrent

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

recurrence   string   

Example: consequatur

GET api/v1/get/{office}/expense/recurrentDataTable

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/expense/recurrentDataTable" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/expense/recurrentDataTable"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{office}/expense/recurrentDataTable

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

office   string   

Example: consequatur

PATCH api/v1/update/{recurrence}/expense/recurrent

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/expense/recurrent" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"end_date\": \"2096-01-13\",
    \"start_date\": \"12-06-2025\",
    \"interval\": \"month\",
    \"frequency\": 45,
    \"fees\": [
        {
            \"reason_id\": \"consequatur\",
            \"amount\": \"consequatur\"
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/expense/recurrent"
);

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

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "end_date": "2096-01-13",
    "start_date": "12-06-2025",
    "interval": "month",
    "frequency": 45,
    "fees": [
        {
            "reason_id": "consequatur",
            "amount": "consequatur"
        }
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{recurrence}/expense/recurrent

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

recurrence   string   

Example: consequatur

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

end_date   string  optional  

Must be a valid date. Must be a valid date in the format d-m-Y. Must be a date after or equal to date_start. Example: 2096-01-13

start_date   string   

Must be a valid date. Must be a valid date in the format d-m-Y. Example: 12-06-2025

interval   string   

Example: month

Must be one of:

• day
• week
• month
• year

frequency   integer   

Must be at least 1. Example: 45

fees   object[]   

reason_id   string   

The id of an existing record in the expense_reasons table. Example: consequatur

amount   string   

Example: consequatur

PATCH api/v1/disable/{recurrence}/expense/recurrent

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/disable/consequatur/expense/recurrent" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/disable/consequatur/expense/recurrent"
);

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

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

Request    Try it out ⚡   

PATCH api/v1/disable/{recurrence}/expense/recurrent

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

recurrence   string   

Example: consequatur

PATCH api/v1/active/{recurrence}/expense/recurrent

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/active/consequatur/expense/recurrent" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/active/consequatur/expense/recurrent"
);

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

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

Request    Try it out ⚡   

PATCH api/v1/active/{recurrence}/expense/recurrent

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

recurrence   string   

Example: consequatur

Initialize file manager

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/file-manager/initialize" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/file-manager/initialize"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/file-manager/initialize

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Get files and directories for the selected path and disk

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/file-manager/content" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"disk\": \"consequatur\",
    \"path\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/file-manager/content"
);

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

let body = {
    "disk": "consequatur",
    "path": "consequatur"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/file-manager/content

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

disk   string  optional  

Example: consequatur

path   string  optional  

Example: consequatur

Directory tree

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/file-manager/tree" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"disk\": \"consequatur\",
    \"path\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/file-manager/tree"
);

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

let body = {
    "disk": "consequatur",
    "path": "consequatur"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/file-manager/tree

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

disk   string  optional  

Example: consequatur

path   string  optional  

Example: consequatur

Check the selected disk

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/file-manager/select-disk" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"disk\": \"consequatur\",
    \"path\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/file-manager/select-disk"
);

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

let body = {
    "disk": "consequatur",
    "path": "consequatur"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/file-manager/select-disk

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

disk   string  optional  

Example: consequatur

path   string  optional  

Example: consequatur

Upload files

Example request:

curl --request POST \
    "http://core.localhost/api/v1/file-manager/upload" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"disk\": \"consequatur\",
    \"path\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/file-manager/upload"
);

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

let body = {
    "disk": "consequatur",
    "path": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/file-manager/upload

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

disk   string  optional  

Example: consequatur

path   string  optional  

Example: consequatur

Delete files and folders

Example request:

curl --request POST \
    "http://core.localhost/api/v1/file-manager/delete" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"disk\": \"consequatur\",
    \"path\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/file-manager/delete"
);

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

let body = {
    "disk": "consequatur",
    "path": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/file-manager/delete

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

disk   string  optional  

Example: consequatur

path   string  optional  

Example: consequatur

Copy / Cut files and folders

Example request:

curl --request POST \
    "http://core.localhost/api/v1/file-manager/paste" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"disk\": \"consequatur\",
    \"path\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/file-manager/paste"
);

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

let body = {
    "disk": "consequatur",
    "path": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/file-manager/paste

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

disk   string  optional  

Example: consequatur

path   string  optional  

Example: consequatur

Rename

Example request:

curl --request POST \
    "http://core.localhost/api/v1/file-manager/rename" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"disk\": \"consequatur\",
    \"path\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/file-manager/rename"
);

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

let body = {
    "disk": "consequatur",
    "path": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/file-manager/rename

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

disk   string  optional  

Example: consequatur

path   string  optional  

Example: consequatur

Download file

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/file-manager/download" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"disk\": \"consequatur\",
    \"path\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/file-manager/download"
);

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

let body = {
    "disk": "consequatur",
    "path": "consequatur"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/file-manager/download

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

disk   string  optional  

Example: consequatur

path   string  optional  

Example: consequatur

Create thumbnails

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/file-manager/thumbnails" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"disk\": \"consequatur\",
    \"path\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/file-manager/thumbnails"
);

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

let body = {
    "disk": "consequatur",
    "path": "consequatur"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/file-manager/thumbnails

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

disk   string  optional  

Example: consequatur

path   string  optional  

Example: consequatur

Image preview

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/file-manager/preview" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"disk\": \"consequatur\",
    \"path\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/file-manager/preview"
);

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

let body = {
    "disk": "consequatur",
    "path": "consequatur"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/file-manager/preview

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

disk   string  optional  

Example: consequatur

path   string  optional  

Example: consequatur

File url

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/file-manager/url" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"disk\": \"consequatur\",
    \"path\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/file-manager/url"
);

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

let body = {
    "disk": "consequatur",
    "path": "consequatur"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/file-manager/url

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

disk   string  optional  

Example: consequatur

path   string  optional  

Example: consequatur

Create new directory

Example request:

curl --request POST \
    "http://core.localhost/api/v1/file-manager/create-directory" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"disk\": \"consequatur\",
    \"path\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/file-manager/create-directory"
);

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

let body = {
    "disk": "consequatur",
    "path": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/file-manager/create-directory

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

disk   string  optional  

Example: consequatur

path   string  optional  

Example: consequatur

Create new file

Example request:

curl --request POST \
    "http://core.localhost/api/v1/file-manager/create-file" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"disk\": \"consequatur\",
    \"path\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/file-manager/create-file"
);

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

let body = {
    "disk": "consequatur",
    "path": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/file-manager/create-file

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

disk   string  optional  

Example: consequatur

path   string  optional  

Example: consequatur

Update file

Example request:

curl --request POST \
    "http://core.localhost/api/v1/file-manager/update-file" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"disk\": \"consequatur\",
    \"path\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/file-manager/update-file"
);

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

let body = {
    "disk": "consequatur",
    "path": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/file-manager/update-file

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

disk   string  optional  

Example: consequatur

path   string  optional  

Example: consequatur

Stream file

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/file-manager/stream-file" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"disk\": \"consequatur\",
    \"path\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/file-manager/stream-file"
);

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

let body = {
    "disk": "consequatur",
    "path": "consequatur"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/file-manager/stream-file

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

disk   string  optional  

Example: consequatur

path   string  optional  

Example: consequatur

Create zip archive

Example request:

curl --request POST \
    "http://core.localhost/api/v1/file-manager/zip" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"disk\": \"consequatur\",
    \"path\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/file-manager/zip"
);

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

let body = {
    "disk": "consequatur",
    "path": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/file-manager/zip

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

disk   string  optional  

Example: consequatur

path   string  optional  

Example: consequatur

Extract zip archive

Example request:

curl --request POST \
    "http://core.localhost/api/v1/file-manager/unzip" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"disk\": \"consequatur\",
    \"path\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/file-manager/unzip"
);

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

let body = {
    "disk": "consequatur",
    "path": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/file-manager/unzip

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

disk   string  optional  

Example: consequatur

path   string  optional  

Example: consequatur

Integration with ckeditor 4

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/file-manager/ckeditor" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/file-manager/ckeditor"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/file-manager/ckeditor

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Integration with TinyMCE v4

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/file-manager/tinymce" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/file-manager/tinymce"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/file-manager/tinymce

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Integration with TinyMCE v5

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/file-manager/tinymce5" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/file-manager/tinymce5"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/file-manager/tinymce5

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Integration with SummerNote

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/file-manager/summernote" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/file-manager/summernote"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/file-manager/summernote

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Simple integration with input field

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/file-manager/fm-button" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/file-manager/fm-button"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/file-manager/fm-button

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/form

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/form" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\",
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"steps\": [
        {
            \"fields\": [
                {
                    \"label\": \"consequatur\",
                    \"type\": \"text\",
                    \"placeholder\": \"consequatur\",
                    \"help\": \"consequatur\",
                    \"required\": true,
                    \"repeatable\": true
                }
            ],
            \"name\": \"consequatur\",
            \"order\": 17,
            \"repeatable\": true
        }
    ],
    \"fields\": [
        {
            \"label\": \"consequatur\",
            \"type\": \"date\",
            \"placeholder\": \"consequatur\",
            \"help\": \"consequatur\",
            \"required\": false,
            \"repeatable\": false
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/store/form"
);

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

let body = {
    "name": "consequatur",
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "steps": [
        {
            "fields": [
                {
                    "label": "consequatur",
                    "type": "text",
                    "placeholder": "consequatur",
                    "help": "consequatur",
                    "required": true,
                    "repeatable": true
                }
            ],
            "name": "consequatur",
            "order": 17,
            "repeatable": true
        }
    ],
    "fields": [
        {
            "label": "consequatur",
            "type": "date",
            "placeholder": "consequatur",
            "help": "consequatur",
            "required": false,
            "repeatable": false
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/form

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Example: consequatur

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

steps   object[]  optional  

fields   object[]   

label   string   

Example: consequatur

type   string   

Example: text

Must be one of:

• text
• email
• number
• url
• date
• datetime
• select
• textarea
• select_multiple
• radio
• checkbox

placeholder   string  optional  

Example: consequatur

help   string  optional  

Example: consequatur

required   boolean    true false

Example: true

repeatable   boolean  optional   true false

Example: true

options   object  optional  

name   string   

Example: consequatur

description   string  optional  

order   integer   

Example: 17

repeatable   boolean  optional   true false

Example: true

fields   object[]  optional  

options   object  optional  

label   string   

Example: consequatur

type   string   

Example: date

Must be one of:

• text
• email
• number
• url
• date
• datetime
• select
• textarea
• select_multiple
• radio
• checkbox

placeholder   string  optional  

Example: consequatur

help   string  optional  

Example: consequatur

required   boolean    true false

Example: false

repeatable   boolean  optional   true false

Example: false

PATCH api/v1/update/{form_id}/form

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/form" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\",
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"steps\": [
        {
            \"fields\": [
                {
                    \"label\": \"consequatur\",
                    \"type\": \"select_multiple\",
                    \"placeholder\": \"consequatur\",
                    \"help\": \"consequatur\",
                    \"required\": true,
                    \"repeatable\": true
                }
            ],
            \"name\": \"consequatur\",
            \"order\": 17,
            \"repeatable\": false
        }
    ],
    \"fields\": [
        {
            \"label\": \"consequatur\",
            \"type\": \"text\",
            \"placeholder\": \"consequatur\",
            \"help\": \"consequatur\",
            \"required\": false,
            \"repeatable\": true
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/form"
);

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

let body = {
    "name": "consequatur",
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "steps": [
        {
            "fields": [
                {
                    "label": "consequatur",
                    "type": "select_multiple",
                    "placeholder": "consequatur",
                    "help": "consequatur",
                    "required": true,
                    "repeatable": true
                }
            ],
            "name": "consequatur",
            "order": 17,
            "repeatable": false
        }
    ],
    "fields": [
        {
            "label": "consequatur",
            "type": "text",
            "placeholder": "consequatur",
            "help": "consequatur",
            "required": false,
            "repeatable": true
        }
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{form_id}/form

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

form_id   string   

The ID of the form. Example: consequatur

Body Parameters

name   string   

Example: consequatur

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

steps   object[]  optional  

fields   object[]   

label   string   

Example: consequatur

type   string   

Example: select_multiple

Must be one of:

• text
• email
• number
• url
• date
• datetime
• select
• textarea
• select_multiple
• radio
• checkbox

placeholder   string  optional  

Example: consequatur

help   string  optional  

Example: consequatur

required   boolean    true false

Example: true

repeatable   boolean  optional   true false

Example: true

options   object  optional  

name   string   

Example: consequatur

description   string  optional  

order   integer   

Example: 17

repeatable   boolean  optional   true false

Example: false

fields   object[]  optional  

options   object  optional  

label   string   

Example: consequatur

type   string   

Example: text

Must be one of:

• text
• email
• number
• url
• date
• datetime
• select
• textarea
• select_multiple
• radio
• checkbox

placeholder   string  optional  

Example: consequatur

help   string  optional  

Example: consequatur

required   boolean    true false

Example: false

repeatable   boolean  optional   true false

Example: true

DELETE api/v1/delete/{form_id}/form

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/form" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/form"
);

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

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

Request    Try it out ⚡   

DELETE api/v1/delete/{form_id}/form

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

form_id   string   

The ID of the form. Example: consequatur

GET api/v1/enum/field/types

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/enum/field/types" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/enum/field/types"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/enum/field/types

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/datatable/holiday_type

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/datatable/holiday_type" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/datatable/holiday_type"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/datatable/holiday_type

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/{holiday_type}/holiday_type

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/holiday_type" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/holiday_type"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{holiday_type}/holiday_type

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

holiday_type   string   

Example: consequatur

POST api/v1/store/holiday_type

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/holiday_type" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/holiday_type"
);

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

let body = {
    "name": "vmqeopfuudtdsufvyvddq"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/holiday_type

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

PUT api/v1/update/{holiday_type}/holiday_type

Example request:

curl --request PUT \
    "http://core.localhost/api/v1/update/consequatur/holiday_type" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"id\": \"462ee709-6d9f-345a-95e6-76f833111fb8\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/holiday_type"
);

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

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "id": "462ee709-6d9f-345a-95e6-76f833111fb8"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PUT api/v1/update/{holiday_type}/holiday_type

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

holiday_type   string   

Example: consequatur

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

id   string   

Must be a valid UUID. The id of an existing record in the holiday_types table. Example: 462ee709-6d9f-345a-95e6-76f833111fb8

DELETE api/v1/delete/{holiday_type}/holiday_type

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/holiday_type" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/holiday_type"
);

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

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

Request    Try it out ⚡   

DELETE api/v1/delete/{holiday_type}/holiday_type

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

holiday_type   string   

Example: consequatur

GET api/v1/get/holiday_types/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/holiday_types/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/holiday_types/collection"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/holiday_types/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/holiday_types

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/holiday_types" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/holiday_types"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/holiday_types

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/country/{society}/holiday_types

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/country/consequatur/holiday_types" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/country/consequatur/holiday_types"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/country/{society}/holiday_types

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

society   string   

Example: consequatur

GET api/v1/{office}/holiday_types

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/consequatur/holiday_types" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/consequatur/holiday_types"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/{office}/holiday_types

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

office   string   

Example: consequatur

GET api/v1/holiday_types/{society}/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/holiday_types/consequatur/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/holiday_types/consequatur/datatables"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/holiday_types/{society}/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

society   string   

Example: consequatur

GET api/v1/get/{holiday_type}/holiday_types/{country}/show

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/holiday_types/consequatur/show" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/holiday_types/consequatur/show"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{holiday_type}/holiday_types/{country}/show

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

holiday_type   string   

Example: consequatur

country   string   

Example: consequatur

GET api/v1/{holidayType}/holiday_types/show

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/consequatur/holiday_types/show" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/consequatur/holiday_types/show"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/{holidayType}/holiday_types/show

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

holidayType   string   

Example: consequatur

POST api/v1/holiday_type/{society}/management

Example request:

curl --request POST \
    "http://core.localhost/api/v1/holiday_type/consequatur/management" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"holiday_type_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"paid\": false,
    \"attachment\": true,
    \"include_day_off\": true,
    \"stock\": 11613.31890586,
    \"seniority\": true,
    \"min_seniority\": 17,
    \"type_under_stock\": \"mqeopfuudtdsufvyv\",
    \"description\": \"Fugit facilis perferendis dolores molestias.\",
    \"color\": \"consequatur\",
    \"periode\": \"mqeopfuudtdsufvyv\",
    \"reinitialable\": true,
    \"allow_previous_date\": false,
    \"take_all_without_count\": true,
    \"cummulable\": \"ddqamniihfqcoynla\",
    \"cummulabe_periode\": \"zghdtqtqxbajwbpil\",
    \"stock_periode\": \"pmufinllwloauydls\",
    \"have_stock\": true,
    \"society_id\": \"14ba6ba2-20f5-3f41-8d80-00bc536b7e3a\"
}"

const url = new URL(
    "http://core.localhost/api/v1/holiday_type/consequatur/management"
);

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

let body = {
    "holiday_type_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "paid": false,
    "attachment": true,
    "include_day_off": true,
    "stock": 11613.31890586,
    "seniority": true,
    "min_seniority": 17,
    "type_under_stock": "mqeopfuudtdsufvyv",
    "description": "Fugit facilis perferendis dolores molestias.",
    "color": "consequatur",
    "periode": "mqeopfuudtdsufvyv",
    "reinitialable": true,
    "allow_previous_date": false,
    "take_all_without_count": true,
    "cummulable": "ddqamniihfqcoynla",
    "cummulabe_periode": "zghdtqtqxbajwbpil",
    "stock_periode": "pmufinllwloauydls",
    "have_stock": true,
    "society_id": "14ba6ba2-20f5-3f41-8d80-00bc536b7e3a"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/holiday_type/{society}/management

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

society   string   

Example: consequatur

Body Parameters

holiday_type_id   string   

Must be a valid UUID. The id of an existing record in the holiday_types table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

paid   boolean  optional   true false

Example: false

attachment   boolean  optional   true false

Example: true

include_day_off   boolean  optional   true false

Example: true

stock   number  optional  

Example: 11613.31890586

seniority   boolean  optional   true false

Example: true

min_seniority   integer  optional  

Example: 17

type_under_stock   string  optional  

Must not be greater than 20 characters. Example: mqeopfuudtdsufvyv

description   string  optional  

Must not be greater than 255 characters. Example: Fugit facilis perferendis dolores molestias.

color   string  optional  

Example: consequatur

periode   string  optional  

Must not be greater than 20 characters. Example: mqeopfuudtdsufvyv

reinitialable   boolean  optional   true false

Example: true

allow_previous_date   boolean  optional   true false

Example: false

take_all_without_count   boolean  optional   true false

Example: true

cummulable   string  optional  

Must not be greater than 20 characters. Example: ddqamniihfqcoynla

cummulabe_periode   string  optional  

Must not be greater than 20 characters. Example: zghdtqtqxbajwbpil

stock_periode   string  optional  

Must not be greater than 20 characters. Example: pmufinllwloauydls

have_stock   boolean  optional   true false

Example: true

society_id   string   

Must be a valid UUID. The id of an existing record in the societies table. Example: 14ba6ba2-20f5-3f41-8d80-00bc536b7e3a

GET api/v1/holiday_type/stocks

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/holiday_type/stocks" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/holiday_type/stocks"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/holiday_type/stocks

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/holiday_type/under/stocks

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/holiday_type/under/stocks" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/holiday_type/under/stocks"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/holiday_type/under/stocks

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/office/{society}/public/holiday/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/office/consequatur/public/holiday/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/office/consequatur/public/holiday/datatables"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/office/{society}/public/holiday/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

society   string   

Example: consequatur

GET api/v1/get/office/{society}/workdays

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/office/consequatur/workdays" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/office/consequatur/workdays"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/office/{society}/workdays

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

society   string   

Example: consequatur

GET api/v1/get/public_holiday/{country_id}/country

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/public_holiday/47e8259a-24a8-4baa-854c-4f296e1c0a29/country" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/public_holiday/47e8259a-24a8-4baa-854c-4f296e1c0a29/country"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/public_holiday/{country_id}/country

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

country_id   string   

The ID of the country. Example: 47e8259a-24a8-4baa-854c-4f296e1c0a29

GET api/v1/get/{public_holiday}/public_holiday

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/public_holiday" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/public_holiday"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{public_holiday}/public_holiday

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_holiday   string   

Example: consequatur

POST api/v1/store/public_holiday

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/public_holiday" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"interval\": false,
    \"constant\": false,
    \"start_date\": \"2019-10-08\",
    \"end_date\": \"2106-07-12\",
    \"country_id\": \"consequatur\",
    \"description\": \"Dolorum amet iste laborum eius est dolor.\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/public_holiday"
);

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

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "interval": false,
    "constant": false,
    "start_date": "2019-10-08",
    "end_date": "2106-07-12",
    "country_id": "consequatur",
    "description": "Dolorum amet iste laborum eius est dolor."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/public_holiday

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

interval   boolean    true false

Example: false

constant   boolean    true false

Example: false

start_date   string   

Must be a valid date. Must be a date before or equal to end_date. Example: 2019-10-08

end_date   string  optional  

Must be a valid date. Must be a date after or equal to start_date. Example: 2106-07-12

country_id   string   

The id of an existing record in the countries table. Example: consequatur

description   string   

Must not be greater than 255 characters. Example: Dolorum amet iste laborum eius est dolor.

PUT api/v1/update/{public_holiday}/public_holiday

Example request:

curl --request PUT \
    "http://core.localhost/api/v1/update/consequatur/public_holiday" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"interval\": true,
    \"constant\": true,
    \"start_date\": \"2019-10-08\",
    \"end_date\": \"2106-07-12\",
    \"country_id\": \"consequatur\",
    \"description\": \"Dolorum amet iste laborum eius est dolor.\",
    \"id\": \"fefb079f-5b81-3552-831f-ed3f89669781\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/public_holiday"
);

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

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "interval": true,
    "constant": true,
    "start_date": "2019-10-08",
    "end_date": "2106-07-12",
    "country_id": "consequatur",
    "description": "Dolorum amet iste laborum eius est dolor.",
    "id": "fefb079f-5b81-3552-831f-ed3f89669781"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PUT api/v1/update/{public_holiday}/public_holiday

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_holiday   string   

Example: consequatur

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

interval   boolean    true false

Example: true

constant   boolean    true false

Example: true

start_date   string   

Must be a valid date. Must be a date before or equal to end_date. Example: 2019-10-08

end_date   string  optional  

Must be a valid date. Must be a date after or equal to start_date. Example: 2106-07-12

country_id   string   

The id of an existing record in the countries table. Example: consequatur

description   string   

Must not be greater than 255 characters. Example: Dolorum amet iste laborum eius est dolor.

id   string   

Must be a valid UUID. The id of an existing record in the public_holidays table. Example: fefb079f-5b81-3552-831f-ed3f89669781

DELETE api/v1/delete/{public_holiday}/public_holiday

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/public_holiday" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/public_holiday"
);

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

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

Request    Try it out ⚡   

DELETE api/v1/delete/{public_holiday}/public_holiday

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

public_holiday   string   

Example: consequatur

GET api/v1/weekdays

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/weekdays" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/weekdays"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/weekdays

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

PATCH api/v1/holiday_types/{holiday_types}/update

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/holiday_types/consequatur/update" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"id\": \"462ee709-6d9f-345a-95e6-76f833111fb8\"
}"

const url = new URL(
    "http://core.localhost/api/v1/holiday_types/consequatur/update"
);

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

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "id": "462ee709-6d9f-345a-95e6-76f833111fb8"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/holiday_types/{holiday_types}/update

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

holiday_types   string   

Example: consequatur

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

id   string   

Must be a valid UUID. The id of an existing record in the holiday_types table. Example: 462ee709-6d9f-345a-95e6-76f833111fb8

DELETE api/v1/holiday_types/{holiday_types}/delete

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/holiday_types/consequatur/delete" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/holiday_types/consequatur/delete"
);

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

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

Request    Try it out ⚡   

DELETE api/v1/holiday_types/{holiday_types}/delete

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

holiday_types   string   

Example: consequatur

POST api/v1/holiday_type/managment

Example request:

curl --request POST \
    "http://core.localhost/api/v1/holiday_type/managment" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"holiday_type_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"paid\": true,
    \"attachment\": false,
    \"include_day_off\": false,
    \"stock\": 11613.31890586,
    \"seniority\": false,
    \"min_seniority\": 17,
    \"type_under_stock\": \"mqeopfuudtdsufvyv\",
    \"description\": \"Fugit facilis perferendis dolores molestias.\",
    \"color\": \"consequatur\",
    \"periode\": \"mqeopfuudtdsufvyv\",
    \"reinitialable\": false,
    \"allow_previous_date\": false,
    \"take_all_without_count\": false,
    \"cummulable\": \"ddqamniihfqcoynla\",
    \"cummulabe_periode\": \"zghdtqtqxbajwbpil\",
    \"stock_periode\": \"pmufinllwloauydls\",
    \"have_stock\": true,
    \"society_id\": \"14ba6ba2-20f5-3f41-8d80-00bc536b7e3a\"
}"

const url = new URL(
    "http://core.localhost/api/v1/holiday_type/managment"
);

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

let body = {
    "holiday_type_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "paid": true,
    "attachment": false,
    "include_day_off": false,
    "stock": 11613.31890586,
    "seniority": false,
    "min_seniority": 17,
    "type_under_stock": "mqeopfuudtdsufvyv",
    "description": "Fugit facilis perferendis dolores molestias.",
    "color": "consequatur",
    "periode": "mqeopfuudtdsufvyv",
    "reinitialable": false,
    "allow_previous_date": false,
    "take_all_without_count": false,
    "cummulable": "ddqamniihfqcoynla",
    "cummulabe_periode": "zghdtqtqxbajwbpil",
    "stock_periode": "pmufinllwloauydls",
    "have_stock": true,
    "society_id": "14ba6ba2-20f5-3f41-8d80-00bc536b7e3a"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/holiday_type/managment

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

holiday_type_id   string   

Must be a valid UUID. The id of an existing record in the holiday_types table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

paid   boolean  optional   true false

Example: true

attachment   boolean  optional   true false

Example: false

include_day_off   boolean  optional   true false

Example: false

stock   number  optional  

Example: 11613.31890586

seniority   boolean  optional   true false

Example: false

min_seniority   integer  optional  

Example: 17

type_under_stock   string  optional  

Must not be greater than 20 characters. Example: mqeopfuudtdsufvyv

description   string  optional  

Must not be greater than 255 characters. Example: Fugit facilis perferendis dolores molestias.

color   string  optional  

Example: consequatur

periode   string  optional  

Must not be greater than 20 characters. Example: mqeopfuudtdsufvyv

reinitialable   boolean  optional   true false

Example: false

allow_previous_date   boolean  optional   true false

Example: false

take_all_without_count   boolean  optional   true false

Example: false

cummulable   string  optional  

Must not be greater than 20 characters. Example: ddqamniihfqcoynla

cummulabe_periode   string  optional  

Must not be greater than 20 characters. Example: zghdtqtqxbajwbpil

stock_periode   string  optional  

Must not be greater than 20 characters. Example: pmufinllwloauydls

have_stock   boolean  optional   true false

Example: true

society_id   string   

Must be a valid UUID. The id of an existing record in the societies table. Example: 14ba6ba2-20f5-3f41-8d80-00bc536b7e3a

GET api/v1/get/holidays/requests

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/holidays/requests" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/holidays/requests"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/holidays/requests

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/holidays/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/holidays/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/holidays/datatables"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/holidays/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/approve/{holiday}/holiday

Example request:

curl --request POST \
    "http://core.localhost/api/v1/approve/consequatur/holiday" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/approve/consequatur/holiday"
);

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

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

Request    Try it out ⚡   

POST api/v1/approve/{holiday}/holiday

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

holiday   string   

Example: consequatur

POST api/v1/validate/{holiday}/holiday

Example request:

curl --request POST \
    "http://core.localhost/api/v1/validate/consequatur/holiday" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/validate/consequatur/holiday"
);

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

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

Request    Try it out ⚡   

POST api/v1/validate/{holiday}/holiday

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

holiday   string   

Example: consequatur

POST api/v1/reject/{holiday}/holiday

Example request:

curl --request POST \
    "http://core.localhost/api/v1/reject/consequatur/holiday" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/reject/consequatur/holiday"
);

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

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

Request    Try it out ⚡   

POST api/v1/reject/{holiday}/holiday

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

holiday   string   

Example: consequatur

POST api/v1/end/{holiday}/holiday

Example request:

curl --request POST \
    "http://core.localhost/api/v1/end/consequatur/holiday" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/end/consequatur/holiday"
);

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

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

Request    Try it out ⚡   

POST api/v1/end/{holiday}/holiday

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

holiday   string   

Example: consequatur

POST api/v1/archive/{holiday}/holiday

Example request:

curl --request POST \
    "http://core.localhost/api/v1/archive/consequatur/holiday" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/archive/consequatur/holiday"
);

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

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

Request    Try it out ⚡   

POST api/v1/archive/{holiday}/holiday

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

holiday   string   

Example: consequatur

GET api/v1/holidays/statistique

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/holidays/statistique" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/holidays/statistique"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/holidays/statistique

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/cancel/{holiday}/holiday/request

Example request:

curl --request POST \
    "http://core.localhost/api/v1/cancel/consequatur/holiday/request" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/cancel/consequatur/holiday/request"
);

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

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

Request    Try it out ⚡   

POST api/v1/cancel/{holiday}/holiday/request

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

holiday   string   

Example: consequatur

GET api/v1/get/office/{office}/users/holidays

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/office/consequatur/users/holidays" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/office/consequatur/users/holidays"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/office/{office}/users/holidays

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

office   string   

The office. Example: consequatur

GET api/v1/user/country/workdays

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/user/country/workdays" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/user/country/workdays"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/user/country/workdays

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/office/{society}/workdays

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/office/consequatur/workdays" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/store/office/consequatur/workdays"
);

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

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

Request    Try it out ⚡   

POST api/v1/store/office/{society}/workdays

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

society   string   

Example: consequatur

GET api/v1/user/holidays

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/user/holidays" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/user/holidays"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/user/holidays

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/manage/holidays/calendar

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/manage/holidays/calendar" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/manage/holidays/calendar"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/manage/holidays/calendar

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/office/users/holidays/validated

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/office/users/holidays/validated" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/office/users/holidays/validated"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/office/users/holidays/validated

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/office/users/holidays/validated/pdf

Example request:

curl --request POST \
    "http://core.localhost/api/v1/office/users/holidays/validated/pdf" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/office/users/holidays/validated/pdf"
);

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

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

Request    Try it out ⚡   

POST api/v1/office/users/holidays/validated/pdf

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/society/holiday/statistics

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/society/holiday/statistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/society/holiday/statistics"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/society/holiday/statistics

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/country/{country}/workdays

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/country/consequatur/workdays" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/country/consequatur/workdays"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/country/{country}/workdays

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

country   string   

The country. Example: consequatur

GET api/v1/user/public/holidays

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/user/public/holidays" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/user/public/holidays"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/user/public/holidays

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/holidays/user/statistique

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/holidays/user/statistique" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/holidays/user/statistique"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/holidays/user/statistique

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/holidays/user/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/holidays/user/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/holidays/user/datatables"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/holidays/user/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/holiday

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/holiday" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "dates[][start_date]=2019-10-08"\
    --form "dates[][end_date]=2106-07-12"\
    --form "dates[][nbrDay]=11613.31890586"\
    --form "holiday_type_id=66529e01-d113-3473-8d6f-9e11e09332ea"\
    --form "description=Dolores dolorum amet iste laborum eius est dolor."\
    --form "detach_files[]=fefb079f-5b81-3552-831f-ed3f89669781"\
    --form "files[]=@/tmp/phpP38CgH" 

const url = new URL(
    "http://core.localhost/api/v1/store/holiday"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('dates[][start_date]', '2019-10-08');
body.append('dates[][end_date]', '2106-07-12');
body.append('dates[][nbrDay]', '11613.31890586');
body.append('holiday_type_id', '66529e01-d113-3473-8d6f-9e11e09332ea');
body.append('description', 'Dolores dolorum amet iste laborum eius est dolor.');
body.append('detach_files[]', 'fefb079f-5b81-3552-831f-ed3f89669781');
body.append('files[]', document.querySelector('input[name="files[]"]').files[0]);

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

Request    Try it out ⚡   

POST api/v1/store/holiday

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

dates   object[]   

start_date   string   

Must be a valid date. Must be a date before or equal to dates.*.end_date. Example: 2019-10-08

end_date   string  optional  

Must be a valid date. Must be a date after or equal to dates.*.start_date. Example: 2106-07-12

nbrDay   number   

Example: 11613.31890586

holiday_type_id   string   

Must be a valid UUID. The id of an existing record in the holiday_types table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

files   file[]  optional  

Must be a file. Must not be greater than 10240 kilobytes.

detach_files   string[]  optional  

Must be a valid UUID. The id of an existing record in the holiday_files table.

POST api/v1/update/holiday/{holiday}

Example request:

curl --request POST \
    "http://core.localhost/api/v1/update/holiday/consequatur" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "dates[][start_date]=2019-10-08"\
    --form "dates[][end_date]=2106-07-12"\
    --form "dates[][nbrDay]=11613.31890586"\
    --form "holiday_type_id=66529e01-d113-3473-8d6f-9e11e09332ea"\
    --form "description=Dolores dolorum amet iste laborum eius est dolor."\
    --form "detach_files[]=fefb079f-5b81-3552-831f-ed3f89669781"\
    --form "files[]=@/tmp/php47EGw9" 

const url = new URL(
    "http://core.localhost/api/v1/update/holiday/consequatur"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('dates[][start_date]', '2019-10-08');
body.append('dates[][end_date]', '2106-07-12');
body.append('dates[][nbrDay]', '11613.31890586');
body.append('holiday_type_id', '66529e01-d113-3473-8d6f-9e11e09332ea');
body.append('description', 'Dolores dolorum amet iste laborum eius est dolor.');
body.append('detach_files[]', 'fefb079f-5b81-3552-831f-ed3f89669781');
body.append('files[]', document.querySelector('input[name="files[]"]').files[0]);

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

Request    Try it out ⚡   

POST api/v1/update/holiday/{holiday}

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

holiday   string   

The holiday. Example: consequatur

Body Parameters

dates   object[]   

start_date   string   

Must be a valid date. Must be a date before or equal to dates.*.end_date. Example: 2019-10-08

end_date   string  optional  

Must be a valid date. Must be a date after or equal to dates.*.start_date. Example: 2106-07-12

nbrDay   number   

Example: 11613.31890586

holiday_type_id   string   

Must be a valid UUID. The id of an existing record in the holiday_types table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

files   file[]  optional  

Must be a file. Must not be greater than 10240 kilobytes.

detach_files   string[]  optional  

Must be a valid UUID. The id of an existing record in the holiday_files table.

GET api/v1/show/{holiday}/holiday

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/show/consequatur/holiday" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/show/consequatur/holiday"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/show/{holiday}/holiday

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

holiday   string   

Example: consequatur

DELETE api/v1/delete/{holiday}/holiday

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/holiday" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/holiday"
);

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

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

Request    Try it out ⚡   

DELETE api/v1/delete/{holiday}/holiday

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

holiday   string   

Example: consequatur

GET api/v1/get/society/{society}/offices/holidays

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/society/consequatur/offices/holidays" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/society/consequatur/offices/holidays"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/society/{society}/offices/holidays

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

society   string   

The society. Example: consequatur

GET api/v1/holiday/status/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/holiday/status/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/holiday/status/enum"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/holiday/status/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/holiday/action/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/holiday/action/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/holiday/action/enum"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/holiday/action/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/holiday/type_stock/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/holiday/type_stock/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/holiday/type_stock/enum"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/holiday/type_stock/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/holiday/under_type_stock/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/holiday/under_type_stock/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/holiday/under_type_stock/enum"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/holiday/under_type_stock/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/weekday/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/weekday/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/weekday/enum"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/weekday/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/invoice

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/invoice" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"invoice_date\": \"2019-10-08\",
    \"due_date\": \"2106-07-12\",
    \"notes\": \"consequatur\",
    \"contact_id\": \"98adc52b-966d-39db-809a-55902ee7228f\",
    \"currency_id\": \"d48a46b6-3a18-3763-951d-66b7fdb284ae\",
    \"items\": [
        \"pfuudtdsufvyvddqamnii\"
    ],
    \"payment_condition_id\": \"consequatur\",
    \"payment_type_id\": \"consequatur\",
    \"invoice_status\": \"CANCELED\",
    \"opportunity_id\": \"consequatur\",
    \"payment_delay\": \"consequatur\",
    \"recurring_invoice_id\": \"98adc52b-966d-39db-809a-55902ee7228f\",
    \"recurring_date\": \"12-06-2025\",
    \"frequency\": \"day\",
    \"limit_by\": \"count\",
    \"limit_count\": 17,
    \"frequency_count\": 17,
    \"limit_date\": \"12-06-2025\",
    \"project_id\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/invoice"
);

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

let body = {
    "invoice_date": "2019-10-08",
    "due_date": "2106-07-12",
    "notes": "consequatur",
    "contact_id": "98adc52b-966d-39db-809a-55902ee7228f",
    "currency_id": "d48a46b6-3a18-3763-951d-66b7fdb284ae",
    "items": [
        "pfuudtdsufvyvddqamnii"
    ],
    "payment_condition_id": "consequatur",
    "payment_type_id": "consequatur",
    "invoice_status": "CANCELED",
    "opportunity_id": "consequatur",
    "payment_delay": "consequatur",
    "recurring_invoice_id": "98adc52b-966d-39db-809a-55902ee7228f",
    "recurring_date": "12-06-2025",
    "frequency": "day",
    "limit_by": "count",
    "limit_count": 17,
    "frequency_count": 17,
    "limit_date": "12-06-2025",
    "project_id": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/invoice

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

invoice_date   string   

Must be a valid date in the format d-m-Y. Must be a date before or equal to due_date. Example: 2019-10-08

due_date   string   

Must be a valid date in the format d-m-Y. Must be a date after or equal to invoice_date. Example: 2106-07-12

notes   string  optional  

Example: consequatur

contact_id   string   

Must be a valid UUID. The id of an existing record in the contacts table. Example: 98adc52b-966d-39db-809a-55902ee7228f

currency_id   string   

Must be a valid UUID. The id of an existing record in the currencies table. Example: d48a46b6-3a18-3763-951d-66b7fdb284ae

items   string[]   

Must not be greater than 255 characters.

product_id   string   

The id of an existing record in the product_sale_elements table. Example: consequatur

description   string  optional  

quantity   number   

Example: 11613.31890586

price   number   

Example: 11613.31890586

discount_type   string  optional  

Example: percent

Must be one of:

• amount
• percent

discount_value   number  optional  

Example: 11613.31890586

taxes   string[]   

The id of an existing record in the taxes table.

payment_condition_id   string   

Must be a valid UUID. The id of an existing record in the payment_conditions table. Example: consequatur

payment_type_id   string   

Must be a valid UUID. The id of an existing record in the payment_types table. Example: consequatur

invoice_status   string  optional  

Example: CANCELED

Must be one of:

• all
• DRAFT
• VALIDATED
• PAID
• PARTIALLY_PAID
• CANCELED
• CREDITNOTE
• ARCHIVED

opportunity_id   string  optional  

Must be a valid UUID. The id of an existing record in the opportunities table. Example: consequatur

payment_delay   string  optional  

Example: consequatur

recurring_invoice_id   string  optional  

Must be a valid UUID. The id of an existing record in the recurring_invoices table. Example: 98adc52b-966d-39db-809a-55902ee7228f

recurring_date   string  optional  

Must be a valid date. Must be a valid date in the format d-m-Y. Example: 12-06-2025

frequency   string  optional  

Example: day

Must be one of:

• day
• week
• month
• year

limit_by   string  optional  

Example: count

Must be one of:

• none
• count
• date

limit_count   integer  optional  

Must be at least 1. Example: 17

frequency_count   integer  optional  

Example: 17

limit_date   string  optional  

Must be a valid date. Must be a valid date in the format d-m-Y. Example: 12-06-2025

project_id   string  optional  

Must be a valid UUID. The id of an existing record in the projects table. Example: consequatur

PATCH api/v1/update/{invoice}/invoice

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/invoice" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"invoice_date\": \"2019-10-08\",
    \"due_date\": \"2106-07-12\",
    \"notes\": \"consequatur\",
    \"contact_id\": \"98adc52b-966d-39db-809a-55902ee7228f\",
    \"currency_id\": \"d48a46b6-3a18-3763-951d-66b7fdb284ae\",
    \"items\": [
        \"pfuudtdsufvyvddqamnii\"
    ],
    \"payment_condition_id\": \"consequatur\",
    \"payment_type_id\": \"consequatur\",
    \"invoice_status\": \"VALIDATED\",
    \"opportunity_id\": \"consequatur\",
    \"payment_delay\": \"consequatur\",
    \"recurring_invoice_id\": \"98adc52b-966d-39db-809a-55902ee7228f\",
    \"recurring_date\": \"12-06-2025\",
    \"frequency\": \"month\",
    \"limit_by\": \"date\",
    \"limit_count\": 17,
    \"frequency_count\": 17,
    \"limit_date\": \"12-06-2025\",
    \"project_id\": \"consequatur\",
    \"invoice_id\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/invoice"
);

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

let body = {
    "invoice_date": "2019-10-08",
    "due_date": "2106-07-12",
    "notes": "consequatur",
    "contact_id": "98adc52b-966d-39db-809a-55902ee7228f",
    "currency_id": "d48a46b6-3a18-3763-951d-66b7fdb284ae",
    "items": [
        "pfuudtdsufvyvddqamnii"
    ],
    "payment_condition_id": "consequatur",
    "payment_type_id": "consequatur",
    "invoice_status": "VALIDATED",
    "opportunity_id": "consequatur",
    "payment_delay": "consequatur",
    "recurring_invoice_id": "98adc52b-966d-39db-809a-55902ee7228f",
    "recurring_date": "12-06-2025",
    "frequency": "month",
    "limit_by": "date",
    "limit_count": 17,
    "frequency_count": 17,
    "limit_date": "12-06-2025",
    "project_id": "consequatur",
    "invoice_id": "consequatur"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{invoice}/invoice

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

invoice   string   

Example: consequatur

Body Parameters

invoice_date   string   

Must be a valid date in the format d-m-Y. Must be a date before or equal to due_date. Example: 2019-10-08

due_date   string   

Must be a valid date in the format d-m-Y. Must be a date after or equal to invoice_date. Example: 2106-07-12

notes   string  optional  

Example: consequatur

contact_id   string   

Must be a valid UUID. The id of an existing record in the contacts table. Example: 98adc52b-966d-39db-809a-55902ee7228f

currency_id   string   

Must be a valid UUID. The id of an existing record in the currencies table. Example: d48a46b6-3a18-3763-951d-66b7fdb284ae

items   string[]   

Must not be greater than 255 characters.

product_id   string   

The id of an existing record in the product_sale_elements table. Example: consequatur

description   string  optional  

quantity   number   

Example: 11613.31890586

price   number   

Example: 11613.31890586

discount_type   string  optional  

Example: amount

Must be one of:

• amount
• percent

discount_value   number  optional  

Example: 11613.31890586

taxes   string[]   

The id of an existing record in the taxes table.

payment_condition_id   string   

Must be a valid UUID. The id of an existing record in the payment_conditions table. Example: consequatur

payment_type_id   string   

Must be a valid UUID. The id of an existing record in the payment_types table. Example: consequatur

invoice_status   string  optional  

Example: VALIDATED

Must be one of:

• all
• DRAFT
• VALIDATED
• PAID
• PARTIALLY_PAID
• CANCELED
• CREDITNOTE
• ARCHIVED

opportunity_id   string  optional  

Must be a valid UUID. The id of an existing record in the opportunities table. Example: consequatur

payment_delay   string  optional  

Example: consequatur

recurring_invoice_id   string  optional  

Must be a valid UUID. The id of an existing record in the recurring_invoices table. Example: 98adc52b-966d-39db-809a-55902ee7228f

recurring_date   string  optional  

Must be a valid date. Must be a valid date in the format d-m-Y. Example: 12-06-2025

frequency   string  optional  

Example: month

Must be one of:

• day
• week
• month
• year

limit_by   string  optional  

Example: date

Must be one of:

• none
• count
• date

limit_count   integer  optional  

Must be at least 1. Example: 17

frequency_count   integer  optional  

Example: 17

limit_date   string  optional  

Must be a valid date. Must be a valid date in the format d-m-Y. Example: 12-06-2025

project_id   string  optional  

Must be a valid UUID. The id of an existing record in the projects table. Example: consequatur

invoice_id   string   

The id of an existing record in the invoices table. Example: consequatur

GET api/v1/get/notPaid/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/notPaid/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/notPaid/collection"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/notPaid/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/invoices/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/invoices/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/invoices/datatables"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/invoices/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/invoice/{invoice}

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/invoice/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/invoice/consequatur"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/invoice/{invoice}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

invoice   string   

The invoice. Example: consequatur

GET api/v1/get/invoice/pdf/{invoice}

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/invoice/pdf/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/invoice/pdf/consequatur"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/invoice/pdf/{invoice}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

invoice   string   

Example: consequatur

POST api/v1/send/invoice/{invoice}/email

Example request:

curl --request POST \
    "http://core.localhost/api/v1/send/invoice/consequatur/email" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"body\": \"consequatur\",
    \"subject\": \"consequatur\",
    \"to\": [
        \"carolyne.luettgen@example.org\"
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/send/invoice/consequatur/email"
);

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

let body = {
    "body": "consequatur",
    "subject": "consequatur",
    "to": [
        "carolyne.luettgen@example.org"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/send/invoice/{invoice}/email

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

invoice   string   

The invoice. Example: consequatur

Body Parameters

body   string   

Example: consequatur

subject   string   

Example: consequatur

to   string[]  optional  

Must be a valid email address.

POST api/v1/cancel-email/invoice/{invoice}/email

Example request:

curl --request POST \
    "http://core.localhost/api/v1/cancel-email/invoice/consequatur/email" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/cancel-email/invoice/consequatur/email"
);

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

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

Request    Try it out ⚡   

POST api/v1/cancel-email/invoice/{invoice}/email

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

invoice   string   

The invoice. Example: consequatur

PATCH api/v1/set/invoice/{invoice}/validated

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/set/invoice/consequatur/validated" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/set/invoice/consequatur/validated"
);

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

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

Request    Try it out ⚡   

PATCH api/v1/set/invoice/{invoice}/validated

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

invoice   string   

The invoice. Example: consequatur

PATCH api/v1/set/invoice/{invoice}/archived

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/set/invoice/consequatur/archived" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/set/invoice/consequatur/archived"
);

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

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

Request    Try it out ⚡   

PATCH api/v1/set/invoice/{invoice}/archived

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

invoice   string   

The invoice. Example: consequatur

POST api/v1/upload/validated/invoice/{invoice}/files

Example request:

curl --request POST \
    "http://core.localhost/api/v1/upload/validated/invoice/consequatur/files" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"files\": [
        \"vmqeopfuudtdsufvyvddq\"
    ],
    \"invoice_id\": \"462ee709-6d9f-345a-95e6-76f833111fb8\"
}"

const url = new URL(
    "http://core.localhost/api/v1/upload/validated/invoice/consequatur/files"
);

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

let body = {
    "files": [
        "vmqeopfuudtdsufvyvddq"
    ],
    "invoice_id": "462ee709-6d9f-345a-95e6-76f833111fb8"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/upload/validated/invoice/{invoice}/files

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

invoice   string   

The invoice. Example: consequatur

Body Parameters

files   string[]   

Must not be greater than 2048 characters.

invoice_id   string   

Must be a valid UUID. The id of an existing record in the invoices table. Example: 462ee709-6d9f-345a-95e6-76f833111fb8

POST api/v1/store/invoice/{invoice}/credit/note

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/invoice/consequatur/credit/note" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/store/invoice/consequatur/credit/note"
);

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

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

Request    Try it out ⚡   

POST api/v1/store/invoice/{invoice}/credit/note

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

invoice   string   

The invoice. Example: consequatur

GET api/v1/get/payments/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/payments/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/payments/datatables"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/payments/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/show/{payment}/payment

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/show/consequatur/payment" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/show/consequatur/payment"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/show/{payment}/payment

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

payment   string   

Example: consequatur

PATCH api/v1/update/payment/{payment}/status

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/payment/consequatur/status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"payment_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"payment_date\": \"12-06-2025\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/payment/consequatur/status"
);

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

let body = {
    "payment_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "payment_date": "12-06-2025"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/payment/{payment}/status

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

payment   string   

The payment. Example: consequatur

Body Parameters

payment_id   string   

Must be a valid UUID. The id of an existing record in the payments table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

payment_date   string   

Must be a valid date. Must be a valid date in the format d-m-Y. Example: 12-06-2025

PATCH api/v1/cancel/payment/{payment}

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/cancel/payment/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/cancel/payment/consequatur"
);

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

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

Request    Try it out ⚡   

PATCH api/v1/cancel/payment/{payment}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

payment   string   

The payment. Example: consequatur

GET api/v1/get/payment/pdf/{payment}

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/payment/pdf/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/payment/pdf/consequatur"
);

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

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

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/payment/pdf/{payment}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

payment   string   

Example: consequatur

POST api/v1/send/payment/{payment}/email

Example request:

curl --request POST \
    "http://core.localhost/api/v1/send/payment/consequatur/email" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"body\": \"consequatur\",
    \"subject\": \"consequatur\",
    \"to\": [
        \"carolyne.luettgen@example.org\"
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/send/payment/consequatur/email"
);

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

let body = {
    "body": "consequatur",
    "subject": "consequatur",
    "to": [
        "carolyne.luettgen@example.org"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/send/payment/{payment}/email

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

payment   string   

The payment. Example: consequatur

Body Parameters

body   string   

Example: consequatur

subject   string   

Example: consequatur

to   string[]  optional  

Must be a valid email address.

POST api/v1/cancel-email/payment/{payment}/email

Example request:

curl --request POST \
    "http://core.localhost/api/v1/cancel-email/payment/consequatur/email" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/cancel-email/payment/consequatur/email"
);

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

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

Request    Try it out ⚡   

POST api/v1/cancel-email/payment/{payment}/email

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

payment   string   

The payment. Example: consequatur

GET api/v1/get/advances/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/advances/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/advances/datatables"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/advances/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/notPaid/advances

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/notPaid/advances" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/notPaid/advances"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/notPaid/advances

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/invoice/advance

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/invoice/advance" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"date\": \"12-06-2025\",
    \"invoice_id\": \"consequatur\",
    \"type\": \"amount\",
    \"percentage\": 11613.31890586,
    \"amount\": 11613.31890586,
    \"payment_type_id\": \"consequatur\",
    \"status\": \"all\",
    \"due_date\": \"12-06-2025\",
    \"files\": [
        \"mqeopfuudtdsufvyvddqa\"
    ],
    \"payment_date\": \"2025-06-12T12:56:31\",
    \"payment_account_type\": \"account\",
    \"account_id\": \"consequatur\",
    \"box_id\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/invoice/advance"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "date": "12-06-2025",
    "invoice_id": "consequatur",
    "type": "amount",
    "percentage": 11613.31890586,
    "amount": 11613.31890586,
    "payment_type_id": "consequatur",
    "status": "all",
    "due_date": "12-06-2025",
    "files": [
        "mqeopfuudtdsufvyvddqa"
    ],
    "payment_date": "2025-06-12T12:56:31",
    "payment_account_type": "account",
    "account_id": "consequatur",
    "box_id": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/invoice/advance

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

date   string   

Must be a valid date. Must be a valid date in the format d-m-Y. Example: 12-06-2025

invoice_id   string   

Must be a valid UUID. The id of an existing record in the invoices table. Example: consequatur

type   string   

Example: amount

Must be one of:

• amount
• percent

percentage   number  optional  

This field is required when type is percent. Example: 11613.31890586

amount   number  optional  

This field is required when type is amount. Example: 11613.31890586

payment_type_id   string   

The id of an existing record in the payment_types table. Example: consequatur

status   string  optional  

Example: all

Must be one of:

• all
• UNPAID
• PAID
• CANCEL

due_date   string  optional  

This field is required when status is UNPAID. Must be a valid date. Must be a valid date in the format d-m-Y. Example: 12-06-2025

files   string[]  optional  

This field is required when status is PAID. Must not be greater than 2048 characters.

payment_date   string  optional  

This field is required when status is PAID. Must be a valid date. Example: 2025-06-12T12:56:31

payment_account_type   string  optional  

This field is required when status is PAID. Example: account

Must be one of:

• account
• box

account_id   string  optional  

The id of an existing record in the accounts table. Example: consequatur

box_id   string  optional  

The id of an existing record in the boxes table. Example: consequatur

GET api/v1/show/{advance}/advance

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/show/consequatur/advance" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/show/consequatur/advance"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/show/{advance}/advance

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

advance   string   

Example: consequatur

POST api/v1/update/advance/{advance}/status

Example request:

curl --request POST \
    "http://core.localhost/api/v1/update/advance/consequatur/status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"advance_invoice_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"payment_date\": \"12-06-2025\",
    \"files\": [
        \"qeopfuudtdsufvyvddqam\"
    ],
    \"payment_account_type\": \"box\",
    \"account_id\": \"1915c795-5d1c-3def-965b-5abe034dd150\",
    \"box_id\": \"d63469cd-6701-3555-a16b-fc9764100c9a\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/advance/consequatur/status"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "advance_invoice_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "payment_date": "12-06-2025",
    "files": [
        "qeopfuudtdsufvyvddqam"
    ],
    "payment_account_type": "box",
    "account_id": "1915c795-5d1c-3def-965b-5abe034dd150",
    "box_id": "d63469cd-6701-3555-a16b-fc9764100c9a"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/update/advance/{advance}/status

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

advance   string   

The advance. Example: consequatur

Body Parameters

advance_invoice_id   string   

Must be a valid UUID. The id of an existing record in the advance_invoices table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

payment_date   string   

Must be a valid date. Must be a valid date in the format d-m-Y. Example: 12-06-2025

files   string[]   

Must not be greater than 2048 characters.

payment_account_type   string   

Example: box

Must be one of:

• account
• box

account_id   string  optional  

Must be a valid UUID. The id of an existing record in the accounts table. Example: 1915c795-5d1c-3def-965b-5abe034dd150

box_id   string  optional  

Must be a valid UUID. The id of an existing record in the boxes table. Example: d63469cd-6701-3555-a16b-fc9764100c9a

PATCH api/v1/cancel/advance/{advance}

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/cancel/advance/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/cancel/advance/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/cancel/advance/{advance}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

advance   string   

The advance. Example: consequatur

GET api/v1/get/advance/pdf/{advance}

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/advance/pdf/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/advance/pdf/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/advance/pdf/{advance}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

advance   string   

Example: consequatur

POST api/v1/send/advance/{advance}/email

Example request:

curl --request POST \
    "http://core.localhost/api/v1/send/advance/consequatur/email" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"body\": \"consequatur\",
    \"subject\": \"consequatur\",
    \"to\": [
        \"carolyne.luettgen@example.org\"
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/send/advance/consequatur/email"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "body": "consequatur",
    "subject": "consequatur",
    "to": [
        "carolyne.luettgen@example.org"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/send/advance/{advance}/email

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

advance   string   

The advance. Example: consequatur

Body Parameters

body   string   

Example: consequatur

subject   string   

Example: consequatur

to   string[]  optional  

Must be a valid email address.

POST api/v1/cancel-email/advance/{advance}/email

Example request:

curl --request POST \
    "http://core.localhost/api/v1/cancel-email/advance/consequatur/email" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/cancel-email/advance/consequatur/email"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/cancel-email/advance/{advance}/email

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

advance   string   

The advance. Example: consequatur

POST api/v1/store/recurring/invoice

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/recurring/invoice" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"recurring_date\": \"12-06-2025\",
    \"frequency\": \"month\",
    \"limit_by\": \"none\",
    \"limit_count\": \"vmqeopfuudtdsufvyvddqamniihfqcoynlazghdtqtqxbajwbpilpmufinllwloauydlsmsju\",
    \"frequency_count\": 17,
    \"limit_date\": \"12-06-2025\",
    \"contact_id\": \"98adc52b-966d-39db-809a-55902ee7228f\",
    \"currency_id\": \"d48a46b6-3a18-3763-951d-66b7fdb284ae\",
    \"items\": [
        \"pfuudtdsufvyvddqamnii\"
    ],
    \"payment_condition_id\": \"consequatur\",
    \"payment_type_id\": \"consequatur\",
    \"status\": \"completed\",
    \"payment_delay\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/recurring/invoice"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "recurring_date": "12-06-2025",
    "frequency": "month",
    "limit_by": "none",
    "limit_count": "vmqeopfuudtdsufvyvddqamniihfqcoynlazghdtqtqxbajwbpilpmufinllwloauydlsmsju",
    "frequency_count": 17,
    "limit_date": "12-06-2025",
    "contact_id": "98adc52b-966d-39db-809a-55902ee7228f",
    "currency_id": "d48a46b6-3a18-3763-951d-66b7fdb284ae",
    "items": [
        "pfuudtdsufvyvddqamnii"
    ],
    "payment_condition_id": "consequatur",
    "payment_type_id": "consequatur",
    "status": "completed",
    "payment_delay": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/recurring/invoice

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

recurring_date   string   

Must be a valid date. Must be a valid date in the format d-m-Y. Example: 12-06-2025

frequency   string   

Example: month

Must be one of:

• day
• week
• month
• year

limit_by   string   

Example: none

Must be one of:

• none
• count
• date

limit_count   string  optional  

Must be at least 1 character. Example: vmqeopfuudtdsufvyvddqamniihfqcoynlazghdtqtqxbajwbpilpmufinllwloauydlsmsju

frequency_count   integer   

Example: 17

limit_date   string  optional  

This field is required when limit_by is date. Must be a valid date. Must be a valid date in the format d-m-Y. Example: 12-06-2025

contact_id   string   

Must be a valid UUID. The id of an existing record in the contacts table. Example: 98adc52b-966d-39db-809a-55902ee7228f

currency_id   string   

Must be a valid UUID. The id of an existing record in the currencies table. Example: d48a46b6-3a18-3763-951d-66b7fdb284ae

items   string[]   

Must not be greater than 255 characters.

product_id   string   

The id of an existing record in the product_sale_elements table. Example: consequatur

description   string  optional  

quantity   number   

Example: 11613.31890586

price   number   

Example: 11613.31890586

discount_type   string  optional  

Example: amount

Must be one of:

• amount
• percent

discount_value   number  optional  

Example: 11613.31890586

taxes   string[]   

The id of an existing record in the taxes table.

payment_condition_id   string   

Must be a valid UUID. The id of an existing record in the payment_conditions table. Example: consequatur

payment_type_id   string   

Must be a valid UUID. The id of an existing record in the payment_types table. Example: consequatur

status   string  optional  

Example: completed

Must be one of:

• all
• completed
• on_hold
• active

payment_delay   string  optional  

Example: consequatur

PATCH api/v1/update/recurring/{recurring}/invoice

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/recurring/consequatur/invoice" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"recurring_date\": \"12-06-2025\",
    \"frequency\": \"day\",
    \"limit_by\": \"none\",
    \"limit_count\": \"vmqeopfuudtdsufvyvddqamniihfqcoynlazghdtqtqxbajwbpilpmufinllwloauydlsmsju\",
    \"frequency_count\": 17,
    \"limit_date\": \"12-06-2025\",
    \"contact_id\": \"98adc52b-966d-39db-809a-55902ee7228f\",
    \"currency_id\": \"d48a46b6-3a18-3763-951d-66b7fdb284ae\",
    \"items\": [
        \"pfuudtdsufvyvddqamnii\"
    ],
    \"payment_condition_id\": \"consequatur\",
    \"payment_type_id\": \"consequatur\",
    \"status\": \"completed\",
    \"payment_delay\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/recurring/consequatur/invoice"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "recurring_date": "12-06-2025",
    "frequency": "day",
    "limit_by": "none",
    "limit_count": "vmqeopfuudtdsufvyvddqamniihfqcoynlazghdtqtqxbajwbpilpmufinllwloauydlsmsju",
    "frequency_count": 17,
    "limit_date": "12-06-2025",
    "contact_id": "98adc52b-966d-39db-809a-55902ee7228f",
    "currency_id": "d48a46b6-3a18-3763-951d-66b7fdb284ae",
    "items": [
        "pfuudtdsufvyvddqamnii"
    ],
    "payment_condition_id": "consequatur",
    "payment_type_id": "consequatur",
    "status": "completed",
    "payment_delay": "consequatur"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/recurring/{recurring}/invoice

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

recurring   string   

The recurring. Example: consequatur

Body Parameters

recurring_date   string   

Must be a valid date. Must be a valid date in the format d-m-Y. Example: 12-06-2025

frequency   string   

Example: day

Must be one of:

• day
• week
• month
• year

limit_by   string   

Example: none

Must be one of:

• none
• count
• date

limit_count   string  optional  

Must be at least 1 character. Example: vmqeopfuudtdsufvyvddqamniihfqcoynlazghdtqtqxbajwbpilpmufinllwloauydlsmsju

frequency_count   integer   

Example: 17

limit_date   string  optional  

This field is required when limit_by is date. Must be a valid date. Must be a valid date in the format d-m-Y. Example: 12-06-2025

contact_id   string   

Must be a valid UUID. The id of an existing record in the contacts table. Example: 98adc52b-966d-39db-809a-55902ee7228f

currency_id   string   

Must be a valid UUID. The id of an existing record in the currencies table. Example: d48a46b6-3a18-3763-951d-66b7fdb284ae

items   string[]   

Must not be greater than 255 characters.

product_id   string   

The id of an existing record in the product_sale_elements table. Example: consequatur

description   string  optional  

quantity   number   

Example: 11613.31890586

price   number   

Example: 11613.31890586

discount_type   string  optional  

Example: percent

Must be one of:

• amount
• percent

discount_value   number  optional  

Example: 11613.31890586

taxes   string[]   

The id of an existing record in the taxes table.

payment_condition_id   string   

Must be a valid UUID. The id of an existing record in the payment_conditions table. Example: consequatur

payment_type_id   string   

Must be a valid UUID. The id of an existing record in the payment_types table. Example: consequatur

status   string  optional  

Example: completed

Must be one of:

• all
• completed
• on_hold
• active

payment_delay   string  optional  

Example: consequatur

GET api/v1/show/recurring/invoice/{invoice}

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/show/recurring/invoice/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/show/recurring/invoice/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/show/recurring/invoice/{invoice}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

invoice   string   

The invoice. Example: consequatur

GET api/v1/get/recurring/invoices/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/recurring/invoices/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/recurring/invoices/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/recurring/invoices/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

PATCH api/v1/update/recurring/invoice/{recurring}/status

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/recurring/invoice/consequatur/status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"all\",
    \"recurring_invoice_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/recurring/invoice/consequatur/status"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "status": "all",
    "recurring_invoice_id": "66529e01-d113-3473-8d6f-9e11e09332ea"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/recurring/invoice/{recurring}/status

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

recurring   string   

Example: consequatur

Body Parameters

status   string   

Example: all

Must be one of:

• all
• completed
• on_hold
• active

recurring_invoice_id   string   

Must be a valid UUID. The id of an existing record in the recurring_invoices table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

GET api/v1/payment/status/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/payment/status/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/payment/status/enum"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/payment/status/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/invoice/status/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/invoice/status/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/invoice/status/enum"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/invoice/status/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/recurring/invoice/frequency/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/recurring/invoice/frequency/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/recurring/invoice/frequency/enum"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/recurring/invoice/frequency/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/recurring/invoice/status/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/recurring/invoice/status/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/recurring/invoice/status/enum"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/recurring/invoice/status/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/project/{project}/logs

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/project/consequatur/logs" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/project/consequatur/logs"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/project/{project}/logs

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project   string   

The project. Example: consequatur

POST api/v1/store/messaging/provider

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/messaging/provider" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"society_id\": \"462ee709-6d9f-345a-95e6-76f833111fb8\",
    \"credentials\": {
        \"id\": \"consequatur\",
        \"token\": \"consequatur\",
        \"from\": \"consequatur\"
    }
}"

const url = new URL(
    "http://core.localhost/api/v1/store/messaging/provider"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "society_id": "462ee709-6d9f-345a-95e6-76f833111fb8",
    "credentials": {
        "id": "consequatur",
        "token": "consequatur",
        "from": "consequatur"
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/messaging/provider

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

society_id   string  optional  

Must be a valid UUID. The id of an existing record in the societies table. Example: 462ee709-6d9f-345a-95e6-76f833111fb8

credentials   object   

id   string   

Example: consequatur

token   string   

Example: consequatur

from   string   

Example: consequatur

GET api/v1/get/messaging/settings

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/messaging/settings" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/messaging/settings"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/messaging/settings

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/check/module/{moduleName}

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/check/module/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/check/module/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/check/module/{moduleName}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

moduleName   string   

Example: consequatur

GET api/v1/get/suit/installed/modules

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/suit/installed/modules" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/suit/installed/modules"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/suit/installed/modules

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/suit/apps

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/suit/apps" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/suit/apps"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/suit/apps

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/install/modules

Example request:

curl --request POST \
    "http://core.localhost/api/v1/install/modules" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/install/modules"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/install/modules

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/sub/module/permission

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/sub/module/permission" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/sub/module/permission"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/sub/module/permission

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/normalizedKey

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/normalizedKey" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"key\": \"consequatur\",
    \"data\": [],
    \"society_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/normalizedKey"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "key": "consequatur",
    "data": [],
    "society_id": "66529e01-d113-3473-8d6f-9e11e09332ea"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/normalizedKey

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

key   string   

Example: consequatur

data   object   

society_id   string   

Must be a valid UUID. The id of an existing record in the societies table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

GET api/v1/get/normalizedKey

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/normalizedKey" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/normalizedKey"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/normalizedKey

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

DELETE api/v1/delete/{normalizedKey}/normalizedKey

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/normalizedKey" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/normalizedKey"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{normalizedKey}/normalizedKey

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

normalizedKey   string   

Example: consequatur

POST api/v1/normalized-invoice

Example request:

curl --request POST \
    "http://core.localhost/api/v1/normalized-invoice" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": \"consequatur\",
    \"invoice_id\": \"98adc52b-966d-39db-809a-55902ee7228f\"
}"

const url = new URL(
    "http://core.localhost/api/v1/normalized-invoice"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "data": "consequatur",
    "invoice_id": "98adc52b-966d-39db-809a-55902ee7228f"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/normalized-invoice

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

data   string   

Example: consequatur

invoice_id   string   

Must be a valid UUID. The id of an existing record in the invoices table. Example: 98adc52b-966d-39db-809a-55902ee7228f

GET api/v1/get/{normalizedInvoice}/normalizedInvoice

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/normalizedInvoice" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/normalizedInvoice"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{normalizedInvoice}/normalizedInvoice

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

normalizedInvoice   string   

Example: consequatur

DELETE api/v1/delete/{normalizedInvoice}/normalizedInvoice

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/normalizedInvoice" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/normalizedInvoice"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{normalizedInvoice}/normalizedInvoice

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

normalizedInvoice   string   

Example: consequatur

POST api/v1/generate/normalize/invoice

Example request:

curl --request POST \
    "http://core.localhost/api/v1/generate/normalize/invoice" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"invoice_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"society_id\": \"fa010f60-df29-3f05-8bc7-bed48f550d13\",
    \"type\": \"FV\"
}"

const url = new URL(
    "http://core.localhost/api/v1/generate/normalize/invoice"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "invoice_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "society_id": "fa010f60-df29-3f05-8bc7-bed48f550d13",
    "type": "FV"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/generate/normalize/invoice

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

invoice_id   string   

Must be a valid UUID. The id of an existing record in the invoices table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

society_id   string   

Must be a valid UUID. The id of an existing record in the societies table. Example: fa010f60-df29-3f05-8bc7-bed48f550d13

type   string   

Example: FV

Must be one of:

• FV
• FA

GET api/v1/verify/normalize/invoice/{invoice}

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/verify/normalize/invoice/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/verify/normalize/invoice/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/verify/normalize/invoice/{invoice}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

invoice   string   

The invoice. Example: consequatur

GET api/v1/verify/country/invoice/configuration

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/verify/country/invoice/configuration" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/verify/country/invoice/configuration"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/verify/country/invoice/configuration

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/notifications

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/notifications" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/notifications"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/notifications

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/read/{notification}/notification

Example request:

curl --request POST \
    "http://core.localhost/api/v1/read/consequatur/notification" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/read/consequatur/notification"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/read/{notification}/notification

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

notification   string   

Example: consequatur

POST api/v1/set/notification/count

Example request:

curl --request POST \
    "http://core.localhost/api/v1/set/notification/count" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/set/notification/count"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/set/notification/count

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/send/nps/invitation

Example request:

curl --request POST \
    "http://core.localhost/api/v1/send/nps/invitation" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"nps_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"contacts\": [
        \"fa010f60-df29-3f05-8bc7-bed48f550d13\"
    ],
    \"emails\": [
        \"claire77@example.net\"
    ],
    \"content\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/send/nps/invitation"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "nps_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "contacts": [
        "fa010f60-df29-3f05-8bc7-bed48f550d13"
    ],
    "emails": [
        "claire77@example.net"
    ],
    "content": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/send/nps/invitation

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

nps_id   string   

Must be a valid UUID. The id of an existing record in the nps table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

contacts   string[]  optional  

Must be a valid UUID. The id of an existing record in the contacts table.

emails   string[]  optional  

Must be a valid email address.

content   string   

Example: consequatur

GET api/v1/get/{nps}/nps/responses/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/nps/responses/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/nps/responses/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{nps}/nps/responses/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

nps   string   

Example: consequatur

GET api/v1/get/{response}/nps/response

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/nps/response" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/nps/response"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{response}/nps/response

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

response   string   

Example: consequatur

POST api/v1/verify/nps/response

Example request:

curl --request POST \
    "http://core.localhost/api/v1/verify/nps/response" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"contact_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"nps_id\": \"fa010f60-df29-3f05-8bc7-bed48f550d13\"
}"

const url = new URL(
    "http://core.localhost/api/v1/verify/nps/response"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "contact_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "nps_id": "fa010f60-df29-3f05-8bc7-bed48f550d13"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/verify/nps/response

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

contact_id   string   

Must be a valid UUID. The id of an existing record in the contacts table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

nps_id   string   

Must be a valid UUID. The id of an existing record in the nps table. Example: fa010f60-df29-3f05-8bc7-bed48f550d13

GET api/v1/get/nps/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/nps/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/nps/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/nps/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/nps

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/nps" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"consequatur\",
    \"nps_description\": \"consequatur\",
    \"icon\": \"mqeopfuudtdsufvyvddqa\",
    \"min_value\": 5,
    \"max_value\": 6,
    \"event_id\": \"consequatur\",
    \"all_type\": true,
    \"participator_type\": \"EXPONENT\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/nps"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "consequatur",
    "nps_description": "consequatur",
    "icon": "mqeopfuudtdsufvyvddqa",
    "min_value": 5,
    "max_value": 6,
    "event_id": "consequatur",
    "all_type": true,
    "participator_type": "EXPONENT"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/nps

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

title   string   

Example: consequatur

nps_description   string  optional  

Example: consequatur

icon   string  optional  

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

min_value   integer  optional  

Must be at least 1. Must not be greater than 10. Example: 5

max_value   integer  optional  

Must be at least 1. Must not be greater than 10. Example: 6

event_id   string  optional  

Must be a valid UUID. The id of an existing record in the events table. Example: consequatur

all_type   boolean  optional   true false

Example: true

participator_type   string  optional  

Example: EXPONENT

Must be one of:

• EXPONENT
• PARTICIPANT
• SPONSOR

PATCH api/v1/update/{nps}/nps

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/nps" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"consequatur\",
    \"nps_description\": \"consequatur\",
    \"icon\": \"mqeopfuudtdsufvyvddqa\",
    \"min_value\": 5,
    \"max_value\": 6,
    \"event_id\": \"consequatur\",
    \"all_type\": true,
    \"participator_type\": \"PARTICIPANT\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/nps"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "consequatur",
    "nps_description": "consequatur",
    "icon": "mqeopfuudtdsufvyvddqa",
    "min_value": 5,
    "max_value": 6,
    "event_id": "consequatur",
    "all_type": true,
    "participator_type": "PARTICIPANT"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{nps}/nps

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

nps   string   

Example: consequatur

Body Parameters

title   string   

Example: consequatur

nps_description   string  optional  

Example: consequatur

icon   string  optional  

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

min_value   integer  optional  

Must be at least 1. Must not be greater than 10. Example: 5

max_value   integer  optional  

Must be at least 1. Must not be greater than 10. Example: 6

event_id   string  optional  

Must be a valid UUID. The id of an existing record in the events table. Example: consequatur

all_type   boolean  optional   true false

Example: true

participator_type   string  optional  

Example: PARTICIPANT

Must be one of:

• EXPONENT
• PARTICIPANT
• SPONSOR

DELETE api/v1/delete/{nps}/nps

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/nps" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/nps"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{nps}/nps

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

nps   string   

Example: consequatur

GET api/v1/get/{nps}/nps/statistics

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/nps/statistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/nps/statistics"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{nps}/nps/statistics

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

nps   string   

Example: consequatur

POST api/v1/store/allowance

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/allowance" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"allowance_data\": [
        {
            \"range_min\": 11613.31890586,
            \"range_max\": 11613.31890586,
            \"type\": \"percent\",
            \"value\": 11613.31890586
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/store/allowance"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "allowance_data": [
        {
            "range_min": 11613.31890586,
            "range_max": 11613.31890586,
            "type": "percent",
            "value": 11613.31890586
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/allowance

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

allowance_data   object[]   

range_min   number  optional  

Example: 11613.31890586

range_max   number  optional  

Example: 11613.31890586

type   string   

Example: percent

Must be one of:

• amount
• percent

value   number   

Example: 11613.31890586

PATCH api/v1/update/{allowance}/allowance

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/allowance" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"allowance_data\": [
        {
            \"range_min\": 11613.31890586,
            \"range_max\": 11613.31890586,
            \"type\": \"amount\",
            \"value\": 11613.31890586
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/allowance"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "allowance_data": [
        {
            "range_min": 11613.31890586,
            "range_max": 11613.31890586,
            "type": "amount",
            "value": 11613.31890586
        }
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{allowance}/allowance

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

allowance   string   

Example: consequatur

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

allowance_data   object[]   

range_min   number  optional  

Example: 11613.31890586

range_max   number  optional  

Example: 11613.31890586

type   string   

Example: amount

Must be one of:

• amount
• percent

value   number   

Example: 11613.31890586

GET api/v1/get/allowance/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/allowance/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/allowance/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/allowance/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/allowance/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/allowance/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/allowance/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/allowance/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/{allowance}/allowance

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/allowance" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/allowance"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{allowance}/allowance

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

allowance   string   

Example: consequatur

DELETE api/v1/delete/{allowance}/allowance

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/allowance" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/allowance"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{allowance}/allowance

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

allowance   string   

Example: consequatur

POST api/v1/store/other

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/other" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"other_data\": [
        {
            \"range_min\": 11613.31890586,
            \"range_max\": 11613.31890586,
            \"type\": \"percent\",
            \"value\": 11613.31890586
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/store/other"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "other_data": [
        {
            "range_min": 11613.31890586,
            "range_max": 11613.31890586,
            "type": "percent",
            "value": 11613.31890586
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/other

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

other_data   object[]   

range_min   number  optional  

Example: 11613.31890586

range_max   number  optional  

Example: 11613.31890586

type   string   

Example: percent

Must be one of:

• amount
• percent

value   number   

Example: 11613.31890586

PATCH api/v1/update/{other}/other

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/other" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"other_data\": [
        {
            \"range_min\": 11613.31890586,
            \"range_max\": 11613.31890586,
            \"type\": \"percent\",
            \"value\": 11613.31890586
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/other"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "other_data": [
        {
            "range_min": 11613.31890586,
            "range_max": 11613.31890586,
            "type": "percent",
            "value": 11613.31890586
        }
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{other}/other

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

other   string   

Example: consequatur

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

other_data   object[]   

range_min   number  optional  

Example: 11613.31890586

range_max   number  optional  

Example: 11613.31890586

type   string   

Example: percent

Must be one of:

• amount
• percent

value   number   

Example: 11613.31890586

GET api/v1/get/other/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/other/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/other/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/other/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/other/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/other/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/other/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/other/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/{other}/other

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/other" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/other"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{other}/other

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

other   string   

Example: consequatur

DELETE api/v1/delete/{other}/other

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/other" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/other"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{other}/other

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

other   string   

Example: consequatur

POST api/v1/store/payroll-taxes

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/payroll-taxes" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"category\": \"EMPLOYER_TAXE\",
    \"payroll_tax_data\": [
        {
            \"range_min\": 11613.31890586,
            \"range_max\": 11613.31890586,
            \"type\": \"amount\",
            \"value\": 11613.31890586
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/store/payroll-taxes"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "category": "EMPLOYER_TAXE",
    "payroll_tax_data": [
        {
            "range_min": 11613.31890586,
            "range_max": 11613.31890586,
            "type": "amount",
            "value": 11613.31890586
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/payroll-taxes

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

category   string   

Example: EMPLOYER_TAXE

Must be one of:

• EMPLOYER_TAXE
• EMPLOYEE_TAXE

payroll_tax_data   object[]   

range_min   number  optional  

Example: 11613.31890586

range_max   number  optional  

Example: 11613.31890586

type   string   

Example: amount

Must be one of:

• amount
• percent

value   number   

Example: 11613.31890586

PATCH api/v1/update/{payrollTax}/payroll-taxes

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/payroll-taxes" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"category\": \"EMPLOYEE_TAXE\",
    \"payroll_tax_data\": [
        {
            \"range_min\": 11613.31890586,
            \"range_max\": 11613.31890586,
            \"type\": \"percent\",
            \"value\": 11613.31890586
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/payroll-taxes"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "category": "EMPLOYEE_TAXE",
    "payroll_tax_data": [
        {
            "range_min": 11613.31890586,
            "range_max": 11613.31890586,
            "type": "percent",
            "value": 11613.31890586
        }
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{payrollTax}/payroll-taxes

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

payrollTax   string   

Example: consequatur

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

category   string   

Example: EMPLOYEE_TAXE

Must be one of:

• EMPLOYER_TAXE
• EMPLOYEE_TAXE

payroll_tax_data   object[]   

range_min   number  optional  

Example: 11613.31890586

range_max   number  optional  

Example: 11613.31890586

type   string   

Example: percent

Must be one of:

• amount
• percent

value   number   

Example: 11613.31890586

GET api/v1/get/payroll-taxes/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/payroll-taxes/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/payroll-taxes/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/payroll-taxes/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/payroll-taxes/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/payroll-taxes/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/payroll-taxes/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/payroll-taxes/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/{payrollTax}/payroll-taxes

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/payroll-taxes" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/payroll-taxes"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{payrollTax}/payroll-taxes

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

payrollTax   string   

Example: consequatur

DELETE api/v1/delete/{payrollTax}/payroll-taxes

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/payroll-taxes" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/payroll-taxes"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{payrollTax}/payroll-taxes

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

payrollTax   string   

Example: consequatur

POST api/v1/store/pension

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/pension" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"pension_data\": [
        {
            \"range_min\": 11613.31890586,
            \"range_max\": 11613.31890586,
            \"type\": \"amount\",
            \"value\": 11613.31890586
        }
    ],
    \"category\": \"EMPLOYEE_PENSION\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/pension"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "pension_data": [
        {
            "range_min": 11613.31890586,
            "range_max": 11613.31890586,
            "type": "amount",
            "value": 11613.31890586
        }
    ],
    "category": "EMPLOYEE_PENSION"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/pension

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

pension_data   object[]   

range_min   number  optional  

Example: 11613.31890586

range_max   number  optional  

Example: 11613.31890586

type   string   

Example: amount

Must be one of:

• amount
• percent

value   number   

Example: 11613.31890586

category   string   

Example: EMPLOYEE_PENSION

Must be one of:

• EMPLOYER_PENSION
• EMPLOYEE_PENSION

PATCH api/v1/update/{pension}/pension

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/pension" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"category\": \"EMPLOYER_PENSION\",
    \"pension_data\": [
        {
            \"range_min\": 11613.31890586,
            \"range_max\": 11613.31890586,
            \"type\": \"amount\",
            \"value\": 11613.31890586
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/pension"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "category": "EMPLOYER_PENSION",
    "pension_data": [
        {
            "range_min": 11613.31890586,
            "range_max": 11613.31890586,
            "type": "amount",
            "value": 11613.31890586
        }
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{pension}/pension

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

pension   string   

Example: consequatur

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

category   string   

Example: EMPLOYER_PENSION

Must be one of:

• EMPLOYER_PENSION
• EMPLOYEE_PENSION

pension_data   object[]   

range_min   number  optional  

Example: 11613.31890586

range_max   number  optional  

Example: 11613.31890586

type   string   

Example: amount

Must be one of:

• amount
• percent

value   number   

Example: 11613.31890586

GET api/v1/get/pension/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/pension/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/pension/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/pension/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/pension/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/pension/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/pension/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/pension/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/{pension}/pension

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/pension" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/pension"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{pension}/pension

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

pension   string   

Example: consequatur

DELETE api/v1/delete/{pension}/pension

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/pension" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/pension"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{pension}/pension

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

pension   string   

Example: consequatur

GET api/v1/payslip/tax/type/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/payslip/tax/type/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/payslip/tax/type/enum"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/payslip/tax/type/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/payslip/status/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/payslip/status/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/payslip/status/enum"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/payslip/status/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/payslip/pension/type/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/payslip/pension/type/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/payslip/pension/type/enum"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/payslip/pension/type/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/payslip/offices/statistics

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/payslip/offices/statistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/payslip/offices/statistics"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/payslip/offices/statistics

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/draft/payslips

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/draft/payslips" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/draft/payslips"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/draft/payslips

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/offices/payslips

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/offices/payslips" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/offices/payslips"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/offices/payslips

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/download/payslip

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/download/payslip" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"month\": \"07\",
    \"year\": \"vmqe\"
}"

const url = new URL(
    "http://core.localhost/api/v1/download/payslip"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "month": "07",
    "year": "vmqe"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/download/payslip

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

office_id   string  optional  

This field is required when payslip is null. The id of an existing record in the offices table.

payslip   string  optional  

This field is required when none of office_id, month, and year are present. The id of an existing record in the payslips table.

month   string  optional  

This field is required when payslip is null. Example: 07

Must be one of:

• 01
• 02
• 03
• 04
• 05
• 06
• 07
• 08
• 09
• 10
• 11
• 12

year   string  optional  

This field is required when payslip is null. Must be at least 4 characters. Must not be greater than 4 characters. Example: vmqe

GET api/v1/get/{payslip}/payslip

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/payslip" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/payslip"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{payslip}/payslip

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

payslip   string   

Example: consequatur

POST api/v1/store/payslip

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/payslip" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "office_id=66529e01-d113-3473-8d6f-9e11e09332ea"\
    --form "user_id=fa010f60-df29-3f05-8bc7-bed48f550d13"\
    --form "month=06"\
    --form "year=opfu"\
    --form "base_salary=70"\
    --form "allowances[][id]=fefb079f-5b81-3552-831f-ed3f89669781"\
    --form "allowances[][value]=11613.31890586"\
    --form "allowances[][edited]="\
    --form "others[][value]=11613.31890586"\
    --form "others[][edited]="\
    --form "pensions[][value]=11613.31890586"\
    --form "pensions[][edited]="\
    --form "taxes[][value]=11613.31890586"\
    --form "taxes[][edited]="\
    --form "pension_employers[][value]=11613.31890586"\
    --form "pension_employers[][edited]=1"\
    --form "taxe_employers[][value]=11613.31890586"\
    --form "taxe_employers[][edited]=1"\
    --form "files[]=@/tmp/phplt2tWy" 

const url = new URL(
    "http://core.localhost/api/v1/store/payslip"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('office_id', '66529e01-d113-3473-8d6f-9e11e09332ea');
body.append('user_id', 'fa010f60-df29-3f05-8bc7-bed48f550d13');
body.append('month', '06');
body.append('year', 'opfu');
body.append('base_salary', '70');
body.append('allowances[][id]', 'fefb079f-5b81-3552-831f-ed3f89669781');
body.append('allowances[][value]', '11613.31890586');
body.append('allowances[][edited]', '');
body.append('others[][value]', '11613.31890586');
body.append('others[][edited]', '');
body.append('pensions[][value]', '11613.31890586');
body.append('pensions[][edited]', '');
body.append('taxes[][value]', '11613.31890586');
body.append('taxes[][edited]', '');
body.append('pension_employers[][value]', '11613.31890586');
body.append('pension_employers[][edited]', '1');
body.append('taxe_employers[][value]', '11613.31890586');
body.append('taxe_employers[][edited]', '1');
body.append('files[]', document.querySelector('input[name="files[]"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/payslip

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

office_id   string   

Must be a valid UUID. The id of an existing record in the offices table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

user_id   string   

Must be a valid UUID. The id of an existing record in the users table. Example: fa010f60-df29-3f05-8bc7-bed48f550d13

files   file[]   

Must be a file. Must not be greater than 2048 kilobytes.

month   string   

Example: 06

Must be one of:

• 01
• 02
• 03
• 04
• 05
• 06
• 07
• 08
• 09
• 10
• 11
• 12

year   string   

Must be at least 4 characters. Must not be greater than 4 characters. Example: opfu

base_salary   number   

Must be at least 0. Example: 70

allowances   object[]  optional  

id   string  optional  

Must be a valid UUID. The id of an existing record in the allowances table. Example: fefb079f-5b81-3552-831f-ed3f89669781

value   number  optional  

Example: 11613.31890586

edited   boolean  optional   true false

Example: false

others   object[]  optional  

id   string  optional  

The id of an existing record in the others table.

value   number  optional  

Example: 11613.31890586

edited   boolean  optional   true false

Example: false

pensions   object[]  optional  

id   string  optional  

The id of an existing record in the pensions table.

value   number  optional  

Example: 11613.31890586

edited   boolean  optional   true false

Example: false

taxes   object[]  optional  

id   string  optional  

The id of an existing record in the payroll_taxes table.

value   number  optional  

Example: 11613.31890586

edited   boolean  optional   true false

Example: false

pension_employers   object[]  optional  

id   string  optional  

The id of an existing record in the pensions table.

value   number  optional  

Example: 11613.31890586

edited   boolean  optional   true false

Example: true

taxe_employers   object[]  optional  

id   string  optional  

The id of an existing record in the payroll_taxes table.

value   number  optional  

Example: 11613.31890586

edited   boolean  optional   true false

Example: true

PATCH api/v1/payslip/{payslip}/update

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/payslip/consequatur/update" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "office_id=66529e01-d113-3473-8d6f-9e11e09332ea"\
    --form "user_id=fa010f60-df29-3f05-8bc7-bed48f550d13"\
    --form "month=06"\
    --form "year=opfu"\
    --form "base_salary=70"\
    --form "payslip_id=fefb079f-5b81-3552-831f-ed3f89669781"\
    --form "allowances[][id]=0d7cac1d-9cec-3d5a-9508-c7e30cc7b175"\
    --form "allowances[][value]=11613.31890586"\
    --form "allowances[][edited]="\
    --form "others[][value]=11613.31890586"\
    --form "others[][edited]="\
    --form "pensions[][value]=11613.31890586"\
    --form "pensions[][edited]=1"\
    --form "taxes[][value]=11613.31890586"\
    --form "taxes[][edited]="\
    --form "pension_employers[][value]=11613.31890586"\
    --form "pension_employers[][edited]=1"\
    --form "taxe_employers[][value]=11613.31890586"\
    --form "taxe_employers[][edited]=1"\
    --form "files[]=@/tmp/phpFqjok9" 

const url = new URL(
    "http://core.localhost/api/v1/payslip/consequatur/update"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('office_id', '66529e01-d113-3473-8d6f-9e11e09332ea');
body.append('user_id', 'fa010f60-df29-3f05-8bc7-bed48f550d13');
body.append('month', '06');
body.append('year', 'opfu');
body.append('base_salary', '70');
body.append('payslip_id', 'fefb079f-5b81-3552-831f-ed3f89669781');
body.append('allowances[][id]', '0d7cac1d-9cec-3d5a-9508-c7e30cc7b175');
body.append('allowances[][value]', '11613.31890586');
body.append('allowances[][edited]', '');
body.append('others[][value]', '11613.31890586');
body.append('others[][edited]', '');
body.append('pensions[][value]', '11613.31890586');
body.append('pensions[][edited]', '1');
body.append('taxes[][value]', '11613.31890586');
body.append('taxes[][edited]', '');
body.append('pension_employers[][value]', '11613.31890586');
body.append('pension_employers[][edited]', '1');
body.append('taxe_employers[][value]', '11613.31890586');
body.append('taxe_employers[][edited]', '1');
body.append('files[]', document.querySelector('input[name="files[]"]').files[0]);

fetch(url, {
    method: "PATCH",
    headers,
    body,
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/payslip/{payslip}/update

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

payslip   string   

The payslip. Example: consequatur

Body Parameters

office_id   string   

Must be a valid UUID. The id of an existing record in the offices table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

user_id   string   

Must be a valid UUID. The id of an existing record in the users table. Example: fa010f60-df29-3f05-8bc7-bed48f550d13

files   file[]   

Must be a file. Must not be greater than 2048 kilobytes.

month   string   

Example: 06

Must be one of:

• 01
• 02
• 03
• 04
• 05
• 06
• 07
• 08
• 09
• 10
• 11
• 12

year   string   

Must be at least 4 characters. Must not be greater than 4 characters. Example: opfu

base_salary   number   

Must be at least 0. Example: 70

allowances   object[]  optional  

id   string  optional  

Must be a valid UUID. The id of an existing record in the allowances table. Example: 0d7cac1d-9cec-3d5a-9508-c7e30cc7b175

value   number  optional  

Example: 11613.31890586

edited   boolean  optional   true false

Example: false

others   object[]  optional  

id   string  optional  

The id of an existing record in the others table.

value   number  optional  

Example: 11613.31890586

edited   boolean  optional   true false

Example: false

pensions   object[]  optional  

id   string  optional  

The id of an existing record in the pensions table.

value   number  optional  

Example: 11613.31890586

edited   boolean  optional   true false

Example: true

taxes   object[]  optional  

id   string  optional  

The id of an existing record in the payroll_taxes table.

value   number  optional  

Example: 11613.31890586

edited   boolean  optional   true false

Example: false

pension_employers   object[]  optional  

id   string  optional  

The id of an existing record in the pensions table.

value   number  optional  

Example: 11613.31890586

edited   boolean  optional   true false

Example: true

taxe_employers   object[]  optional  

id   string  optional  

The id of an existing record in the payroll_taxes table.

value   number  optional  

Example: 11613.31890586

edited   boolean  optional   true false

Example: true

payslip_id   string   

Must be a valid UUID. The id of an existing record in the payslips table. Example: fefb079f-5b81-3552-831f-ed3f89669781

POST api/v1/payslips/validate

Example request:

curl --request POST \
    "http://core.localhost/api/v1/payslips/validate" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/payslips/validate"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/payslips/validate

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/payslip/generate/monthly/expenses

Example request:

curl --request POST \
    "http://core.localhost/api/v1/payslip/generate/monthly/expenses" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/payslip/generate/monthly/expenses"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/payslip/generate/monthly/expenses

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/user/payslips/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/user/payslips/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/user/payslips/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/user/payslips/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/tags/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/tags/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/tags/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/tags/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/tags/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/tags/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/tags/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/tags/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/tag

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/tag" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/tag"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/tag

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

PATCH api/v1/update/{tag}/tag

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/tag" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"tag\": \"amniihfqcoynlazghdtqt\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/tag"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "tag": "amniihfqcoynlazghdtqt"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{tag}/tag

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

tag   string   

Example: consequatur

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

tag   string   

Must be a valid UUID. The id of an existing record in the tags table. Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

DELETE api/v1/delete/{tag}/tag

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/tag" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/tag"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{tag}/tag

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

tag   string   

Example: consequatur

GET api/v1/get/sources/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/sources/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/sources/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/sources/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/sources/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/sources/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/sources/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/sources/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/source

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/source" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/source"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/source

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

PATCH api/v1/update/{source}/source

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/source" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"source\": \"amniihfqcoynlazghdtqt\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/source"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "source": "amniihfqcoynlazghdtqt"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{source}/source

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

source   string   

Example: consequatur

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

source   string   

Must be a valid UUID. The id of an existing record in the opportunity_sources table. Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

DELETE api/v1/delete/{source}/source

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/source" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/source"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{source}/source

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

source   string   

Example: consequatur

GET api/v1/get/reasons/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/reasons/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/reasons/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/reasons/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/reasons/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/reasons/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/reasons/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/reasons/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/reason

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/reason" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/reason"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/reason

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

PATCH api/v1/update/{reason}/reason

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/reason" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"reason\": \"amniihfqcoynlazghdtqt\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/reason"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "reason": "amniihfqcoynlazghdtqt"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{reason}/reason

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

reason   string   

Example: consequatur

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

reason   string   

Must be a valid UUID. The id of an existing record in the reasons table. Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

DELETE api/v1/delete/{reason}/reason

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/reason" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/reason"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{reason}/reason

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

reason   string   

Example: consequatur

GET api/v1/get/typeActivities/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/typeActivities/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/typeActivities/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/typeActivities/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/typeActivities/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/typeActivities/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/typeActivities/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/typeActivities/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/typeActivity

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/typeActivity" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"icon\": \"fa fa-shopping-bag\",
    \"color\": \"consequatur\",
    \"active\": true
}"

const url = new URL(
    "http://core.localhost/api/v1/store/typeActivity"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "icon": "fa fa-shopping-bag",
    "color": "consequatur",
    "active": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/typeActivity

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

icon   string   

Example: fa fa-shopping-bag

Must be one of:

• fa fa-edit
• fa fa-clock
• fa fa-users
• fa fa-file
• fa fa-car
• fa fa-clipboard
• fa fa-tag
• fa fa-plane
• fa fa-sync
• fa fa-shopping-bag
• fa fa-play-circle
• fa fa-coins
• fa fa-bus
• fa fa-bell
• fa fa-envelope
• fa fa-sticky-note
• fa fa-coffee
• fa fa-phone
• fa fa-history
• fa fa-heart-broken
• fa fa-trophy
• fa fa-paperclip
• fa fa-building
• fa fa-inbox

color   string  optional  

Example: consequatur

active   boolean  optional   true false

Example: true

PATCH api/v1/update/{typeActivity}/typeActivity

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/typeActivity" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"icon\": \"fa fa-history\",
    \"color\": \"consequatur\",
    \"active\": false
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/typeActivity"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "icon": "fa fa-history",
    "color": "consequatur",
    "active": false
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{typeActivity}/typeActivity

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

typeActivity   string   

Example: consequatur

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

icon   string   

Example: fa fa-history

Must be one of:

• fa fa-edit
• fa fa-clock
• fa fa-users
• fa fa-file
• fa fa-car
• fa fa-clipboard
• fa fa-tag
• fa fa-plane
• fa fa-sync
• fa fa-shopping-bag
• fa fa-play-circle
• fa fa-coins
• fa fa-bus
• fa fa-bell
• fa fa-envelope
• fa fa-sticky-note
• fa fa-coffee
• fa fa-phone
• fa fa-history
• fa fa-heart-broken
• fa fa-trophy
• fa fa-paperclip
• fa fa-building
• fa fa-inbox

color   string  optional  

Example: consequatur

active   boolean  optional   true false

Example: false

PATCH api/v1/update/typeActivity/{typeActivity}/status

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/typeActivity/consequatur/status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/update/typeActivity/consequatur/status"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/typeActivity/{typeActivity}/status

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

typeActivity   string   

The typeActivity. Example: consequatur

DELETE api/v1/delete/{typeActivity}/typeActivity

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/typeActivity" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/typeActivity"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{typeActivity}/typeActivity

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

typeActivity   string   

Example: consequatur

GET api/v1/get/opportunityStates/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/opportunityStates/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/opportunityStates/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/opportunityStates/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/opportunityStates/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/opportunityStates/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/opportunityStates/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/opportunityStates/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/opportunityState

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/opportunityState" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"winner_state\": true,
    \"closure_rate\": 1,
    \"active\": false,
    \"criterias\": [
        {
            \"title\": \"mniihfqcoynlazghdtqtq\"
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/store/opportunityState"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "winner_state": true,
    "closure_rate": 1,
    "active": false,
    "criterias": [
        {
            "title": "mniihfqcoynlazghdtqtq"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/opportunityState

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

winner_state   boolean  optional   true false

Example: true

closure_rate   number  optional  

Must be at least 0. Must not be greater than 100. Example: 1

active   boolean  optional   true false

Example: false

criterias   object[]  optional  

title   string  optional  

This field is required when criterias is present. Must not be greater than 255 characters. Example: mniihfqcoynlazghdtqtq

GET api/v1/show/{opportunityState}/opportunityState

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/show/consequatur/opportunityState" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/show/consequatur/opportunityState"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/show/{opportunityState}/opportunityState

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

opportunityState   string   

Example: consequatur

PATCH api/v1/update/{opportunityState}/opportunityState

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/opportunityState" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"winner_state\": true,
    \"closure_rate\": 1,
    \"active\": false,
    \"opportunity_state_id\": \"87582a71-8e82-3d56-919d-d5863651492b\",
    \"apply_to_older\": false,
    \"criterias\": [
        {
            \"title\": \"iihfqcoynlazghdtqtqxb\",
            \"id\": \"ba3a31ce-1e9f-3aa8-8b6f-424fe4033b3d\"
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/opportunityState"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "winner_state": true,
    "closure_rate": 1,
    "active": false,
    "opportunity_state_id": "87582a71-8e82-3d56-919d-d5863651492b",
    "apply_to_older": false,
    "criterias": [
        {
            "title": "iihfqcoynlazghdtqtqxb",
            "id": "ba3a31ce-1e9f-3aa8-8b6f-424fe4033b3d"
        }
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{opportunityState}/opportunityState

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

opportunityState   string   

Example: consequatur

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

winner_state   boolean  optional   true false

Example: true

closure_rate   number  optional  

Must be at least 0. Must not be greater than 100. Example: 1

active   boolean  optional   true false

Example: false

criterias   object[]  optional  

title   string  optional  

This field is required when criterias is present. Must not be greater than 255 characters. Example: iihfqcoynlazghdtqtqxb

id   string  optional  

Must be a valid UUID. The id of an existing record in the opportunity_state_criterias table. Example: ba3a31ce-1e9f-3aa8-8b6f-424fe4033b3d

opportunity_state_id   string   

Must be a valid UUID. The id of an existing record in the opportunity_states table. Example: 87582a71-8e82-3d56-919d-d5863651492b

apply_to_older   boolean    true false

Example: false

PATCH api/v1/update/{opportunityState}/name

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/name" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"opportunityState\": \"462ee709-6d9f-345a-95e6-76f833111fb8\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/name"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "opportunityState": "462ee709-6d9f-345a-95e6-76f833111fb8"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{opportunityState}/name

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

opportunityState   string   

Example: consequatur

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

opportunityState   string   

Must be a valid UUID. The id of an existing record in the opportunity_states table. Example: 462ee709-6d9f-345a-95e6-76f833111fb8

PATCH api/v1/update/{opportunityState}/position

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/position" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"opportunityState\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"new_order\": 56
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/position"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "opportunityState": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "new_order": 56
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{opportunityState}/position

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

opportunityState   string   

Example: consequatur

Body Parameters

opportunityState   string   

Must be a valid UUID. The id of an existing record in the opportunity_states table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

new_order   integer   

Must be at least 1. Example: 56

PATCH api/v1/set/opportunityState/{opportunityState}/status

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/set/opportunityState/consequatur/status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"opportunityState\": \"66529e01-d113-3473-8d6f-9e11e09332ea\"
}"

const url = new URL(
    "http://core.localhost/api/v1/set/opportunityState/consequatur/status"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "opportunityState": "66529e01-d113-3473-8d6f-9e11e09332ea"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/set/opportunityState/{opportunityState}/status

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

opportunityState   string   

The opportunityState. Example: consequatur

Body Parameters

opportunityState   string   

Must be a valid UUID. The id of an existing record in the opportunity_states table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

DELETE api/v1/delete/{opportunityState}/opportunityState

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/opportunityState" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/opportunityState"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{opportunityState}/opportunityState

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

opportunityState   string   

Example: consequatur

GET api/v1/get/opportunities/stats

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/opportunities/stats" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"startDate\": \"2019-10-08\",
    \"endDate\": \"2106-07-12\",
    \"priority\": \"consequatur\",
    \"search\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/get/opportunities/stats"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "startDate": "2019-10-08",
    "endDate": "2106-07-12",
    "priority": "consequatur",
    "search": "consequatur"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/opportunities/stats

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

startDate   string  optional  

Must be a valid date in the format d-m-Y. Must be a date before or equal to endDate. Example: 2019-10-08

endDate   string  optional  

Must be a valid date in the format d-m-Y. Must be a date after or equal to startDate. Example: 2106-07-12

status   string  optional  

contact_id   string  optional  

The id of an existing record in the contacts table.

seller_id   string  optional  

The id of an existing record in the users table.

priority   string  optional  

Example: consequatur

search   string  optional  

Example: consequatur

GET api/v1/get/opportunities/forecast

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/opportunities/forecast" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"startDate\": \"2019-10-08\",
    \"endDate\": \"2106-07-12\",
    \"search\": \"consequatur\",
    \"year\": 17,
    \"priority\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/get/opportunities/forecast"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "startDate": "2019-10-08",
    "endDate": "2106-07-12",
    "search": "consequatur",
    "year": 17,
    "priority": "consequatur"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/opportunities/forecast

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

startDate   string  optional  

Must be a valid date in the format d-m-Y. Must be a date before or equal to endDate. Example: 2019-10-08

endDate   string  optional  

Must be a valid date in the format d-m-Y. Must be a date after or equal to startDate. Example: 2106-07-12

status   string  optional  

contact_id   string  optional  

The id of an existing record in the contacts table.

search   string  optional  

Example: consequatur

year   integer  optional  

Must be 4 digits. Example: 17

seller_id   string  optional  

The id of an existing record in the users table.

priority   string  optional  

Example: consequatur

office_id   string  optional  

The id of an existing record in the offices table.

GET api/v1/get/opportunities/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/opportunities/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/opportunities/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/opportunities/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/opportunities/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/opportunities/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"startDate\": \"2019-10-08\",
    \"endDate\": \"2106-07-12\",
    \"priority\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/get/opportunities/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "startDate": "2019-10-08",
    "endDate": "2106-07-12",
    "priority": "consequatur"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/opportunities/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

startDate   string  optional  

Must be a valid date in the format d-m-Y. Must be a date before or equal to endDate. Example: 2019-10-08

endDate   string  optional  

Must be a valid date in the format d-m-Y. Must be a date after or equal to startDate. Example: 2106-07-12

status   string  optional  

contact_id   string  optional  

The id of an existing record in the contacts table.

seller_id   string  optional  

The id of an existing record in the users table.

priority   string  optional  

Example: consequatur

office_id   string  optional  

The id of an existing record in the offices table.

GET api/v1/get/opportunities

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/opportunities" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/opportunities"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/opportunities

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/opportunity/{opportunity}/estimates/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/opportunity/consequatur/estimates/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/opportunity/consequatur/estimates/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/opportunity/{opportunity}/estimates/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

opportunity   string   

The opportunity. Example: consequatur

GET api/v1/get/opportunity/{opportunity}/invoices/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/opportunity/consequatur/invoices/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/opportunity/consequatur/invoices/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/opportunity/{opportunity}/invoices/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

opportunity   string   

The opportunity. Example: consequatur

GET api/v1/get/lost/opportunities/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/lost/opportunities/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"reason_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\"
}"

const url = new URL(
    "http://core.localhost/api/v1/get/lost/opportunities/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "reason_id": "66529e01-d113-3473-8d6f-9e11e09332ea"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/lost/opportunities/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

reason_id   string  optional  

Must be a valid UUID. The id of an existing record in the reasons table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

GET api/v1/get/opportunity/{opportunity}/activities

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/opportunity/consequatur/activities" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/opportunity/consequatur/activities"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/opportunity/{opportunity}/activities

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

opportunity   string   

The opportunity. Example: consequatur

GET api/v1/show/{opportunity}/opportunity

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/show/consequatur/opportunity" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/show/consequatur/opportunity"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/show/{opportunity}/opportunity

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

opportunity   string   

Example: consequatur

POST api/v1/store/opportunity

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/opportunity" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"expected_income\": 11613.31890586,
    \"opportunity_state_id\": \"57357f37-0ea3-38e5-8a6c-9de9d06e75fd\",
    \"closing_date\": \"2106-07-12\",
    \"status\": \"consequatur\",
    \"priority\": \"1\",
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"contact_id\": \"fefb079f-5b81-3552-831f-ed3f89669781\",
    \"collaborators\": [
        \"0d7cac1d-9cec-3d5a-9508-c7e30cc7b175\"
    ],
    \"seller_id\": \"07ec9c6e-821e-3e2f-9c04-4feb05e25e24\",
    \"tags\": [
        \"e15a9bfb-eace-33e3-89df-1a8cdec403e3\"
    ],
    \"creation_date\": \"2019-10-08\",
    \"opportunity_source_id\": \"98adc52b-966d-39db-809a-55902ee7228f\",
    \"products\": [
        \"d48a46b6-3a18-3763-951d-66b7fdb284ae\"
    ],
    \"files\": [
        \"pfuudtdsufvyvddqamnii\"
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/store/opportunity"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "expected_income": 11613.31890586,
    "opportunity_state_id": "57357f37-0ea3-38e5-8a6c-9de9d06e75fd",
    "closing_date": "2106-07-12",
    "status": "consequatur",
    "priority": "1",
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "contact_id": "fefb079f-5b81-3552-831f-ed3f89669781",
    "collaborators": [
        "0d7cac1d-9cec-3d5a-9508-c7e30cc7b175"
    ],
    "seller_id": "07ec9c6e-821e-3e2f-9c04-4feb05e25e24",
    "tags": [
        "e15a9bfb-eace-33e3-89df-1a8cdec403e3"
    ],
    "creation_date": "2019-10-08",
    "opportunity_source_id": "98adc52b-966d-39db-809a-55902ee7228f",
    "products": [
        "d48a46b6-3a18-3763-951d-66b7fdb284ae"
    ],
    "files": [
        "pfuudtdsufvyvddqamnii"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/opportunity

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

expected_income   number   

Example: 11613.31890586

opportunity_state_id   string   

Must be a valid UUID. The id of an existing record in the opportunity_states table. Example: 57357f37-0ea3-38e5-8a6c-9de9d06e75fd

closing_date   string  optional  

Must be a valid date in the format d-m-Y. Must be a date after creation_date. Example: 2106-07-12

status   string  optional  

Example: consequatur

priority   number  optional  

Example: 1

Must be one of:

• 0
• 1
• 2
• 3

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

contact_id   string   

Must be a valid UUID. The id of an existing record in the contacts table. Example: fefb079f-5b81-3552-831f-ed3f89669781

collaborators   string[]  optional  

Must be a valid UUID. The id of an existing record in the contacts table.

seller_id   string  optional  

Must be a valid UUID. The id of an existing record in the users table. Example: 07ec9c6e-821e-3e2f-9c04-4feb05e25e24

tags   string[]  optional  

Must be a valid UUID. The id of an existing record in the tags table.

creation_date   string  optional  

Must be a valid date in the format d-m-Y. Must be a date before closing_date. Example: 2019-10-08

opportunity_source_id   string  optional  

Must be a valid UUID. The id of an existing record in the opportunity_sources table. Example: 98adc52b-966d-39db-809a-55902ee7228f

products   string[]  optional  

Must be a valid UUID. The id of an existing record in the product_sale_elements table.

files   string[]  optional  

Must not be greater than 2048 characters.

PATCH api/v1/update/{opportunity}/opportunity

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/opportunity" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"expected_income\": 11613.31890586,
    \"opportunity_state_id\": \"57357f37-0ea3-38e5-8a6c-9de9d06e75fd\",
    \"closing_date\": \"2106-07-12\",
    \"status\": \"consequatur\",
    \"priority\": \"2\",
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"contact_id\": \"fefb079f-5b81-3552-831f-ed3f89669781\",
    \"collaborators\": [
        \"0d7cac1d-9cec-3d5a-9508-c7e30cc7b175\"
    ],
    \"seller_id\": \"07ec9c6e-821e-3e2f-9c04-4feb05e25e24\",
    \"tags\": [
        \"e15a9bfb-eace-33e3-89df-1a8cdec403e3\"
    ],
    \"creation_date\": \"2019-10-08\",
    \"opportunity_source_id\": \"98adc52b-966d-39db-809a-55902ee7228f\",
    \"products\": [
        \"d48a46b6-3a18-3763-951d-66b7fdb284ae\"
    ],
    \"files\": [
        \"pfuudtdsufvyvddqamnii\"
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/opportunity"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "expected_income": 11613.31890586,
    "opportunity_state_id": "57357f37-0ea3-38e5-8a6c-9de9d06e75fd",
    "closing_date": "2106-07-12",
    "status": "consequatur",
    "priority": "2",
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "contact_id": "fefb079f-5b81-3552-831f-ed3f89669781",
    "collaborators": [
        "0d7cac1d-9cec-3d5a-9508-c7e30cc7b175"
    ],
    "seller_id": "07ec9c6e-821e-3e2f-9c04-4feb05e25e24",
    "tags": [
        "e15a9bfb-eace-33e3-89df-1a8cdec403e3"
    ],
    "creation_date": "2019-10-08",
    "opportunity_source_id": "98adc52b-966d-39db-809a-55902ee7228f",
    "products": [
        "d48a46b6-3a18-3763-951d-66b7fdb284ae"
    ],
    "files": [
        "pfuudtdsufvyvddqamnii"
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{opportunity}/opportunity

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

opportunity   string   

Example: consequatur

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

expected_income   number   

Example: 11613.31890586

opportunity_state_id   string   

Must be a valid UUID. The id of an existing record in the opportunity_states table. Example: 57357f37-0ea3-38e5-8a6c-9de9d06e75fd

closing_date   string  optional  

Must be a valid date in the format d-m-Y. Must be a date after creation_date. Example: 2106-07-12

status   string  optional  

Example: consequatur

priority   number  optional  

Example: 2

Must be one of:

• 0
• 1
• 2
• 3

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

contact_id   string   

Must be a valid UUID. The id of an existing record in the contacts table. Example: fefb079f-5b81-3552-831f-ed3f89669781

collaborators   string[]  optional  

Must be a valid UUID. The id of an existing record in the contacts table.

seller_id   string  optional  

Must be a valid UUID. The id of an existing record in the users table. Example: 07ec9c6e-821e-3e2f-9c04-4feb05e25e24

tags   string[]  optional  

Must be a valid UUID. The id of an existing record in the tags table.

creation_date   string  optional  

Must be a valid date in the format d-m-Y. Must be a date before closing_date. Example: 2019-10-08

opportunity_source_id   string  optional  

Must be a valid UUID. The id of an existing record in the opportunity_sources table. Example: 98adc52b-966d-39db-809a-55902ee7228f

products   string[]  optional  

Must be a valid UUID. The id of an existing record in the product_sale_elements table.

files   string[]  optional  

Must not be greater than 2048 characters.

POST api/v1/duplicate/{opportunity}/opportunity

Example request:

curl --request POST \
    "http://core.localhost/api/v1/duplicate/consequatur/opportunity" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/duplicate/consequatur/opportunity"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/duplicate/{opportunity}/opportunity

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

opportunity   string   

Example: consequatur

DELETE api/v1/delete/{opportunity}/opportunity

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/opportunity" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/opportunity"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{opportunity}/opportunity

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

opportunity   string   

Example: consequatur

GET api/v1/get/sellers

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/sellers" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/sellers"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/sellers

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/export/opportunities

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/export/opportunities" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/export/opportunities"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/export/opportunities

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

PATCH api/v1/update/opportunity/{opportunity}/status

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/opportunity/consequatur/status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/update/opportunity/consequatur/status"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/opportunity/{opportunity}/status

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

opportunity   string   

The opportunity. Example: consequatur

PATCH api/v1/archive/opportunity/{opportunity}

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/archive/opportunity/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/archive/opportunity/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/archive/opportunity/{opportunity}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

opportunity   string   

The opportunity. Example: consequatur

PATCH api/v1/won/opportunity/{opportunity}

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/won/opportunity/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/won/opportunity/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/won/opportunity/{opportunity}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

opportunity   string   

The opportunity. Example: consequatur

POST api/v1/set/opportunity/{opportunity}/lost/status

Example request:

curl --request POST \
    "http://core.localhost/api/v1/set/opportunity/consequatur/lost/status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"opportunity_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"reason_id\": \"fa010f60-df29-3f05-8bc7-bed48f550d13\",
    \"loss_motif\": \"opfuudtdsufvyvddqamni\",
    \"date\": \"12-06-2025\"
}"

const url = new URL(
    "http://core.localhost/api/v1/set/opportunity/consequatur/lost/status"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "opportunity_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "reason_id": "fa010f60-df29-3f05-8bc7-bed48f550d13",
    "loss_motif": "opfuudtdsufvyvddqamni",
    "date": "12-06-2025"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/set/opportunity/{opportunity}/lost/status

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

opportunity   string   

The opportunity. Example: consequatur

Body Parameters

opportunity_id   string   

Must be a valid UUID. The id of an existing record in the opportunities table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

reason_id   string   

Must be a valid UUID. The id of an existing record in the reasons table. Example: fa010f60-df29-3f05-8bc7-bed48f550d13

loss_motif   string  optional  

Must not be greater than 255 characters. Example: opfuudtdsufvyvddqamni

date   string  optional  

Must be a valid date in the format d-m-Y. Example: 12-06-2025

PATCH api/v1/change/opportunity/{opportunity}/state

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/change/opportunity/consequatur/state" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/change/opportunity/consequatur/state"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/change/opportunity/{opportunity}/state

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

opportunity   string   

The opportunity. Example: consequatur

POST api/v1/add/opportunity/{opportunity}/feeling

Example request:

curl --request POST \
    "http://core.localhost/api/v1/add/opportunity/consequatur/feeling" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/add/opportunity/consequatur/feeling"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/add/opportunity/{opportunity}/feeling

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

opportunity   string   

The opportunity. Example: consequatur

POST api/v1/add/opportunity/{opportunity}/followers

Example request:

curl --request POST \
    "http://core.localhost/api/v1/add/opportunity/consequatur/followers" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/add/opportunity/consequatur/followers"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/add/opportunity/{opportunity}/followers

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

opportunity   string   

The opportunity. Example: consequatur

DELETE api/v1/delete/opportunity/{opportunity}/follower

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/opportunity/consequatur/follower" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/opportunity/consequatur/follower"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/opportunity/{opportunity}/follower

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

opportunity   string   

The opportunity. Example: consequatur

POST api/v1/upload/opportunity/{opportunity}/files

Example request:

curl --request POST \
    "http://core.localhost/api/v1/upload/opportunity/consequatur/files" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/upload/opportunity/consequatur/files"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/upload/opportunity/{opportunity}/files

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

opportunity   string   

The opportunity. Example: consequatur

DELETE api/v1/delete/opportunity/{file}/file

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/opportunity/consequatur/file" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/opportunity/consequatur/file"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/opportunity/{file}/file

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

file   string   

Example: consequatur

PATCH api/v1/set/opportunity/{opportunity}/prospect

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/set/opportunity/consequatur/prospect" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/set/opportunity/consequatur/prospect"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/set/opportunity/{opportunity}/prospect

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

opportunity   string   

The opportunity. Example: consequatur

POST api/v1/add/opportunity/{opportunity}/collaborators

Example request:

curl --request POST \
    "http://core.localhost/api/v1/add/opportunity/consequatur/collaborators" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/add/opportunity/consequatur/collaborators"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/add/opportunity/{opportunity}/collaborators

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

opportunity   string   

The opportunity. Example: consequatur

DELETE api/v1/delete/opportunity/{opportunity}/collaborators

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/opportunity/consequatur/collaborators" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/opportunity/consequatur/collaborators"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/opportunity/{opportunity}/collaborators

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

opportunity   string   

The opportunity. Example: consequatur

POST api/v1/store/activity

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/activity" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"opportunity_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"type_activity_id\": \"fa010f60-df29-3f05-8bc7-bed48f550d13\",
    \"files\": [
        \"opfuudtdsufvyvddqamni\"
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/store/activity"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "opportunity_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "type_activity_id": "fa010f60-df29-3f05-8bc7-bed48f550d13",
    "files": [
        "opfuudtdsufvyvddqamni"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/activity

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

opportunity_id   string   

Must be a valid UUID. The id of an existing record in the opportunities table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

type_activity_id   string   

Must be a valid UUID. The id of an existing record in the type_activities table. Example: fa010f60-df29-3f05-8bc7-bed48f550d13

files   string[]  optional  

Must not be greater than 2048 characters.

PATCH api/v1/update/{activity}/activity

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/activity" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"activity_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"files\": [
        \"qeopfuudtdsufvyvddqam\"
    ],
    \"detach_files\": [
        \"1915c795-5d1c-3def-965b-5abe034dd150\"
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/activity"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "activity_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "files": [
        "qeopfuudtdsufvyvddqam"
    ],
    "detach_files": [
        "1915c795-5d1c-3def-965b-5abe034dd150"
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{activity}/activity

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

activity   string   

Example: consequatur

Body Parameters

activity_id   string   

Must be a valid UUID. The id of an existing record in the activities table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

files   string[]  optional  

Must not be greater than 2048 characters.

detach_files   string[]  optional  

Must be a valid UUID. The id of an existing record in the activity_files table.

DELETE api/v1/delete/{activity}/activity

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/activity" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/activity"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{activity}/activity

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

activity   string   

Example: consequatur

GET api/v1/get/opportunities/percentage-by-source

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/opportunities/percentage-by-source" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/opportunities/percentage-by-source"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/opportunities/percentage-by-source

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/opportunities/count/statistics

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/opportunities/count/statistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/opportunities/count/statistics"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/opportunities/count/statistics

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/salesTargets/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/salesTargets/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/salesTargets/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/salesTargets/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/currentSalesTarget

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/currentSalesTarget" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/currentSalesTarget"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/currentSalesTarget

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/salesTarget

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/salesTarget" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"start_date\": \"12-06-2025\",
    \"end_date\": \"2106-07-12\",
    \"target_amount\": 45
}"

const url = new URL(
    "http://core.localhost/api/v1/store/salesTarget"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "start_date": "12-06-2025",
    "end_date": "2106-07-12",
    "target_amount": 45
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/salesTarget

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

start_date   string   

Must be a valid date in the format d-m-Y. Example: 12-06-2025

end_date   string   

Must be a valid date in the format d-m-Y. Must be a date after or equal to start_date. Example: 2106-07-12

target_amount   number   

Must be at least 1. Example: 45

GET api/v1/get/opportunities/priority/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/opportunities/priority/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/opportunities/priority/enum"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/opportunities/priority/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/opportunities/status/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/opportunities/status/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/opportunities/status/enum"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/opportunities/status/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/emailActivity/type/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/emailActivity/type/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/emailActivity/type/enum"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/emailActivity/type/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/callActivity/type/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/callActivity/type/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/callActivity/type/enum"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/callActivity/type/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/activity/icon

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/activity/icon" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/activity/icon"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/activity/icon

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/feeling/icon

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/feeling/icon" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/feeling/icon"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/feeling/icon

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/activity/remind/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/activity/remind/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/activity/remind/enum"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/activity/remind/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

PATCH api/v1/set/opportunity/{opportunity}/criterias

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/set/opportunity/consequatur/criterias" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/set/opportunity/consequatur/criterias"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/set/opportunity/{opportunity}/criterias

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

opportunity   string   

The opportunity. Example: consequatur

GET api/v1/get/postoffices/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/postoffices/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/postoffices/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/postoffices/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/postoffices/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/postoffices/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/postoffices/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/postoffices/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/postoffice

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/postoffice" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/postoffice"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/postoffice

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

PATCH api/v1/update/{postoffice}/postoffice

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/postoffice" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/postoffice"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{postoffice}/postoffice

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

postoffice   string   

Example: consequatur

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

DELETE api/v1/delete/{postoffice}/postoffice

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/postoffice" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/postoffice"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{postoffice}/postoffice

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

postoffice   string   

Example: consequatur

GET api/v1/get/taxes/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/taxes/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/taxes/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/taxes/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/taxes/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/taxes/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/taxes/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/taxes/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/taxe

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/taxe" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/store/taxe"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/taxe

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

PATCH api/v1/update/{taxe}/taxe

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/taxe" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/taxe"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{taxe}/taxe

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

taxe   string   

Example: consequatur

DELETE api/v1/delete/{taxe}/taxe

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/taxe" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/taxe"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{taxe}/taxe

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

taxe   string   

Example: consequatur

POST api/v1/store/taxe/shop

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/taxe/shop" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/store/taxe/shop"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/taxe/shop

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

PATCH api/v1/update/{taxe}/taxe/shop

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/taxe/shop" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/taxe/shop"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{taxe}/taxe/shop

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

taxe   string   

Example: consequatur

GET api/v1/get/{shopId}/taxe/collection/shop

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/taxe/collection/shop" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/taxe/collection/shop"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{shopId}/taxe/collection/shop

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shopId   string   

Example: consequatur

GET api/v1/get/categories/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/categories/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/categories/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/categories/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/categories/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/categories/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/categories/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/categories/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/category

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/category" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=vmqeopfuudtdsufvyvddq"\
    --form "categories[]=462ee709-6d9f-345a-95e6-76f833111fb8"\
    --form "image=@/tmp/php6qBS0B" 

const url = new URL(
    "http://core.localhost/api/v1/store/category"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('name', 'vmqeopfuudtdsufvyvddq');
body.append('categories[]', '462ee709-6d9f-345a-95e6-76f833111fb8');
body.append('image', document.querySelector('input[name="image"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/category

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

categories   string[]   

The id of an existing record in the categories table. Must be a valid UUID.

image   file  optional  

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/php6qBS0B

PATCH api/v1/update/{category}/category

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/category" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/category"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{category}/category

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

category   string   

Example: consequatur

DELETE api/v1/delete/{category}/category

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/category" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/category"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{category}/category

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

category   string   

Example: consequatur

POST api/v1/store/category/shop

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/category/shop" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=vmqeopfuudtdsufvyvddq"\
    --form "categories[]=462ee709-6d9f-345a-95e6-76f833111fb8"\
    --form "module_id=1915c795-5d1c-3def-965b-5abe034dd150"\
    --form "image=@/tmp/phpgE8QfX" 

const url = new URL(
    "http://core.localhost/api/v1/store/category/shop"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('name', 'vmqeopfuudtdsufvyvddq');
body.append('categories[]', '462ee709-6d9f-345a-95e6-76f833111fb8');
body.append('module_id', '1915c795-5d1c-3def-965b-5abe034dd150');
body.append('image', document.querySelector('input[name="image"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/category/shop

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

categories   string[]   

Must be a valid UUID. The id of an existing record in the categories table.

image   file  optional  

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/phpgE8QfX

module_id   string   

Must be a valid UUID. The id of an existing record in the shops table. Example: 1915c795-5d1c-3def-965b-5abe034dd150

PATCH api/v1/update/{category}/category/shop

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/category/shop" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/category/shop"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{category}/category/shop

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

category   string   

Example: consequatur

GET api/v1/get/{shopId}/categories/collection/shop

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/categories/collection/shop" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/categories/collection/shop"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{shopId}/categories/collection/shop

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shopId   string   

Example: consequatur

GET api/v1/get/attributs/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/attributs/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/attributs/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/attributs/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/attributs/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/attributs/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/attributs/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/attributs/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/attribut

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/attribut" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"variation\": [
        \"amniihfqcoynlazghdtqt\"
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/store/attribut"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "variation": [
        "amniihfqcoynlazghdtqt"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/attribut

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

variation   string[]  optional  

Must not be greater than 255 characters.

POST api/v1/store/{attribut}/attribut/value

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/consequatur/attribut/value" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/store/consequatur/attribut/value"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/{attribut}/attribut/value

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

attribut   string   

Example: consequatur

PATCH api/v1/update/{attribut}/attribut

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/attribut" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/attribut"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{attribut}/attribut

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

attribut   string   

Example: consequatur

DELETE api/v1/delete/{attribut}/attribut

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/attribut" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/attribut"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{attribut}/attribut

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

attribut   string   

Example: consequatur

GET api/v1/get/variations/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/variations/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/variations/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/variations/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/variation

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/variation" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"attribut_id\": \"462ee709-6d9f-345a-95e6-76f833111fb8\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/variation"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "attribut_id": "462ee709-6d9f-345a-95e6-76f833111fb8"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/variation

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

attribut_id   string   

Must be a valid UUID. The id of an existing record in the attributs table. Example: 462ee709-6d9f-345a-95e6-76f833111fb8

PATCH api/v1/update/{variation}/variation

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/variation" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/variation"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{variation}/variation

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

variation   string   

Example: consequatur

DELETE api/v1/delete/{variation}/variation

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/variation" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/variation"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{variation}/variation

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

variation   string   

Example: consequatur

GET api/v1/get/brands/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/brands/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/brands/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/brands/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/brands/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/brands/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/brands/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/brands/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/brand

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/brand" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/brand"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/brand

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

society_id   string  optional  

PATCH api/v1/update/{brand}/brand

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/brand" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"brand\": \"amniihfqcoynlazghdtqt\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/brand"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "brand": "amniihfqcoynlazghdtqt"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{brand}/brand

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

brand   string   

Example: consequatur

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

brand   string   

Must be a valid UUID. The id of an existing record in the brands table. Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

DELETE api/v1/delete/{brand}/brand

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/brand" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/brand"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{brand}/brand

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

brand   string   

Example: consequatur

GET api/v1/get/products/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/products/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/products/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/products/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/products/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/products/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/products/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/products/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/product

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/product" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"reference\": \"consequatur\",
    \"name\": \"consequatur\",
    \"category\": \"98adc52b-966d-39db-809a-55902ee7228f\",
    \"purchase_price\": 11613.31890586,
    \"selling_price\": 11613.31890586,
    \"brand\": \"57357f37-0ea3-38e5-8a6c-9de9d06e75fd\",
    \"type\": \"PRODUCT\",
    \"online\": false,
    \"product\": \"c2cdda66-81e5-3060-a4eb-049b4a810d76\",
    \"barcode\": \"udtdsufvyvddqamniihfq\",
    \"attributs\": [
        {
            \"attribut_id\": \"5d4370ba-0848-31e1-880d-fcbc1539481f\",
            \"variations\": [
                \"b2c92958-c8e7-31ab-9c7f-a3df5ef452a9\"
            ]
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/store/product"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "reference": "consequatur",
    "name": "consequatur",
    "category": "98adc52b-966d-39db-809a-55902ee7228f",
    "purchase_price": 11613.31890586,
    "selling_price": 11613.31890586,
    "brand": "57357f37-0ea3-38e5-8a6c-9de9d06e75fd",
    "type": "PRODUCT",
    "online": false,
    "product": "c2cdda66-81e5-3060-a4eb-049b4a810d76",
    "barcode": "udtdsufvyvddqamniihfq",
    "attributs": [
        {
            "attribut_id": "5d4370ba-0848-31e1-880d-fcbc1539481f",
            "variations": [
                "b2c92958-c8e7-31ab-9c7f-a3df5ef452a9"
            ]
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/product

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

reference   string   

Example: consequatur

name   string   

Example: consequatur

category   string   

Must be a valid UUID. The id of an existing record in the categories table. Example: 98adc52b-966d-39db-809a-55902ee7228f

purchase_price   number   

Example: 11613.31890586

selling_price   number   

Example: 11613.31890586

brand   string  optional  

Must be a valid UUID. The id of an existing record in the brands table. Example: 57357f37-0ea3-38e5-8a6c-9de9d06e75fd

type   string   

Example: PRODUCT

Must be one of:

• PRODUCT
• SERVICE

attributs   object[]  optional  

attribut_id   string  optional  

Must be a valid UUID. The id of an existing record in the attributs table. Example: 5d4370ba-0848-31e1-880d-fcbc1539481f

variations   string[]  optional  

Must be a valid UUID. The id of an existing record in the variations table.

online   boolean    true false

Example: false

product   string  optional  

Must be a valid UUID. The id of an existing record in the products table. Example: c2cdda66-81e5-3060-a4eb-049b4a810d76

taxes   string[]  optional  

The id of an existing record in the taxes table.

barcode   string  optional  

Must be at least 8 characters. Must not be greater than 128 characters. Example: udtdsufvyvddqamniihfq

POST api/v1/store/product/variations

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/product/variations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/store/product/variations"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/product/variations

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/product/upload-avatar

Example request:

curl --request POST \
    "http://core.localhost/api/v1/product/upload-avatar" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/product/upload-avatar"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/product/upload-avatar

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/product/{product}/details

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/product/consequatur/details" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/product/consequatur/details"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/product/{product}/details

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

product   string   

The product. Example: consequatur

GET api/v1/get/all/productSaleElements/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/all/productSaleElements/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/all/productSaleElements/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/all/productSaleElements/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/category/upload-image

Example request:

curl --request POST \
    "http://core.localhost/api/v1/category/upload-image" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/category/upload-image"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/category/upload-image

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/productSaleElements/update

Example request:

curl --request POST \
    "http://core.localhost/api/v1/productSaleElements/update" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/productSaleElements/update"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/productSaleElements/update

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

DELETE api/v1/productSaleElement/{productSaleElement}/product/{product}/delete

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/productSaleElement/consequatur/product/consequatur/delete" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/productSaleElement/consequatur/product/consequatur/delete"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/productSaleElement/{productSaleElement}/product/{product}/delete

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

productSaleElement   string   

The productSaleElement. Example: consequatur

product   string   

The product. Example: consequatur

DELETE api/v1/productSaleElements/product/{product}/delete

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/productSaleElements/product/consequatur/delete" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/productSaleElements/product/consequatur/delete"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/productSaleElements/product/{product}/delete

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

product   string   

The product. Example: consequatur

DELETE api/v1/product/{product}/delete

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/product/consequatur/delete" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/product/consequatur/delete"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/product/{product}/delete

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

product   string   

The product. Example: consequatur

GET api/v1/download-product-model

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/download-product-model" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/download-product-model"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/download-product-model

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/import/products

Example request:

curl --request POST \
    "http://core.localhost/api/v1/import/products" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/import/products"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/import/products

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/export/products

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/export/products" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/export/products"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/export/products

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/productSaleElements/by/products

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/productSaleElements/by/products" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/productSaleElements/by/products"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/productSaleElements/by/products

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/productSaleElements/groupBy/category

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/productSaleElements/groupBy/category" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/productSaleElements/groupBy/category"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/productSaleElements/groupBy/category

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/products/groupBy/category

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/products/groupBy/category" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/products/groupBy/category"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/products/groupBy/category

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/product/type/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/product/type/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/product/type/enum"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/product/type/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/discount/type/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/discount/type/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/discount/type/enum"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/discount/type/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/projects

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/projects" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/projects"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/projects

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/projects/category/groups/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/projects/category/groups/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/projects/category/groups/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/projects/category/groups/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/projects/category/groups/datatable

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/projects/category/groups/datatable" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/projects/category/groups/datatable"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/projects/category/groups/datatable

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/projects/category/groups

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/projects/category/groups" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/store/projects/category/groups"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/projects/category/groups

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

PATCH api/v1/update/{categoryGroup}/projects/category/groups

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/projects/category/groups" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/projects/category/groups"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{categoryGroup}/projects/category/groups

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

categoryGroup   string   

Example: consequatur

GET api/v1/get/{categoryGroup}/projects/category/groups

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/projects/category/groups" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/projects/category/groups"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{categoryGroup}/projects/category/groups

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

categoryGroup   string   

Example: consequatur

DELETE api/v1/delete/{categoryGroup_id}/projects/category/groups

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/projects/category/groups" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/projects/category/groups"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{categoryGroup_id}/projects/category/groups

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

categoryGroup_id   string   

The ID of the categoryGroup. Example: consequatur

GET api/v1/get/projects/categories/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/projects/categories/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/projects/categories/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/projects/categories/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/projects/categories/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/projects/categories/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/projects/categories/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/projects/categories/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/project/category

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/project/category" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"description\": \"Dolores molestias ipsam sit.\",
    \"color\": \"hfqcoynlazghdtqtqxbaj\",
    \"project_category_group_id\": \"6014938f-4620-3891-98c2-feef003bc1ba\",
    \"prefix\": \"pilpmufin\",
    \"length\": 5,
    \"configs\": [
        {
            \"milestone_category_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
            \"milestone_categories_progress\": 16,
            \"delay_value\": 11613.31890586,
            \"delay_unit\": \"consequatur\",
            \"status\": [
                \"consequatur\"
            ],
            \"tasks\": [
                {
                    \"id\": \"98adc52b-966d-39db-809a-55902ee7228f\",
                    \"title\": \"consequatur\",
                    \"task_priority_id\": \"98adc52b-966d-39db-809a-55902ee7228f\",
                    \"milestone_categories_progress\": 5,
                    \"delay_value\": 11613.31890586,
                    \"need_review\": false,
                    \"delay_unit\": \"consequatur\",
                    \"delay_value_alert\": 11613.31890586,
                    \"delay_unit_alert\": \"consequatur\",
                    \"delay_value_critical\": 11613.31890586,
                    \"delay_unit_critical\": \"consequatur\",
                    \"checklists\": [
                        {
                            \"id\": \"98adc52b-966d-39db-809a-55902ee7228f\",
                            \"title\": \"consequatur\",
                            \"delay_value\": 11613.31890586,
                            \"delay_unit\": \"consequatur\",
                            \"delay_value_alert\": 11613.31890586,
                            \"delay_unit_alert\": \"consequatur\",
                            \"delay_value_critical\": 11613.31890586,
                            \"delay_unit_critical\": \"consequatur\"
                        }
                    ]
                }
            ]
        }
    ],
    \"tables\": [
        {
            \"name\": \"consequatur\",
            \"columns\": [
                {
                    \"name\": \"consequatur\"
                }
            ]
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/store/project/category"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "description": "Dolores molestias ipsam sit.",
    "color": "hfqcoynlazghdtqtqxbaj",
    "project_category_group_id": "6014938f-4620-3891-98c2-feef003bc1ba",
    "prefix": "pilpmufin",
    "length": 5,
    "configs": [
        {
            "milestone_category_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
            "milestone_categories_progress": 16,
            "delay_value": 11613.31890586,
            "delay_unit": "consequatur",
            "status": [
                "consequatur"
            ],
            "tasks": [
                {
                    "id": "98adc52b-966d-39db-809a-55902ee7228f",
                    "title": "consequatur",
                    "task_priority_id": "98adc52b-966d-39db-809a-55902ee7228f",
                    "milestone_categories_progress": 5,
                    "delay_value": 11613.31890586,
                    "need_review": false,
                    "delay_unit": "consequatur",
                    "delay_value_alert": 11613.31890586,
                    "delay_unit_alert": "consequatur",
                    "delay_value_critical": 11613.31890586,
                    "delay_unit_critical": "consequatur",
                    "checklists": [
                        {
                            "id": "98adc52b-966d-39db-809a-55902ee7228f",
                            "title": "consequatur",
                            "delay_value": 11613.31890586,
                            "delay_unit": "consequatur",
                            "delay_value_alert": 11613.31890586,
                            "delay_unit_alert": "consequatur",
                            "delay_value_critical": 11613.31890586,
                            "delay_unit_critical": "consequatur"
                        }
                    ]
                }
            ]
        }
    ],
    "tables": [
        {
            "name": "consequatur",
            "columns": [
                {
                    "name": "consequatur"
                }
            ]
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/project/category

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

description   string  optional  

Must not be greater than 255 characters. Example: Dolores molestias ipsam sit.

color   string  optional  

Must not be greater than 255 characters. Example: hfqcoynlazghdtqtqxbaj

project_category_group_id   string  optional  

Must be a valid UUID. The id of an existing record in the project_category_groups table. Example: 6014938f-4620-3891-98c2-feef003bc1ba

prefix   string  optional  

Must not be greater than 10 characters. Example: pilpmufin

length   integer  optional  

Must be at least 1. Must not be greater than 10. Example: 5

configs   object[]   

milestone_category_id   string   

Must be a valid UUID. The id of an existing record in the milestone_categories table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

milestone_categories_progress   number  optional  

Must be at least 1. Must not be greater than 100. Example: 16

delay_value   number  optional  

Example: 11613.31890586

delay_unit   string  optional  

Example: consequatur

Must be one of:

• minutes
• hours
• day
• week
• month

status   string[]  optional  

The id of an existing record in the task_statuses table.

tasks   object[]  optional  

id   string  optional  

Must be a valid UUID. The id of an existing record in the milestone_tasks table. Example: 98adc52b-966d-39db-809a-55902ee7228f

title   string   

Example: consequatur

task_priority_id   string   

Must be a valid UUID. The id of an existing record in the task_priorities table. Example: 98adc52b-966d-39db-809a-55902ee7228f

milestone_categories_progress   number  optional  

Must be at least 1. Must not be greater than 100. Example: 5

delay_value   number  optional  

Example: 11613.31890586

need_review   boolean  optional   true false

Example: false

delay_unit   string  optional  

Example: consequatur

Must be one of:

• minutes
• hours
• day
• week
• month

delay_value_alert   number  optional  

Example: 11613.31890586

delay_unit_alert   string  optional  

Example: consequatur

Must be one of:

• minutes
• hours
• day
• week
• month

delay_value_critical   number  optional  

Example: 11613.31890586

delay_unit_critical   string  optional  

Example: consequatur

Must be one of:

• minutes
• hours
• day
• week
• month

checklists   object[]  optional  

id   string  optional  

Must be a valid UUID. The id of an existing record in the milestone_task_checklists table. Example: 98adc52b-966d-39db-809a-55902ee7228f

title   string   

Example: consequatur

delay_value   number  optional  

Example: 11613.31890586

delay_unit   string  optional  

Example: consequatur

Must be one of:

• minutes
• hours
• day
• week
• month

delay_value_alert   number  optional  

Example: 11613.31890586

delay_unit_alert   string  optional  

Example: consequatur

Must be one of:

• minutes
• hours
• day
• week
• month

delay_value_critical   number  optional  

Example: 11613.31890586

delay_unit_critical   string  optional  

Example: consequatur

Must be one of:

• minutes
• hours
• day
• week
• month

tables   object[]  optional  

name   string   

Example: consequatur

columns   object[]   

name   string   

Example: consequatur

GET api/v1/show/{projectCategory_id}/project/category

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/show/consequatur/project/category" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/show/consequatur/project/category"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/show/{projectCategory_id}/project/category

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

projectCategory_id   string   

The ID of the projectCategory. Example: consequatur

PATCH api/v1/update/{projectCategory_id}/project/category

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/project/category" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"description\": \"Dolores molestias ipsam sit.\",
    \"color\": \"hfqcoynlazghdtqtqxbaj\",
    \"project_category_group_id\": \"6014938f-4620-3891-98c2-feef003bc1ba\",
    \"prefix\": \"pilpmufin\",
    \"length\": 5,
    \"configs\": [
        {
            \"milestone_category_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
            \"milestone_categories_progress\": 16,
            \"delay_value\": 11613.31890586,
            \"delay_unit\": \"consequatur\",
            \"status\": [
                \"consequatur\"
            ],
            \"tasks\": [
                {
                    \"id\": \"98adc52b-966d-39db-809a-55902ee7228f\",
                    \"title\": \"consequatur\",
                    \"task_priority_id\": \"98adc52b-966d-39db-809a-55902ee7228f\",
                    \"milestone_categories_progress\": 5,
                    \"delay_value\": 11613.31890586,
                    \"need_review\": true,
                    \"delay_unit\": \"consequatur\",
                    \"delay_value_alert\": 11613.31890586,
                    \"delay_unit_alert\": \"consequatur\",
                    \"delay_value_critical\": 11613.31890586,
                    \"delay_unit_critical\": \"consequatur\",
                    \"checklists\": [
                        {
                            \"id\": \"98adc52b-966d-39db-809a-55902ee7228f\",
                            \"title\": \"consequatur\",
                            \"delay_value\": 11613.31890586,
                            \"delay_unit\": \"consequatur\",
                            \"delay_value_alert\": 11613.31890586,
                            \"delay_unit_alert\": \"consequatur\",
                            \"delay_value_critical\": 11613.31890586,
                            \"delay_unit_critical\": \"consequatur\"
                        }
                    ]
                }
            ]
        }
    ],
    \"tables\": [
        {
            \"name\": \"consequatur\",
            \"columns\": [
                {
                    \"name\": \"consequatur\"
                }
            ]
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/project/category"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "description": "Dolores molestias ipsam sit.",
    "color": "hfqcoynlazghdtqtqxbaj",
    "project_category_group_id": "6014938f-4620-3891-98c2-feef003bc1ba",
    "prefix": "pilpmufin",
    "length": 5,
    "configs": [
        {
            "milestone_category_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
            "milestone_categories_progress": 16,
            "delay_value": 11613.31890586,
            "delay_unit": "consequatur",
            "status": [
                "consequatur"
            ],
            "tasks": [
                {
                    "id": "98adc52b-966d-39db-809a-55902ee7228f",
                    "title": "consequatur",
                    "task_priority_id": "98adc52b-966d-39db-809a-55902ee7228f",
                    "milestone_categories_progress": 5,
                    "delay_value": 11613.31890586,
                    "need_review": true,
                    "delay_unit": "consequatur",
                    "delay_value_alert": 11613.31890586,
                    "delay_unit_alert": "consequatur",
                    "delay_value_critical": 11613.31890586,
                    "delay_unit_critical": "consequatur",
                    "checklists": [
                        {
                            "id": "98adc52b-966d-39db-809a-55902ee7228f",
                            "title": "consequatur",
                            "delay_value": 11613.31890586,
                            "delay_unit": "consequatur",
                            "delay_value_alert": 11613.31890586,
                            "delay_unit_alert": "consequatur",
                            "delay_value_critical": 11613.31890586,
                            "delay_unit_critical": "consequatur"
                        }
                    ]
                }
            ]
        }
    ],
    "tables": [
        {
            "name": "consequatur",
            "columns": [
                {
                    "name": "consequatur"
                }
            ]
        }
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{projectCategory_id}/project/category

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

projectCategory_id   string   

The ID of the projectCategory. Example: consequatur

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

description   string  optional  

Must not be greater than 255 characters. Example: Dolores molestias ipsam sit.

color   string  optional  

Must not be greater than 255 characters. Example: hfqcoynlazghdtqtqxbaj

project_category_group_id   string  optional  

Must be a valid UUID. The id of an existing record in the project_category_groups table. Example: 6014938f-4620-3891-98c2-feef003bc1ba

prefix   string  optional  

Must not be greater than 10 characters. Example: pilpmufin

length   integer  optional  

Must be at least 1. Must not be greater than 10. Example: 5

configs   object[]   

milestone_category_id   string   

Must be a valid UUID. The id of an existing record in the milestone_categories table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

milestone_categories_progress   number  optional  

Must be at least 1. Must not be greater than 100. Example: 16

delay_value   number  optional  

Example: 11613.31890586

delay_unit   string  optional  

Example: consequatur

Must be one of:

• minutes
• hours
• day
• week
• month

status   string[]  optional  

The id of an existing record in the task_statuses table.

tasks   object[]  optional  

id   string  optional  

Must be a valid UUID. The id of an existing record in the milestone_tasks table. Example: 98adc52b-966d-39db-809a-55902ee7228f

title   string   

Example: consequatur

task_priority_id   string   

Must be a valid UUID. The id of an existing record in the task_priorities table. Example: 98adc52b-966d-39db-809a-55902ee7228f

milestone_categories_progress   number  optional  

Must be at least 1. Must not be greater than 100. Example: 5

delay_value   number  optional  

Example: 11613.31890586

need_review   boolean  optional   true false

Example: true

delay_unit   string  optional  

Example: consequatur

Must be one of:

• minutes
• hours
• day
• week
• month

delay_value_alert   number  optional  

Example: 11613.31890586

delay_unit_alert   string  optional  

Example: consequatur

Must be one of:

• minutes
• hours
• day
• week
• month

delay_value_critical   number  optional  

Example: 11613.31890586

delay_unit_critical   string  optional  

Example: consequatur

Must be one of:

• minutes
• hours
• day
• week
• month

checklists   object[]  optional  

id   string  optional  

Must be a valid UUID. The id of an existing record in the milestone_task_checklists table. Example: 98adc52b-966d-39db-809a-55902ee7228f

title   string   

Example: consequatur

delay_value   number  optional  

Example: 11613.31890586

delay_unit   string  optional  

Example: consequatur

Must be one of:

• minutes
• hours
• day
• week
• month

delay_value_alert   number  optional  

Example: 11613.31890586

delay_unit_alert   string  optional  

Example: consequatur

Must be one of:

• minutes
• hours
• day
• week
• month

delay_value_critical   number  optional  

Example: 11613.31890586

delay_unit_critical   string  optional  

Example: consequatur

Must be one of:

• minutes
• hours
• day
• week
• month

tables   object[]  optional  

name   string   

Example: consequatur

columns   object[]   

name   string   

Example: consequatur

DELETE api/v1/delete/{projectCategory_id}/project/category

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/project/category" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/project/category"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{projectCategory_id}/project/category

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

projectCategory_id   string   

The ID of the projectCategory. Example: consequatur

GET api/v1/get/project/alert

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/project/alert" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/project/alert"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/project/alert

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/project/alert

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/project/alert" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"delay_value_alert\": 17,
    \"delay_unit_alert\": \"consequatur\",
    \"delay_value_critical\": 17,
    \"delay_unit_critical\": \"consequatur\",
    \"society_id\": \"98adc52b-966d-39db-809a-55902ee7228f\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/project/alert"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "delay_value_alert": 17,
    "delay_unit_alert": "consequatur",
    "delay_value_critical": 17,
    "delay_unit_critical": "consequatur",
    "society_id": "98adc52b-966d-39db-809a-55902ee7228f"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/project/alert

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

delay_value_alert   integer   

Example: 17

delay_unit_alert   string  optional  

This field is required when delay_value_alert is present. Example: consequatur

Must be one of:

• minutes
• hours
• day
• week
• month

delay_value_critical   integer   

Example: 17

delay_unit_critical   string  optional  

This field is required when delay_value_critical is present. Example: consequatur

Must be one of:

• minutes
• hours
• day
• week
• month

society_id   string   

Must be a valid UUID. The id of an existing record in the societies table. Example: 98adc52b-966d-39db-809a-55902ee7228f

GET api/v1/project/{project_id}/category/step/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/project/consequatur/category/step/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/project/consequatur/category/step/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/project/{project_id}/category/step/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project_id   string   

The ID of the project. Example: consequatur

GET api/v1/project/{project_id}/category/step/with/taskCount

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/project/consequatur/category/step/with/taskCount" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/project/consequatur/category/step/with/taskCount"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/project/{project_id}/category/step/with/taskCount

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project_id   string   

The ID of the project. Example: consequatur

POST api/v1/store/project/{project}/category/step

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/project/consequatur/category/step" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"milestone_category_id\": \"consequatur\",
    \"default\": false,
    \"color\": \"mqeopfuudtdsufvyvddqa\",
    \"milestone_categories_progress\": 13,
    \"society_id\": \"consequatur\",
    \"delay_value\": 11613.31890586,
    \"delay_unit\": \"consequatur\",
    \"project_id\": \"98adc52b-966d-39db-809a-55902ee7228f\",
    \"forecast_budget\": 16
}"

const url = new URL(
    "http://core.localhost/api/v1/store/project/consequatur/category/step"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "milestone_category_id": "consequatur",
    "default": false,
    "color": "mqeopfuudtdsufvyvddqa",
    "milestone_categories_progress": 13,
    "society_id": "consequatur",
    "delay_value": 11613.31890586,
    "delay_unit": "consequatur",
    "project_id": "98adc52b-966d-39db-809a-55902ee7228f",
    "forecast_budget": 16
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/project/{project}/category/step

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project   string   

The project. Example: consequatur

Body Parameters

milestone_category_id   string   

The id of an existing record in the milestone_categories table. Example: consequatur

default   boolean  optional   true false

Example: false

status   string[]  optional  

The id of an existing record in the task_statuses table.

color   string   

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

milestone_categories_progress   number   

Must be at least 0. Must not be greater than 100. Example: 13

society_id   string   

The id of an existing record in the societies table. Example: consequatur

delay_value   number  optional  

Example: 11613.31890586

delay_unit   string  optional  

Example: consequatur

Must be one of:

• minutes
• hours
• day
• week
• month

project_id   string   

Must be a valid UUID. The id of an existing record in the projects table. Example: 98adc52b-966d-39db-809a-55902ee7228f

forecast_budget   number  optional  

Must be at least 0. Example: 16

PUT api/v1/update/project/category/step/{projectCategoryStep_id}

Example request:

curl --request PUT \
    "http://core.localhost/api/v1/update/project/category/step/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"color\": \"amniihfqcoynlazghdtqt\",
    \"milestone_categories_progress\": 16,
    \"delay_value\": 23,
    \"delay_unit\": \"consequatur\",
    \"forecast_budget\": 45
}"

const url = new URL(
    "http://core.localhost/api/v1/update/project/category/step/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "color": "amniihfqcoynlazghdtqt",
    "milestone_categories_progress": 16,
    "delay_value": 23,
    "delay_unit": "consequatur",
    "forecast_budget": 45
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PUT api/v1/update/project/category/step/{projectCategoryStep_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

projectCategoryStep_id   string   

The ID of the projectCategoryStep. Example: consequatur

Body Parameters

status   string[]  optional  

The id of an existing record in the task_statuses table.

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

color   string   

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

milestone_categories_progress   number   

Must be at least 0. Must not be greater than 100. Example: 16

delay_value   number  optional  

This field is required when delay_unit is present. Must be at least 1. Must not be greater than 100. Example: 23

delay_unit   string  optional  

This field is required when delay_value is present. Example: consequatur

Must be one of:

• minutes
• hours
• day
• week
• month

forecast_budget   number  optional  

Must be at least 0. Example: 45

PUT api/v1/switch/project/category/step/{projectCategoryStep_id}

Example request:

curl --request PUT \
    "http://core.localhost/api/v1/switch/project/category/step/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"position\": 73
}"

const url = new URL(
    "http://core.localhost/api/v1/switch/project/category/step/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "position": 73
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PUT api/v1/switch/project/category/step/{projectCategoryStep_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

projectCategoryStep_id   string   

The ID of the projectCategoryStep. Example: consequatur

Body Parameters

position   integer   

Must be at least 0. Example: 73

PUT api/v1/update/project/category/step/status/position

Example request:

curl --request PUT \
    "http://core.localhost/api/v1/update/project/category/step/status/position" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/update/project/category/step/status/position"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PUT api/v1/update/project/category/step/status/position

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

DELETE api/v1/delete/project/category/step/{projectCategoryStep_id}

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/project/category/step/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/project/category/step/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/project/category/step/{projectCategoryStep_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

projectCategoryStep_id   string   

The ID of the projectCategoryStep. Example: consequatur

GET api/v1/get/projects/status/Stats

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/projects/status/Stats" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"startDate\": \"2019-10-08\",
    \"endDate\": \"2106-07-12\",
    \"office_id\": \"98adc52b-966d-39db-809a-55902ee7228f\",
    \"contact_id\": \"d48a46b6-3a18-3763-951d-66b7fdb284ae\"
}"

const url = new URL(
    "http://core.localhost/api/v1/get/projects/status/Stats"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "startDate": "2019-10-08",
    "endDate": "2106-07-12",
    "office_id": "98adc52b-966d-39db-809a-55902ee7228f",
    "contact_id": "d48a46b6-3a18-3763-951d-66b7fdb284ae"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/projects/status/Stats

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

startDate   string  optional  

Must be a valid date in the format d-m-Y. Must be a date before or equal to endDate. Example: 2019-10-08

endDate   string  optional  

Must be a valid date in the format d-m-Y. Must be a date after or equal to startDate. Example: 2106-07-12

office_id   string  optional  

Must be a valid UUID. The id of an existing record in the offices table. Example: 98adc52b-966d-39db-809a-55902ee7228f

contact_id   string  optional  

Must be a valid UUID. The id of an existing record in the contacts table. Example: d48a46b6-3a18-3763-951d-66b7fdb284ae

GET api/v1/get/projects/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/projects/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/projects/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/projects/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/projects/card/list

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/projects/card/list" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/projects/card/list"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/projects/card/list

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/projects/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/projects/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"startDate\": \"2019-10-08\",
    \"endDate\": \"2106-07-12\",
    \"office_id\": \"98adc52b-966d-39db-809a-55902ee7228f\",
    \"project_category_id\": \"d48a46b6-3a18-3763-951d-66b7fdb284ae\",
    \"project_category_group_id\": \"5f74bcbe-0654-30c9-9013-151f9399e192\"
}"

const url = new URL(
    "http://core.localhost/api/v1/get/projects/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "startDate": "2019-10-08",
    "endDate": "2106-07-12",
    "office_id": "98adc52b-966d-39db-809a-55902ee7228f",
    "project_category_id": "d48a46b6-3a18-3763-951d-66b7fdb284ae",
    "project_category_group_id": "5f74bcbe-0654-30c9-9013-151f9399e192"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/projects/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

startDate   string  optional  

Must be a valid date in the format d-m-Y. Must be a date before or equal to endDate. Example: 2019-10-08

endDate   string  optional  

Must be a valid date in the format d-m-Y. Must be a date after or equal to startDate. Example: 2106-07-12

status   string  optional  

contact_id   string  optional  

The id of an existing record in the contacts table.

office_id   string  optional  

Must be a valid UUID. The id of an existing record in the offices table. Example: 98adc52b-966d-39db-809a-55902ee7228f

project_category_id   string  optional  

Must be a valid UUID. The id of an existing record in the project_categories table. Example: d48a46b6-3a18-3763-951d-66b7fdb284ae

project_category_group_id   string  optional  

Must be a valid UUID. The id of an existing record in the project_category_groups table. Example: 5f74bcbe-0654-30c9-9013-151f9399e192

user_id   string  optional  

The id of an existing record in the users table.

GET api/v1/get/projects/tables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/projects/tables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/projects/tables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/projects/tables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/project/{project_id}/tables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/project/consequatur/tables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/project/consequatur/tables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/project/{project_id}/tables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project_id   string   

The ID of the project. Example: consequatur

POST api/v1/project/{project_id}/tables

Example request:

curl --request POST \
    "http://core.localhost/api/v1/project/consequatur/tables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": [
        {
            \"name\": \"consequatur\",
            \"columns\": [
                {
                    \"name\": \"consequatur\"
                }
            ]
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/project/consequatur/tables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "data": [
        {
            "name": "consequatur",
            "columns": [
                {
                    "name": "consequatur"
                }
            ]
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/project/{project_id}/tables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project_id   string   

The ID of the project. Example: consequatur

Body Parameters

data   object[]  optional  

name   string   

Example: consequatur

columns   object[]   

name   string   

Example: consequatur

GET api/v1/get/projects/archived/card/list

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/projects/archived/card/list" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/projects/archived/card/list"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/projects/archived/card/list

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/projects/archived/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/projects/archived/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"startDate\": \"2019-10-08\",
    \"endDate\": \"2106-07-12\",
    \"office_id\": \"98adc52b-966d-39db-809a-55902ee7228f\",
    \"project_category_id\": \"d48a46b6-3a18-3763-951d-66b7fdb284ae\",
    \"project_category_group_id\": \"5f74bcbe-0654-30c9-9013-151f9399e192\"
}"

const url = new URL(
    "http://core.localhost/api/v1/get/projects/archived/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "startDate": "2019-10-08",
    "endDate": "2106-07-12",
    "office_id": "98adc52b-966d-39db-809a-55902ee7228f",
    "project_category_id": "d48a46b6-3a18-3763-951d-66b7fdb284ae",
    "project_category_group_id": "5f74bcbe-0654-30c9-9013-151f9399e192"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/projects/archived/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

startDate   string  optional  

Must be a valid date in the format d-m-Y. Must be a date before or equal to endDate. Example: 2019-10-08

endDate   string  optional  

Must be a valid date in the format d-m-Y. Must be a date after or equal to startDate. Example: 2106-07-12

status   string  optional  

contact_id   string  optional  

The id of an existing record in the contacts table.

office_id   string  optional  

Must be a valid UUID. The id of an existing record in the offices table. Example: 98adc52b-966d-39db-809a-55902ee7228f

project_category_id   string  optional  

Must be a valid UUID. The id of an existing record in the project_categories table. Example: d48a46b6-3a18-3763-951d-66b7fdb284ae

project_category_group_id   string  optional  

Must be a valid UUID. The id of an existing record in the project_category_groups table. Example: 5f74bcbe-0654-30c9-9013-151f9399e192

POST api/v1/store/project

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/project" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"reference\": \"amniihfqcoynlazghdtqt\",
    \"start_date\": \"12-06-2025\",
    \"end_date\": \"2106-07-12\",
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"progress\": 4,
    \"key_word\": [
        \"tdsufvyvddqamniihfqco\"
    ],
    \"creation_date\": \"2025-06-12T12:56:32\",
    \"closing_date\": \"2106-07-12\",
    \"project_category_id\": \"98adc52b-966d-39db-809a-55902ee7228f\",
    \"office_id\": \"d48a46b6-3a18-3763-951d-66b7fdb284ae\",
    \"users\": [
        \"5f74bcbe-0654-30c9-9013-151f9399e192\"
    ],
    \"budget_name\": \"uudtdsufvyvddqamniihf\",
    \"forecast_budget\": 57,
    \"currency_id\": \"5d4370ba-0848-31e1-880d-fcbc1539481f\",
    \"allow_dispatch\": true,
    \"managers\": [
        \"b2c92958-c8e7-31ab-9c7f-a3df5ef452a9\"
    ],
    \"contacts\": [
        {
            \"contact_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
            \"contact_status_id\": \"fa010f60-df29-3f05-8bc7-bed48f550d13\"
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/store/project"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "reference": "amniihfqcoynlazghdtqt",
    "start_date": "12-06-2025",
    "end_date": "2106-07-12",
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "progress": 4,
    "key_word": [
        "tdsufvyvddqamniihfqco"
    ],
    "creation_date": "2025-06-12T12:56:32",
    "closing_date": "2106-07-12",
    "project_category_id": "98adc52b-966d-39db-809a-55902ee7228f",
    "office_id": "d48a46b6-3a18-3763-951d-66b7fdb284ae",
    "users": [
        "5f74bcbe-0654-30c9-9013-151f9399e192"
    ],
    "budget_name": "uudtdsufvyvddqamniihf",
    "forecast_budget": 57,
    "currency_id": "5d4370ba-0848-31e1-880d-fcbc1539481f",
    "allow_dispatch": true,
    "managers": [
        "b2c92958-c8e7-31ab-9c7f-a3df5ef452a9"
    ],
    "contacts": [
        {
            "contact_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
            "contact_status_id": "fa010f60-df29-3f05-8bc7-bed48f550d13"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/project

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

reference   string  optional  

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

start_date   string   

Must be a valid date in the format d-m-Y. Example: 12-06-2025

end_date   string  optional  

Must be a valid date in the format d-m-Y. Must be a date after or equal to start_date. Example: 2106-07-12

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

progress   number  optional  

Must be at least 0. Must not be greater than 100. Example: 4

key_word   string[]  optional  

Must not be greater than 255 characters.

creation_date   string  optional  

Must be a valid date. Example: 2025-06-12T12:56:32

closing_date   string  optional  

Must be a valid date. Must be a date after or equal to creation_date. Example: 2106-07-12

project_category_id   string   

Must be a valid UUID. The id of an existing record in the project_categories table. Example: 98adc52b-966d-39db-809a-55902ee7228f

office_id   string   

Must be a valid UUID. The id of an existing record in the offices table. Example: d48a46b6-3a18-3763-951d-66b7fdb284ae

users   string[]  optional  

Must be a valid UUID. The id of an existing record in the users table.

budget_name   string  optional  

Must not be greater than 255 characters. Example: uudtdsufvyvddqamniihf

forecast_budget   number  optional  

Must be at least 1. Example: 57

currency_id   string  optional  

Must be a valid UUID. The id of an existing record in the currencies table. Example: 5d4370ba-0848-31e1-880d-fcbc1539481f

allow_dispatch   boolean  optional   true false

Example: true

managers   string[]  optional  

Must be a valid UUID. The id of an existing record in the users table.

contacts   object[]   

contact_id   string   

Must be a valid UUID. The id of an existing record in the contacts table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

contact_status_id   string   

Must be a valid UUID. The id of an existing record in the contact_statuses table. Example: fa010f60-df29-3f05-8bc7-bed48f550d13

GET api/v1/show/{project}/project

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/show/consequatur/project" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/show/consequatur/project"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/show/{project}/project

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project   string   

Example: consequatur

PATCH api/v1/update/{project}/project

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/project" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"reference\": \"amniihfqcoynlazghdtqt\",
    \"start_date\": \"12-06-2025\",
    \"end_date\": \"2106-07-12\",
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"progress\": 4,
    \"key_word\": [
        \"tdsufvyvddqamniihfqco\"
    ],
    \"creation_date\": \"2025-06-12T12:56:32\",
    \"closing_date\": \"2106-07-12\",
    \"project_category_id\": \"98adc52b-966d-39db-809a-55902ee7228f\",
    \"users\": [
        \"d48a46b6-3a18-3763-951d-66b7fdb284ae\"
    ],
    \"budget_name\": \"pfuudtdsufvyvddqamnii\",
    \"forecast_budget\": 26,
    \"currency_id\": \"957dba86-4fef-3375-bedd-10e12a33d85e\",
    \"managers\": [
        \"5d4370ba-0848-31e1-880d-fcbc1539481f\"
    ],
    \"contacts\": [
        {
            \"contact_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
            \"contact_status_id\": \"fa010f60-df29-3f05-8bc7-bed48f550d13\"
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/project"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "reference": "amniihfqcoynlazghdtqt",
    "start_date": "12-06-2025",
    "end_date": "2106-07-12",
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "progress": 4,
    "key_word": [
        "tdsufvyvddqamniihfqco"
    ],
    "creation_date": "2025-06-12T12:56:32",
    "closing_date": "2106-07-12",
    "project_category_id": "98adc52b-966d-39db-809a-55902ee7228f",
    "users": [
        "d48a46b6-3a18-3763-951d-66b7fdb284ae"
    ],
    "budget_name": "pfuudtdsufvyvddqamnii",
    "forecast_budget": 26,
    "currency_id": "957dba86-4fef-3375-bedd-10e12a33d85e",
    "managers": [
        "5d4370ba-0848-31e1-880d-fcbc1539481f"
    ],
    "contacts": [
        {
            "contact_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
            "contact_status_id": "fa010f60-df29-3f05-8bc7-bed48f550d13"
        }
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{project}/project

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project   string   

Example: consequatur

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

reference   string  optional  

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

start_date   string   

Must be a valid date in the format d-m-Y. Example: 12-06-2025

end_date   string  optional  

Must be a valid date in the format d-m-Y. Must be a date after or equal to start_date. Example: 2106-07-12

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

progress   number  optional  

Must be at least 0. Must not be greater than 100. Example: 4

key_word   string[]  optional  

Must not be greater than 255 characters.

creation_date   string  optional  

Must be a valid date. Example: 2025-06-12T12:56:32

closing_date   string  optional  

Must be a valid date. Must be a date after or equal to creation_date. Example: 2106-07-12

project_category_id   string   

Must be a valid UUID. The id of an existing record in the project_categories table. Example: 98adc52b-966d-39db-809a-55902ee7228f

users   string[]  optional  

Must be a valid UUID. The id of an existing record in the users table.

budget_name   string  optional  

Must not be greater than 255 characters. Example: pfuudtdsufvyvddqamnii

forecast_budget   number  optional  

Must be at least 1. Example: 26

currency_id   string  optional  

Must be a valid UUID. The id of an existing record in the currencies table. Example: 957dba86-4fef-3375-bedd-10e12a33d85e

managers   string[]  optional  

Must be a valid UUID. The id of an existing record in the users table.

contacts   object[]   

contact_id   string   

Must be a valid UUID. The id of an existing record in the contacts table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

contact_status_id   string   

Must be a valid UUID. The id of an existing record in the contact_statuses table. Example: fa010f60-df29-3f05-8bc7-bed48f550d13

PATCH api/v1/update/{project}/progress

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/progress" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"progress\": 21,
    \"project\": \"98adc52b-966d-39db-809a-55902ee7228f\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/progress"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "progress": 21,
    "project": "98adc52b-966d-39db-809a-55902ee7228f"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{project}/progress

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project   string   

Example: consequatur

Body Parameters

progress   number   

Must be at least 0. Must not be greater than 100. Example: 21

project   string   

Must be a valid UUID. The id of an existing record in the projects table. Example: 98adc52b-966d-39db-809a-55902ee7228f

PATCH api/v1/update/{project}/description

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/description" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"project\": \"fefb079f-5b81-3552-831f-ed3f89669781\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/description"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "project": "fefb079f-5b81-3552-831f-ed3f89669781"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{project}/description

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project   string   

Example: consequatur

Body Parameters

description   string   

Example: Dolores dolorum amet iste laborum eius est dolor.

project   string   

Must be a valid UUID. The id of an existing record in the projects table. Example: fefb079f-5b81-3552-831f-ed3f89669781

PATCH api/v1/set/project/{project}/contact

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/set/project/consequatur/contact" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/set/project/consequatur/contact"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/set/project/{project}/contact

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project   string   

The project. Example: consequatur

DELETE api/v1/delete/{project}/project

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/project" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/project"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{project}/project

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project   string   

Example: consequatur

POST api/v1/duplicate/{project}/project

Example request:

curl --request POST \
    "http://core.localhost/api/v1/duplicate/consequatur/project" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/duplicate/consequatur/project"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/duplicate/{project}/project

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project   string   

Example: consequatur

PATCH api/v1/change/project/{project}/status

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/change/project/consequatur/status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/change/project/consequatur/status"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/change/project/{project}/status

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project   string   

The project. Example: consequatur

PATCH api/v1/archive/project/{project}

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/archive/project/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/archive/project/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/archive/project/{project}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project   string   

The project. Example: consequatur

GET api/v1/get/project/{project}/invoices/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/project/consequatur/invoices/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/project/consequatur/invoices/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/project/{project}/invoices/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project   string   

The project. Example: consequatur

GET api/v1/get/projects/taskAlert/count

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/projects/taskAlert/count" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/projects/taskAlert/count"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/projects/taskAlert/count

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/users/performances/stats/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/users/performances/stats/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"startDate\": \"2019-10-08\",
    \"endDate\": \"2106-07-12\",
    \"project_id\": \"98adc52b-966d-39db-809a-55902ee7228f\"
}"

const url = new URL(
    "http://core.localhost/api/v1/get/users/performances/stats/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "startDate": "2019-10-08",
    "endDate": "2106-07-12",
    "project_id": "98adc52b-966d-39db-809a-55902ee7228f"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/users/performances/stats/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

startDate   string  optional  

Must be a valid date in the format d-m-Y. Must be a date before or equal to endDate. Example: 2019-10-08

endDate   string  optional  

Must be a valid date in the format d-m-Y. Must be a date after or equal to startDate. Example: 2106-07-12

project_id   string  optional  

Must be a valid UUID. The id of an existing record in the projects table. Example: 98adc52b-966d-39db-809a-55902ee7228f

GET api/v1/get/users/performances/criteria/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/users/performances/criteria/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/users/performances/criteria/enum"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/users/performances/criteria/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/project/{project}/users

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/project/consequatur/users" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/project/consequatur/users"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/project/{project}/users

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project   string   

The project. Example: consequatur

POST api/v1/add/project/{project}/users

Example request:

curl --request POST \
    "http://core.localhost/api/v1/add/project/consequatur/users" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/add/project/consequatur/users"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/add/project/{project}/users

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project   string   

The project. Example: consequatur

DELETE api/v1/delete/project/{project}/users

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/project/consequatur/users" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/project/consequatur/users"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/project/{project}/users

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project   string   

The project. Example: consequatur

GET api/v1/get/project/{project}/folder/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/project/consequatur/folder/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/project/consequatur/folder/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/project/{project}/folder/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project   string   

The project. Example: consequatur

GET api/v1/get/projectFolder/{projectFolder}/files/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/projectFolder/consequatur/files/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/projectFolder/consequatur/files/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/projectFolder/{projectFolder}/files/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

projectFolder   string   

The projectFolder. Example: consequatur

POST api/v1/store/project/{project}/folder

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/project/consequatur/folder" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"customer_can_view\": false
}"

const url = new URL(
    "http://core.localhost/api/v1/store/project/consequatur/folder"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "customer_can_view": false
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/project/{project}/folder

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project   string   

The project. Example: consequatur

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

customer_can_view   boolean  optional   true false

Example: false

PATCH api/v1/update/{projectFolder_id}/project/folder

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/project/folder" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"customer_can_view\": false
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/project/folder"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "customer_can_view": false
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{projectFolder_id}/project/folder

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

projectFolder_id   string   

The ID of the projectFolder. Example: consequatur

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

customer_can_view   boolean  optional   true false

Example: false

DELETE api/v1/delete/{project}/project/folder

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/project/folder" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/project/folder"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{project}/project/folder

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project   string   

Example: consequatur

POST api/v1/upload/projectFolder/{projectFolder}/files

Example request:

curl --request POST \
    "http://core.localhost/api/v1/upload/projectFolder/consequatur/files" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/upload/projectFolder/consequatur/files"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/upload/projectFolder/{projectFolder}/files

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

projectFolder   string   

The projectFolder. Example: consequatur

POST api/v1/add/keyWord/{file}/files

Example request:

curl --request POST \
    "http://core.localhost/api/v1/add/keyWord/consequatur/files" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/add/keyWord/consequatur/files"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/add/keyWord/{file}/files

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

file   string   

Example: consequatur

DELETE api/v1/delete/projectFolder/{projectFolder}/file

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/projectFolder/consequatur/file" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/projectFolder/consequatur/file"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/projectFolder/{projectFolder}/file

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

projectFolder   string   

The projectFolder. Example: consequatur

DELETE api/v1/delete/projectFolder/{projectFolder}/multi/files

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/projectFolder/consequatur/multi/files" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/projectFolder/consequatur/multi/files"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/projectFolder/{projectFolder}/multi/files

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

projectFolder   string   

The projectFolder. Example: consequatur

GET api/v1/download/file/{id}

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/download/file/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/download/file/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/download/file/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the file. Example: consequatur

POST api/v1/download/multiple-files

Example request:

curl --request POST \
    "http://core.localhost/api/v1/download/multiple-files" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"files\": [
        \"66529e01-d113-3473-8d6f-9e11e09332ea\"
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/download/multiple-files"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "files": [
        "66529e01-d113-3473-8d6f-9e11e09332ea"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/download/multiple-files

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

files   string[]  optional  

Must be a valid UUID. The id of an existing record in the project_folder_files table.

POST api/v1/set/customer/can/view/folder/{projectFolder}

Example request:

curl --request POST \
    "http://core.localhost/api/v1/set/customer/can/view/folder/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/set/customer/can/view/folder/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/set/customer/can/view/folder/{projectFolder}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

projectFolder   string   

Example: consequatur

POST api/v1/set/customer/can/view/files

Example request:

curl --request POST \
    "http://core.localhost/api/v1/set/customer/can/view/files" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"files\": [
        \"66529e01-d113-3473-8d6f-9e11e09332ea\"
    ],
    \"customer_can_view\": false
}"

const url = new URL(
    "http://core.localhost/api/v1/set/customer/can/view/files"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "files": [
        "66529e01-d113-3473-8d6f-9e11e09332ea"
    ],
    "customer_can_view": false
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/set/customer/can/view/files

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

files   string[]  optional  

Must be a valid UUID. The id of an existing record in the project_folder_files table.

customer_can_view   boolean  optional   true false

Example: false

GET api/v1/get/project/{projectId}/comments

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/project/consequatur/comments" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/project/consequatur/comments"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/project/{projectId}/comments

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

projectId   string   

Example: consequatur

POST api/v1/store/project/{projectId}/comment

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/project/consequatur/comment" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"comment\": \"consequatur\",
    \"project_id\": \"98adc52b-966d-39db-809a-55902ee7228f\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/project/consequatur/comment"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "comment": "consequatur",
    "project_id": "98adc52b-966d-39db-809a-55902ee7228f"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/project/{projectId}/comment

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

projectId   string   

Example: consequatur

Body Parameters

comment   string   

Example: consequatur

project_id   string   

Must be a valid UUID. The id of an existing record in the projects table. Example: 98adc52b-966d-39db-809a-55902ee7228f

PATCH api/v1/update/comment/{commentId}

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/comment/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"comment\": \"vmqeopfuudtdsufvyvddq\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/comment/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "comment": "vmqeopfuudtdsufvyvddq"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/comment/{commentId}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

commentId   string   

Example: consequatur

Body Parameters

comment   string   

Must not be greater than 1000 characters. Example: vmqeopfuudtdsufvyvddq

DELETE api/v1/delete/comment/{commentId}

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/comment/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/comment/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/comment/{commentId}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

commentId   string   

Example: consequatur

GET api/v1/get/project/status/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/project/status/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/project/status/enum"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/project/status/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/projects/rapport/stats

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/projects/rapport/stats" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"startDate\": \"2019-10-08\",
    \"endDate\": \"2106-07-12\",
    \"user_id\": \"consequatur\",
    \"project_category_id\": \"consequatur\",
    \"contact_id\": \"consequatur\",
    \"status\": \"consequatur\",
    \"search\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/get/projects/rapport/stats"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "startDate": "2019-10-08",
    "endDate": "2106-07-12",
    "user_id": "consequatur",
    "project_category_id": "consequatur",
    "contact_id": "consequatur",
    "status": "consequatur",
    "search": "consequatur"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/projects/rapport/stats

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

startDate   string  optional  

Must be a valid date in the format d-m-Y. Must be a date before or equal to endDate. Example: 2019-10-08

endDate   string  optional  

Must be a valid date in the format d-m-Y. Must be a date after or equal to startDate. Example: 2106-07-12

user_id   string  optional  

Example: consequatur

project_category_id   string  optional  

Example: consequatur

contact_id   string  optional  

Example: consequatur

status   string  optional  

Example: consequatur

search   string  optional  

Example: consequatur

GET api/v1/get/projects/rapport/stats/datatable

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/projects/rapport/stats/datatable" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"startDate\": \"2019-10-08\",
    \"endDate\": \"2106-07-12\",
    \"user_id\": \"consequatur\",
    \"project_category_id\": \"consequatur\",
    \"contact_id\": \"consequatur\",
    \"status\": \"consequatur\",
    \"search\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/get/projects/rapport/stats/datatable"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "startDate": "2019-10-08",
    "endDate": "2106-07-12",
    "user_id": "consequatur",
    "project_category_id": "consequatur",
    "contact_id": "consequatur",
    "status": "consequatur",
    "search": "consequatur"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/projects/rapport/stats/datatable

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

startDate   string  optional  

Must be a valid date in the format d-m-Y. Must be a date before or equal to endDate. Example: 2019-10-08

endDate   string  optional  

Must be a valid date in the format d-m-Y. Must be a date after or equal to startDate. Example: 2106-07-12

user_id   string  optional  

Example: consequatur

project_category_id   string  optional  

Example: consequatur

contact_id   string  optional  

Example: consequatur

status   string  optional  

Example: consequatur

search   string  optional  

Example: consequatur

GET api/v1/get/project/{project}/rapport/details

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/project/consequatur/rapport/details" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/project/consequatur/rapport/details"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/project/{project}/rapport/details

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project   string   

The project. Example: consequatur

POST api/v1/changes/tasks/status

Example request:

curl --request POST \
    "http://core.localhost/api/v1/changes/tasks/status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/changes/tasks/status"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/changes/tasks/status

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/task-priorities/collections

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/task-priorities/collections" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/task-priorities/collections"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/task-priorities/collections

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/task-priorities/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/task-priorities/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/task-priorities/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/task-priorities/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/task-priorities/store

Example request:

curl --request POST \
    "http://core.localhost/api/v1/task-priorities/store" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"color\": \"amniihfqcoynlazghdtqt\",
    \"society_id\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/task-priorities/store"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "color": "amniihfqcoynlazghdtqt",
    "society_id": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/task-priorities/store

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

color   string   

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

society_id   string   

The id of an existing record in the societies table. Example: consequatur

PUT api/v1/task-priorities/{taskPriority_id}/update

Example request:

curl --request PUT \
    "http://core.localhost/api/v1/task-priorities/consequatur/update" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"color\": \"amniihfqcoynlazghdtqt\",
    \"society_id\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/task-priorities/consequatur/update"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "color": "amniihfqcoynlazghdtqt",
    "society_id": "consequatur"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PUT api/v1/task-priorities/{taskPriority_id}/update

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

taskPriority_id   string   

The ID of the taskPriority. Example: consequatur

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

color   string   

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

society_id   string   

The id of an existing record in the societies table. Example: consequatur

DELETE api/v1/task-priorities/{taskPriority_id}/delete

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/task-priorities/consequatur/delete" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/task-priorities/consequatur/delete"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/task-priorities/{taskPriority_id}/delete

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

taskPriority_id   string   

The ID of the taskPriority. Example: consequatur

GET api/v1/task-status/collections

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/task-status/collections" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/task-status/collections"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/task-status/collections

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/task-status/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/task-status/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/task-status/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/task-status/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/task-status/store

Example request:

curl --request POST \
    "http://core.localhost/api/v1/task-status/store" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"color\": \"amniihfqcoynlazghdtqt\",
    \"default\": true,
    \"society_id\": \"consequatur\",
    \"is_complete\": false,
    \"is_review\": false
}"

const url = new URL(
    "http://core.localhost/api/v1/task-status/store"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "color": "amniihfqcoynlazghdtqt",
    "default": true,
    "society_id": "consequatur",
    "is_complete": false,
    "is_review": false
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/task-status/store

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

color   string   

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

default   boolean  optional   true false

Example: true

society_id   string   

The id of an existing record in the societies table. Example: consequatur

is_complete   boolean  optional   true false

Example: false

is_review   boolean  optional   true false

Example: false

PUT api/v1/task-status/{taskStatus_id}/update

Example request:

curl --request PUT \
    "http://core.localhost/api/v1/task-status/consequatur/update" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"default\": false,
    \"color\": \"amniihfqcoynlazghdtqt\",
    \"society_id\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/task-status/consequatur/update"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "default": false,
    "color": "amniihfqcoynlazghdtqt",
    "society_id": "consequatur"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PUT api/v1/task-status/{taskStatus_id}/update

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

taskStatus_id   string   

The ID of the taskStatus. Example: consequatur

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

default   boolean  optional   true false

Example: false

color   string   

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

society_id   string   

The id of an existing record in the societies table. Example: consequatur

DELETE api/v1/task-status/{taskStatus_id}/delete

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/task-status/consequatur/delete" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/task-status/consequatur/delete"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/task-status/{taskStatus_id}/delete

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

taskStatus_id   string   

The ID of the taskStatus. Example: consequatur

GET api/v1/milestone-categories/collections

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/milestone-categories/collections" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/milestone-categories/collections"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/milestone-categories/collections

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/milestone-categories/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/milestone-categories/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/milestone-categories/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/milestone-categories/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/milestone-categories/store

Example request:

curl --request POST \
    "http://core.localhost/api/v1/milestone-categories/store" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"default\": false,
    \"color\": \"amniihfqcoynlazghdtqt\",
    \"milestone_progress\": 16,
    \"society_id\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/milestone-categories/store"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "default": false,
    "color": "amniihfqcoynlazghdtqt",
    "milestone_progress": 16,
    "society_id": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/milestone-categories/store

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

default   boolean  optional   true false

Example: false

status   string[]  optional  

The id of an existing record in the task_statuses table.

color   string   

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

milestone_progress   number   

Must be at least 0. Must not be greater than 100. Example: 16

society_id   string   

The id of an existing record in the societies table. Example: consequatur

PUT api/v1/milestone-categories/{milestoneCategory_id}/update

Example request:

curl --request PUT \
    "http://core.localhost/api/v1/milestone-categories/consequatur/update" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"default\": false,
    \"color\": \"amniihfqcoynlazghdtqt\",
    \"milestone_progress\": 16,
    \"society_id\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/milestone-categories/consequatur/update"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "default": false,
    "color": "amniihfqcoynlazghdtqt",
    "milestone_progress": 16,
    "society_id": "consequatur"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PUT api/v1/milestone-categories/{milestoneCategory_id}/update

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

milestoneCategory_id   string   

The ID of the milestoneCategory. Example: consequatur

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

default   boolean  optional   true false

Example: false

status   string[]  optional  

The id of an existing record in the task_statuses table.

color   string   

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

milestone_progress   number  optional  

Must be at least 0. Must not be greater than 100. Example: 16

society_id   string   

The id of an existing record in the societies table. Example: consequatur

DELETE api/v1/milestone-categories/{milestoneCategory_id}/delete

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/milestone-categories/consequatur/delete" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/milestone-categories/consequatur/delete"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/milestone-categories/{milestoneCategory_id}/delete

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

milestoneCategory_id   string   

The ID of the milestoneCategory. Example: consequatur

GET api/v1/tasks/collections

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/tasks/collections" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/tasks/collections"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/tasks/collections

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/tasks/{project_id}/details

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/tasks/consequatur/details" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/tasks/consequatur/details"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/tasks/{project_id}/details

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project_id   string   

The ID of the project. Example: consequatur

GET api/v1/tasks/project/{project_id}/details/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/tasks/project/consequatur/details/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/tasks/project/consequatur/details/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/tasks/project/{project_id}/details/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project_id   string   

The ID of the project. Example: consequatur

GET api/v1/tasks/{task_id}/details/view

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/tasks/consequatur/details/view" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/tasks/consequatur/details/view"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/tasks/{task_id}/details/view

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

task_id   string   

The ID of the task. Example: consequatur

POST api/v1/tasks/store

Example request:

curl --request POST \
    "http://core.localhost/api/v1/tasks/store" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"project_id\": \"consequatur\",
    \"project_category_step_id\": \"consequatur\",
    \"task_status_id\": \"consequatur\",
    \"task_priority_id\": \"consequatur\",
    \"start_date\": \"12-06-2025 12:56\",
    \"end_date\": \"2106-07-12\",
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"users\": [
        \"consequatur\"
    ],
    \"delay_value\": 17,
    \"delay_unit\": \"consequatur\",
    \"delay_value_alert\": 17,
    \"delay_unit_alert\": \"consequatur\",
    \"delay_value_critical\": 17,
    \"delay_unit_critical\": \"consequatur\",
    \"need_review\": true
}"

const url = new URL(
    "http://core.localhost/api/v1/tasks/store"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "project_id": "consequatur",
    "project_category_step_id": "consequatur",
    "task_status_id": "consequatur",
    "task_priority_id": "consequatur",
    "start_date": "12-06-2025 12:56",
    "end_date": "2106-07-12",
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "users": [
        "consequatur"
    ],
    "delay_value": 17,
    "delay_unit": "consequatur",
    "delay_value_alert": 17,
    "delay_unit_alert": "consequatur",
    "delay_value_critical": 17,
    "delay_unit_critical": "consequatur",
    "need_review": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/tasks/store

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

project_id   string   

The id of an existing record in the projects table. Example: consequatur

project_category_step_id   string   

The id of an existing record in the project_category_steps table. Example: consequatur

task_status_id   string   

The id of an existing record in the project_category_step_statuses table. Example: consequatur

task_priority_id   string   

The id of an existing record in the task_priorities table. Example: consequatur

start_date   string   

Must be a valid date in the format d-m-Y H:i. Example: 12-06-2025 12:56

end_date   string  optional  

This field is required when delay_value or delay_unit is not present. Must be a valid date in the format d-m-Y H:i. Must be a date after or equal to start_date. Example: 2106-07-12

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

users   string[]   

The id of an existing record in the users table.

delay_value   integer  optional  

This field is required when end_date is not present. Example: 17

delay_unit   string  optional  

This field is required when end_date is not present. Example: consequatur

Must be one of:

• minutes
• hours
• day
• week
• month

delay_value_alert   integer  optional  

Example: 17

delay_unit_alert   string  optional  

Example: consequatur

Must be one of:

• minutes
• hours
• day
• week
• month

delay_value_critical   integer  optional  

Example: 17

delay_unit_critical   string  optional  

Example: consequatur

Must be one of:

• minutes
• hours
• day
• week
• month

need_review   boolean  optional   true false

Example: true

PUT api/v1/tasks/{task_id}/update

Example request:

curl --request PUT \
    "http://core.localhost/api/v1/tasks/consequatur/update" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"project_id\": \"consequatur\",
    \"project_category_step_id\": \"consequatur\",
    \"task_status_id\": \"consequatur\",
    \"task_priority_id\": \"consequatur\",
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"users\": [
        \"consequatur\"
    ],
    \"delay_value\": 11613.31890586,
    \"delay_unit\": \"consequatur\",
    \"need_review\": false
}"

const url = new URL(
    "http://core.localhost/api/v1/tasks/consequatur/update"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "project_id": "consequatur",
    "project_category_step_id": "consequatur",
    "task_status_id": "consequatur",
    "task_priority_id": "consequatur",
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "users": [
        "consequatur"
    ],
    "delay_value": 11613.31890586,
    "delay_unit": "consequatur",
    "need_review": false
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PUT api/v1/tasks/{task_id}/update

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

task_id   string   

The ID of the task. Example: consequatur

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

project_id   string   

The id of an existing record in the projects table. Example: consequatur

project_category_step_id   string   

The id of an existing record in the project_category_steps table. Example: consequatur

task_status_id   string   

The id of an existing record in the project_category_step_statuses table. Example: consequatur

task_priority_id   string   

The id of an existing record in the task_priorities table. Example: consequatur

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

users   string[]   

The id of an existing record in the users table.

delay_value   number  optional  

Example: 11613.31890586

delay_unit   string  optional  

Example: consequatur

Must be one of:

• minutes
• hours
• day
• week
• month

need_review   boolean  optional   true false

Example: false

PUT api/v1/tasks/shift/position

Example request:

curl --request PUT \
    "http://core.localhost/api/v1/tasks/shift/position" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"task_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"new_position\": 56
}"

const url = new URL(
    "http://core.localhost/api/v1/tasks/shift/position"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "task_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "new_position": 56
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PUT api/v1/tasks/shift/position

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

task_id   string   

Must be a valid UUID. The id of an existing record in the tasks table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

new_position   integer   

Must be at least 1. Example: 56

POST api/v1/tasks/change/status

Example request:

curl --request POST \
    "http://core.localhost/api/v1/tasks/change/status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/tasks/change/status"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/tasks/change/status

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/tasks/multiple/change/status

Example request:

curl --request POST \
    "http://core.localhost/api/v1/tasks/multiple/change/status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/tasks/multiple/change/status"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/tasks/multiple/change/status

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/tasks/assign/task/{task}/users

Example request:

curl --request POST \
    "http://core.localhost/api/v1/tasks/assign/task/consequatur/users" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/tasks/assign/task/consequatur/users"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/tasks/assign/task/{task}/users

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

task   string   

The task. Example: consequatur

POST api/v1/tasks/change/milestone-category

Example request:

curl --request POST \
    "http://core.localhost/api/v1/tasks/change/milestone-category" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/tasks/change/milestone-category"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/tasks/change/milestone-category

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

DELETE api/v1/tasks/{task_id}/delete

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/tasks/consequatur/delete" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/tasks/consequatur/delete"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/tasks/{task_id}/delete

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

task_id   string   

The ID of the task. Example: consequatur

PUT api/v1/tasks/{task}/update/alert/config

Example request:

curl --request PUT \
    "http://core.localhost/api/v1/tasks/consequatur/update/alert/config" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"delay_value_alert\": 17,
    \"delay_unit_alert\": \"consequatur\",
    \"delay_value_critical\": 17,
    \"delay_unit_critical\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/tasks/consequatur/update/alert/config"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "delay_value_alert": 17,
    "delay_unit_alert": "consequatur",
    "delay_value_critical": 17,
    "delay_unit_critical": "consequatur"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PUT api/v1/tasks/{task}/update/alert/config

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

task   string   

The task. Example: consequatur

Body Parameters

delay_value_alert   integer   

Example: 17

delay_unit_alert   string  optional  

This field is required when delay_value_alert is present. Example: consequatur

Must be one of:

• minutes
• hours
• day
• week
• month

delay_value_critical   integer   

Example: 17

delay_unit_critical   string  optional  

This field is required when delay_value_critical is present. Example: consequatur

Must be one of:

• minutes
• hours
• day
• week
• month

GET api/v1/tasks/get/{task_id}/upload/files

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/tasks/get/consequatur/upload/files" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/tasks/get/consequatur/upload/files"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/tasks/get/{task_id}/upload/files

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

task_id   string   

The ID of the task. Example: consequatur

POST api/v1/tasks/upload/files

Example request:

curl --request POST \
    "http://core.localhost/api/v1/tasks/upload/files" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/tasks/upload/files"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/tasks/upload/files

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

DELETE api/v1/tasks/delete/{fileTask_id}/files

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/tasks/delete/consequatur/files" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/tasks/delete/consequatur/files"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/tasks/delete/{fileTask_id}/files

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

fileTask_id   string   

The ID of the fileTask. Example: consequatur

GET api/v1/tasks/{task_id}/comments

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/tasks/consequatur/comments" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/tasks/consequatur/comments"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/tasks/{task_id}/comments

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

task_id   string   

The ID of the task. Example: consequatur

POST api/v1/tasks/comments/store

Example request:

curl --request POST \
    "http://core.localhost/api/v1/tasks/comments/store" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/tasks/comments/store"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/tasks/comments/store

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

PUT api/v1/tasks/{comment_id}/comments/update

Example request:

curl --request PUT \
    "http://core.localhost/api/v1/tasks/consequatur/comments/update" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/tasks/consequatur/comments/update"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PUT api/v1/tasks/{comment_id}/comments/update

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

comment_id   string   

The ID of the comment. Example: consequatur

DELETE api/v1/tasks/{comment_id}/comments/delete

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/tasks/consequatur/comments/delete" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/tasks/consequatur/comments/delete"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/tasks/{comment_id}/comments/delete

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

comment_id   string   

The ID of the comment. Example: consequatur

GET api/v1/checklists/tasks/{task_id}/collections

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/checklists/tasks/consequatur/collections" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/checklists/tasks/consequatur/collections"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/checklists/tasks/{task_id}/collections

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

task_id   string   

The ID of the task. Example: consequatur

POST api/v1/checklists/tasks/{task_id}/store

Example request:

curl --request POST \
    "http://core.localhost/api/v1/checklists/tasks/consequatur/store" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/checklists/tasks/consequatur/store"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/checklists/tasks/{task_id}/store

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

task_id   string   

The ID of the task. Example: consequatur

PUT api/v1/checklists/{checklist_id}/update

Example request:

curl --request PUT \
    "http://core.localhost/api/v1/checklists/consequatur/update" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/checklists/consequatur/update"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PUT api/v1/checklists/{checklist_id}/update

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

checklist_id   string   

The ID of the checklist. Example: consequatur

PUT api/v1/checklists/{checklist_id}/status

Example request:

curl --request PUT \
    "http://core.localhost/api/v1/checklists/consequatur/status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/checklists/consequatur/status"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PUT api/v1/checklists/{checklist_id}/status

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

checklist_id   string   

The ID of the checklist. Example: consequatur

DELETE api/v1/checklists/{checklist_id}/delete

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/checklists/consequatur/delete" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/checklists/consequatur/delete"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/checklists/{checklist_id}/delete

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

checklist_id   string   

The ID of the checklist. Example: consequatur

PUT api/v1/checklists/{checklist}/update/alert/config

Example request:

curl --request PUT \
    "http://core.localhost/api/v1/checklists/consequatur/update/alert/config" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"delay_value_alert\": 17,
    \"delay_unit_alert\": \"consequatur\",
    \"delay_value_critical\": 17,
    \"delay_unit_critical\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/checklists/consequatur/update/alert/config"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "delay_value_alert": 17,
    "delay_unit_alert": "consequatur",
    "delay_value_critical": 17,
    "delay_unit_critical": "consequatur"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PUT api/v1/checklists/{checklist}/update/alert/config

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

checklist   string   

The checklist. Example: consequatur

Body Parameters

delay_value_alert   integer   

Example: 17

delay_unit_alert   string  optional  

This field is required when delay_value_alert is present. Example: consequatur

Must be one of:

• minutes
• hours
• day
• week
• month

delay_value_critical   integer   

Example: 17

delay_unit_critical   string  optional  

This field is required when delay_value_critical is present. Example: consequatur

Must be one of:

• minutes
• hours
• day
• week
• month

GET api/v1/get/contactStatus/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/contactStatus/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/contactStatus/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/contactStatus/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/contactStatus/datatable

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/contactStatus/datatable" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/contactStatus/datatable"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/contactStatus/datatable

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/contactStatus

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/contactStatus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/contactStatus"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/contactStatus

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

PATCH api/v1/update/contactStatus/{contactStatus}

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/contactStatus/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/contactStatus/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/contactStatus/{contactStatus}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

contactStatus   string   

The contactStatus. Example: consequatur

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

GET api/v1/get/contactStatus/{contactStatus}

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/contactStatus/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/contactStatus/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/contactStatus/{contactStatus}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

contactStatus   string   

The contactStatus. Example: consequatur

DELETE api/v1/delete/contactStatus/{contactStatus}

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/contactStatus/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/contactStatus/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/contactStatus/{contactStatus}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

contactStatus   string   

The contactStatus. Example: consequatur

POST api/v1/store/real/estate/property

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/real/estate/property" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"is_built\": false,
    \"city_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"department_id\": \"fa010f60-df29-3f05-8bc7-bed48f550d13\",
    \"district\": \"opfuudtdsufvyvddqamni\",
    \"block\": \"ihfqcoynlazghdtqtqxba\",
    \"property_condition\": \"consequatur\",
    \"square_number\": \"mqeopfuudtdsufvyvddqa\",
    \"plot\": \"mniihfqcoynlazghdtqtq\",
    \"house\": \"xbajwbpilpmufinllwloa\",
    \"ownership_presumption\": \"uydlsmsjuryvojcybzvrb\",
    \"ownership_title\": \"yickznkygloigmkwxphlv\",
    \"project_id\": \"2badd6f3-bd6b-3dad-ba7c-4741c268578a\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/real/estate/property"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "is_built": false,
    "city_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "department_id": "fa010f60-df29-3f05-8bc7-bed48f550d13",
    "district": "opfuudtdsufvyvddqamni",
    "block": "ihfqcoynlazghdtqtqxba",
    "property_condition": "consequatur",
    "square_number": "mqeopfuudtdsufvyvddqa",
    "plot": "mniihfqcoynlazghdtqtq",
    "house": "xbajwbpilpmufinllwloa",
    "ownership_presumption": "uydlsmsjuryvojcybzvrb",
    "ownership_title": "yickznkygloigmkwxphlv",
    "project_id": "2badd6f3-bd6b-3dad-ba7c-4741c268578a"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/real/estate/property

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

is_built   boolean  optional   true false

Example: false

city_id   string  optional  

Must be a valid UUID. The id of an existing record in the cities table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

department_id   string  optional  

Must be a valid UUID. The id of an existing record in the departments table. Example: fa010f60-df29-3f05-8bc7-bed48f550d13

district   string  optional  

Must not be greater than 255 characters. Example: opfuudtdsufvyvddqamni

block   string  optional  

Must not be greater than 255 characters. Example: ihfqcoynlazghdtqtqxba

property_condition   string  optional  

Example: consequatur

square_number   string  optional  

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

plot   string  optional  

Must not be greater than 255 characters. Example: mniihfqcoynlazghdtqtq

house   string  optional  

Must not be greater than 255 characters. Example: xbajwbpilpmufinllwloa

ownership_presumption   string  optional  

Must not be greater than 255 characters. Example: uydlsmsjuryvojcybzvrb

ownership_title   string  optional  

Must not be greater than 255 characters. Example: yickznkygloigmkwxphlv

project_id   string   

Must be a valid UUID. The id of an existing record in the projects table. Example: 2badd6f3-bd6b-3dad-ba7c-4741c268578a

GET api/v1/get/{propertyId}/real/estate/property

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/real/estate/property" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/real/estate/property"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{propertyId}/real/estate/property

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

propertyId   string   

Example: consequatur

GET api/v1/get/real/estate/property/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/real/estate/property/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/real/estate/property/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/real/estate/property/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/{project}/real/estate/property/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/real/estate/property/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/real/estate/property/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{project}/real/estate/property/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project   string   

Example: consequatur

DELETE api/v1/delete/{property_id}/real/estate/property

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/real/estate/property" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/real/estate/property"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{property_id}/real/estate/property

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

property_id   string   

The ID of the property. Example: consequatur

GET api/v1/get/{projectID}/real/estate/property/datatable

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/real/estate/property/datatable" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/real/estate/property/datatable"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{projectID}/real/estate/property/datatable

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

projectID   string   

Example: consequatur

GET api/v1/get/project/{project}/budget

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/project/consequatur/budget" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/project/consequatur/budget"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/project/{project}/budget

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project   string   

The project. Example: consequatur

POST api/v1/update/project/{project}/budget

Example request:

curl --request POST \
    "http://core.localhost/api/v1/update/project/consequatur/budget" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"budget_name\": \"vmqeopfuudtdsufvyvddq\",
    \"forecast_budget\": 2,
    \"currency_id\": \"87582a71-8e82-3d56-919d-d5863651492b\",
    \"allow_dispatch\": false,
    \"steps\": [
        {
            \"project_category_step_id\": \"77d66ab0-ed8e-31b6-bb6b-acfbf3e0d8a0\",
            \"forecast_budget\": 26
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/update/project/consequatur/budget"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "budget_name": "vmqeopfuudtdsufvyvddq",
    "forecast_budget": 2,
    "currency_id": "87582a71-8e82-3d56-919d-d5863651492b",
    "allow_dispatch": false,
    "steps": [
        {
            "project_category_step_id": "77d66ab0-ed8e-31b6-bb6b-acfbf3e0d8a0",
            "forecast_budget": 26
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/update/project/{project}/budget

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project   string   

The project. Example: consequatur

Body Parameters

budget_name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

forecast_budget   number   

Must be at least 1. Example: 2

currency_id   string   

Must be a valid UUID. The id of an existing record in the currencies table. Example: 87582a71-8e82-3d56-919d-d5863651492b

allow_dispatch   boolean  optional   true false

Example: false

steps   object[]  optional  

project_category_step_id   string  optional  

Must be a valid UUID. The id of an existing record in the project_category_steps table. Example: 77d66ab0-ed8e-31b6-bb6b-acfbf3e0d8a0

forecast_budget   number  optional  

Must be at least 1. Example: 26

POST api/v1/store/project/{project}/deposit

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/project/consequatur/deposit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/store/project/consequatur/deposit"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/project/{project}/deposit

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project   string   

The project. Example: consequatur

POST api/v1/store/project/{project}/withdrawal

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/project/consequatur/withdrawal" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/store/project/consequatur/withdrawal"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/project/{project}/withdrawal

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project   string   

The project. Example: consequatur

GET api/v1/get/project/transaction/{transaction}/details

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/project/transaction/consequatur/details" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/project/transaction/consequatur/details"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/project/transaction/{transaction}/details

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

transaction   string   

The transaction. Example: consequatur

GET api/v1/get/project/{project}/budget/chart/statistics

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/project/consequatur/budget/chart/statistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/project/consequatur/budget/chart/statistics"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/project/{project}/budget/chart/statistics

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project   string   

The project. Example: consequatur

GET api/v1/get/project/{project}/budget/statistics

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/project/consequatur/budget/statistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/project/consequatur/budget/statistics"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/project/{project}/budget/statistics

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project   string   

The project. Example: consequatur

GET api/v1/get/project/{project}/histories

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/project/consequatur/histories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/project/consequatur/histories"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/project/{project}/histories

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project   string   

The project. Example: consequatur

POST api/v1/allocate/bugdet/project/category/step

Example request:

curl --request POST \
    "http://core.localhost/api/v1/allocate/bugdet/project/category/step" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"project_category_step_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"forecast_budget\": 56
}"

const url = new URL(
    "http://core.localhost/api/v1/allocate/bugdet/project/category/step"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "project_category_step_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "forecast_budget": 56
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/allocate/bugdet/project/category/step

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

project_category_step_id   string   

Must be a valid UUID. The id of an existing record in the project_category_steps table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

forecast_budget   number   

Must be at least 0. Example: 56

POST api/v1/allocate/multi/bugdet/project/category/step

Example request:

curl --request POST \
    "http://core.localhost/api/v1/allocate/multi/bugdet/project/category/step" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"project_category_steps\": [
        {
            \"project_category_step_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
            \"forecast_budget\": 56
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/allocate/multi/bugdet/project/category/step"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "project_category_steps": [
        {
            "project_category_step_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
            "forecast_budget": 56
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/allocate/multi/bugdet/project/category/step

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

project_category_steps   object[]   

Must have at least 1 items.

project_category_step_id   string   

Must be a valid UUID. The id of an existing record in the project_category_steps table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

forecast_budget   number   

Must be at least 0. Example: 56

GET api/v1/get/project/{project_id}/steps

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/project/consequatur/steps" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/project/consequatur/steps"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/project/{project_id}/steps

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project_id   string   

The ID of the project. Example: consequatur

GET api/v1/get/budget/transaction/type/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/budget/transaction/type/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/budget/transaction/type/enum"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/budget/transaction/type/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/project/report/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/project/report/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/project/report/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/project/report/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/project/report/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/project/report/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/project/report/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/project/report/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/project/{project}/category/step

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/project/consequatur/category/step" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/project/consequatur/category/step"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/project/{project}/category/step

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project   string   

The project. Example: consequatur

GET api/v1/get/{report}/project/report

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/project/report" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/project/report"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{report}/project/report

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

report   string   

Example: consequatur

DELETE api/v1/delete/{report_id}/project/report

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/project/report" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/project/report"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{report_id}/project/report

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

report_id   string   

The ID of the report. Example: consequatur

POST api/v1/store/project/report

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/project/report" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "title=vmqeopfuudtdsufvyvddq"\
    --form "description=Dolores dolorum amet iste laborum eius est dolor."\
    --form "start_date=12-06-2025 12:56"\
    --form "end_date=2106-07-12"\
    --form "project_id=98adc52b-966d-39db-809a-55902ee7228f"\
    --form "category_step_id=d48a46b6-3a18-3763-951d-66b7fdb284ae"\
    --form "task_id=5f74bcbe-0654-30c9-9013-151f9399e192"\
    --form "files[]=@/tmp/phpTKlze9" 

const url = new URL(
    "http://core.localhost/api/v1/store/project/report"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('title', 'vmqeopfuudtdsufvyvddq');
body.append('description', 'Dolores dolorum amet iste laborum eius est dolor.');
body.append('start_date', '12-06-2025 12:56');
body.append('end_date', '2106-07-12');
body.append('project_id', '98adc52b-966d-39db-809a-55902ee7228f');
body.append('category_step_id', 'd48a46b6-3a18-3763-951d-66b7fdb284ae');
body.append('task_id', '5f74bcbe-0654-30c9-9013-151f9399e192');
body.append('files[]', document.querySelector('input[name="files[]"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/project/report

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

start_date   string   

Must be a valid date. Must be a valid date in the format d-m-Y H:i. Example: 12-06-2025 12:56

end_date   string  optional  

Must be a valid date. Must be a valid date in the format d-m-Y H:i. Must be a date after or equal to start_date. Example: 2106-07-12

project_id   string   

Must be a valid UUID. The id of an existing record in the projects table. Example: 98adc52b-966d-39db-809a-55902ee7228f

category_step_id   string  optional  

Must be a valid UUID. The id of an existing record in the project_category_steps table. Example: d48a46b6-3a18-3763-951d-66b7fdb284ae

task_id   string  optional  

Must be a valid UUID. The id of an existing record in the tasks table. Example: 5f74bcbe-0654-30c9-9013-151f9399e192

files   file[]   

Must be a file. Must not be greater than 10240 kilobytes.

POST api/v1/update/{report}/project/report

Example request:

curl --request POST \
    "http://core.localhost/api/v1/update/consequatur/project/report" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "title=vmqeopfuudtdsufvyvddq"\
    --form "description=Dolores dolorum amet iste laborum eius est dolor."\
    --form "start_date=12-06-2025 12:56"\
    --form "end_date=2106-07-12"\
    --form "project_id=98adc52b-966d-39db-809a-55902ee7228f"\
    --form "category_step_id=d48a46b6-3a18-3763-951d-66b7fdb284ae"\
    --form "task_id=5f74bcbe-0654-30c9-9013-151f9399e192"\
    --form "files[]=@/tmp/phpYP2iOP" 

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/project/report"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('title', 'vmqeopfuudtdsufvyvddq');
body.append('description', 'Dolores dolorum amet iste laborum eius est dolor.');
body.append('start_date', '12-06-2025 12:56');
body.append('end_date', '2106-07-12');
body.append('project_id', '98adc52b-966d-39db-809a-55902ee7228f');
body.append('category_step_id', 'd48a46b6-3a18-3763-951d-66b7fdb284ae');
body.append('task_id', '5f74bcbe-0654-30c9-9013-151f9399e192');
body.append('files[]', document.querySelector('input[name="files[]"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/update/{report}/project/report

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

report   string   

Example: consequatur

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

start_date   string   

Must be a valid date. Must be a valid date in the format d-m-Y H:i. Example: 12-06-2025 12:56

end_date   string  optional  

Must be a valid date. Must be a valid date in the format d-m-Y H:i. Must be a date after or equal to start_date. Example: 2106-07-12

project_id   string   

Must be a valid UUID. The id of an existing record in the projects table. Example: 98adc52b-966d-39db-809a-55902ee7228f

category_step_id   string  optional  

Must be a valid UUID. The id of an existing record in the project_category_steps table. Example: d48a46b6-3a18-3763-951d-66b7fdb284ae

task_id   string  optional  

Must be a valid UUID. The id of an existing record in the tasks table. Example: 5f74bcbe-0654-30c9-9013-151f9399e192

files   file[]   

Must be a file. Must not be greater than 10240 kilobytes.

PATCH api/v1/publish/{report}/project/report/news/feed

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/publish/consequatur/project/report/news/feed" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/publish/consequatur/project/report/news/feed"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/publish/{report}/project/report/news/feed

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

report   string   

Example: consequatur

PATCH api/v1/publish/{report}/project/report/for/client

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/publish/consequatur/project/report/for/client" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/publish/consequatur/project/report/for/client"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/publish/{report}/project/report/for/client

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

report   string   

Example: consequatur

GET api/v1/get/report/status/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/report/status/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/report/status/enum"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/report/status/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/push-notification/key

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/push-notification/key" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/push-notification/key"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/push-notification/key

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/push-notification/saveSubscription

Example request:

curl --request POST \
    "http://core.localhost/api/v1/push-notification/saveSubscription" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/push-notification/saveSubscription"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/push-notification/saveSubscription

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/currencies/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/currencies/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/currencies/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/currencies/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/departments/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/departments/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"search\": \"consequatur\",
    \"limit\": 17
}"

const url = new URL(
    "http://core.localhost/api/v1/get/departments/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "search": "consequatur",
    "limit": 17
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/departments/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

search   string  optional  

Example: consequatur

limit   integer  optional  

Example: 17

GET api/v1/get/departments/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/departments/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/departments/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/departments/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/department/{department}/users/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/department/consequatur/users/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/department/consequatur/users/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/department/{department}/users/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

department   string   

The department. Example: consequatur

POST api/v1/store/department

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/department" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/department"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/department

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

PUT api/v1/update/department/{id}

Example request:

curl --request PUT \
    "http://core.localhost/api/v1/update/department/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/department/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "id": "66529e01-d113-3473-8d6f-9e11e09332ea"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PUT api/v1/update/department/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the department. Example: consequatur

Body Parameters

id   string   

Must be a valid UUID. The id of an existing record in the departments table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

GET api/v1/get/department/{id}

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/department/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/department/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/department/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the department. Example: consequatur

DELETE api/v1/delete/department/{id}

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/department/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/department/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/department/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the department. Example: consequatur

POST api/v1/set/users/to/department

Example request:

curl --request POST \
    "http://core.localhost/api/v1/set/users/to/department" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"users\": [
        \"consequatur\"
    ],
    \"department_id\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/set/users/to/department"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "users": [
        "consequatur"
    ],
    "department_id": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/set/users/to/department

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

users   string[]   

Must be a valid UUID. The id of an existing record in the users table.

department_id   string   

The id of an existing record in the departments table. Example: consequatur

POST api/v1/delete/user/from/department

Example request:

curl --request POST \
    "http://core.localhost/api/v1/delete/user/from/department" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/delete/user/from/department"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user_id": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/delete/user/from/department

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

user_id   string   

The id of an existing record in the users table. Example: consequatur

GET api/v1/get/paymentType/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/paymentType/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/paymentType/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/paymentType/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/paymentType/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/paymentType/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/paymentType/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/paymentType/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/paymentType

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/paymentType" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/paymentType"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/paymentType

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

PATCH api/v1/update/{paymentType_id}/paymentType

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/paymentType" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/paymentType"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{paymentType_id}/paymentType

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

paymentType_id   string   

The ID of the paymentType. Example: consequatur

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

DELETE api/v1/delete/{paymentType}/paymentType

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/paymentType" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/paymentType"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{paymentType}/paymentType

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

paymentType   string   

Example: consequatur

GET api/v1/get/paymentCondition/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/paymentCondition/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/paymentCondition/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/paymentCondition/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/paymentCondition/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/paymentCondition/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/paymentCondition/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/paymentCondition/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/paymentCondition

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/paymentCondition" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"day\": 11613.31890586
}"

const url = new URL(
    "http://core.localhost/api/v1/store/paymentCondition"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "day": 11613.31890586
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/paymentCondition

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

day   number  optional  

Example: 11613.31890586

PATCH api/v1/update/{paymentCondition_id}/paymentCondition

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/paymentCondition" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"day\": 11613.31890586
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/paymentCondition"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "day": 11613.31890586
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{paymentCondition_id}/paymentCondition

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

paymentCondition_id   string   

The ID of the paymentCondition. Example: consequatur

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

day   number  optional  

Example: 11613.31890586

DELETE api/v1/delete/{paymentCondition}/paymentCondition

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/paymentCondition" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/paymentCondition"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{paymentCondition}/paymentCondition

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

paymentCondition   string   

Example: consequatur

GET api/v1/get/emailMessage/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/emailMessage/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/emailMessage/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/emailMessage/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/show/{emailMessage}/emailMessage

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/show/consequatur/emailMessage" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/show/consequatur/emailMessage"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/show/{emailMessage}/emailMessage

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

emailMessage   string   

Example: consequatur

PATCH api/v1/update/{emailMessage}/emailMessage

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/emailMessage" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"content\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/emailMessage"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "content": "consequatur"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{emailMessage}/emailMessage

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

emailMessage   string   

Example: consequatur

Body Parameters

content   string   

Example: consequatur

DELETE api/v1/delete/{emailMessage}/emailMessage

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/emailMessage" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/emailMessage"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{emailMessage}/emailMessage

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

emailMessage   string   

Example: consequatur

GET api/v1/emailMessage/type/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/emailMessage/type/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/emailMessage/type/enum"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/emailMessage/type/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/emailMessage/data/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/emailMessage/data/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/emailMessage/data/enum"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/emailMessage/data/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/timeZone/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/timeZone/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/timeZone/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/timeZone/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/templateByModule/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/templateByModule/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/templateByModule/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/templateByModule/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/templates/{id}/setDefault

Example request:

curl --request POST \
    "http://core.localhost/api/v1/templates/consequatur/setDefault" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/templates/consequatur/setDefault"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/templates/{id}/setDefault

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the template. Example: consequatur

GET api/v1/get/frequencyByContext

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/frequencyByContext" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/frequencyByContext"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/frequencyByContext

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/configFrequency

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/configFrequency" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"frequency\": \"month\",
    \"frequency_count\": 73,
    \"context\": \"DueAdvanceInvoice\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/configFrequency"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "frequency": "month",
    "frequency_count": 73,
    "context": "DueAdvanceInvoice"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/configFrequency

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

frequency   string   

Example: month

Must be one of:

• minutes
• hours
• day
• week
• month

frequency_count   integer   

Must be at least 1. Example: 73

context   string   

Example: DueAdvanceInvoice

Must be one of:

• UnvalidatedQuote
• DueAdvanceInvoice

GET api/v1/context/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/context/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/context/enum"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/context/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/frequency/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/frequency/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/frequency/enum"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/frequency/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/detail/configMailchimp

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/detail/configMailchimp" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/detail/configMailchimp"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/detail/configMailchimp

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/configMailchimp

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/configMailchimp" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"host\": \"vmqeopfuudtdsufvyvddq\",
    \"port\": 2,
    \"username\": \"mniihfqcoynlazghdtqtq\",
    \"password\": \"O[2UZ5ij-e\\/dl4m{o,\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/configMailchimp"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "host": "vmqeopfuudtdsufvyvddq",
    "port": 2,
    "username": "mniihfqcoynlazghdtqtq",
    "password": "O[2UZ5ij-e\/dl4m{o,"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/configMailchimp

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

host   string  optional  

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

port   integer   

Must be at least 1. Example: 2

username   string   

Must not be greater than 255 characters. Example: mniihfqcoynlazghdtqtq

password   string   

Example: O[2UZ5ij-e/dl4m{o,

POST api/v1/store/backup/config

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/backup/config" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"frequency\": \"week\",
    \"time\": \"12:56\",
    \"timezone\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/backup/config"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "frequency": "week",
    "time": "12:56",
    "timezone": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/backup/config

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

frequency   string   

Example: week

Must be one of:

• day
• week
• month
• year

time   string   

Must be a valid date in the format H:i. Example: 12:56

timezone   string   

The id of an existing record in the time_zones table. Example: consequatur

GET api/v1/get/latest/backup

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/latest/backup" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/latest/backup"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/latest/backup

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/restore/latest/{dateFolder}/backup

Example request:

curl --request POST \
    "http://core.localhost/api/v1/restore/latest/consequatur/backup" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/restore/latest/consequatur/backup"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/restore/latest/{dateFolder}/backup

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

dateFolder   string   

Example: consequatur

GET api/v1/get/areas/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/areas/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/areas/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/areas/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/area

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/area" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"country_id\": \"462ee709-6d9f-345a-95e6-76f833111fb8\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/area"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "country_id": "462ee709-6d9f-345a-95e6-76f833111fb8"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/area

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

country_id   string   

Must be a valid UUID. The id of an existing record in the countries table. Example: 462ee709-6d9f-345a-95e6-76f833111fb8

PATCH api/v1/update/{area_id}/area

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/area" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"country_id\": \"462ee709-6d9f-345a-95e6-76f833111fb8\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/area"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "country_id": "462ee709-6d9f-345a-95e6-76f833111fb8"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{area_id}/area

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

area_id   string   

The ID of the area. Example: consequatur

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

country_id   string   

Must be a valid UUID. The id of an existing record in the countries table. Example: 462ee709-6d9f-345a-95e6-76f833111fb8

DELETE api/v1/delete/{area}/area

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/area" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/area"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{area}/area

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

area   string   

Example: consequatur

GET api/v1/get/list/shop

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/list/shop" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/list/shop"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/list/shop

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/statistic/{shop_id}/shop

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/statistic/consequatur/shop" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/statistic/consequatur/shop"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/statistic/{shop_id}/shop

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shop_id   string   

The ID of the shop. Example: consequatur

POST api/v1/add/responsable/{shop}/shop

Example request:

curl --request POST \
    "http://core.localhost/api/v1/add/responsable/consequatur/shop" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/add/responsable/consequatur/shop"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/add/responsable/{shop}/shop

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shop   string   

Example: consequatur

POST api/v1/add/staff/{shop}/shop

Example request:

curl --request POST \
    "http://core.localhost/api/v1/add/staff/consequatur/shop" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/add/staff/consequatur/shop"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/add/staff/{shop}/shop

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shop   string   

Example: consequatur

DELETE api/v1/remove/participator/{shop_id}/shop

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/remove/participator/consequatur/shop" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/remove/participator/consequatur/shop"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/remove/participator/{shop_id}/shop

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shop_id   string   

The ID of the shop. Example: consequatur

GET api/v1/get/{shopID}/shop/members/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/shop/members/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/shop/members/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{shopID}/shop/members/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shopID   string   

Example: consequatur

GET api/v1/get/shop/members/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/shop/members/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/shop/members/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/shop/members/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/profil/type/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/profil/type/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/profil/type/enum"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/profil/type/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/login/participator/in/shop/{shop}

Example request:

curl --request POST \
    "http://core.localhost/api/v1/login/participator/in/shop/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"username\": \"consequatur\",
    \"password\": \"O[2UZ5ij-e\\/dl4m{o,\"
}"

const url = new URL(
    "http://core.localhost/api/v1/login/participator/in/shop/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "username": "consequatur",
    "password": "O[2UZ5ij-e\/dl4m{o,"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/login/participator/in/shop/{shop}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shop   string   

The shop. Example: consequatur

Body Parameters

username   string   

The username of an existing record in the participators table. Example: consequatur

password   string   

Example: O[2UZ5ij-e/dl4m{o,

POST api/v1/store/shop/{shop}/seller

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/shop/consequatur/seller" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/store/shop/consequatur/seller"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/shop/{shop}/seller

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shop   string   

The shop. Example: consequatur

PATCH api/v1/update/shop/seller/{participator}

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/shop/seller/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/update/shop/seller/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/shop/seller/{participator}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

participator   string   

Example: consequatur

POST api/v1/store/shop

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/shop" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=consequatur"\
    --form "address=consequatur"\
    --form "phone=consequatur"\
    --form "phone_code=consequatur"\
    --form "invoice_number=consequatur"\
    --form "prefix=consequatur"\
    --form "online="\
    --form "event_id=98adc52b-966d-39db-809a-55902ee7228f"\
    --form "logo=@/tmp/phpwcW2LU" 

const url = new URL(
    "http://core.localhost/api/v1/store/shop"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('name', 'consequatur');
body.append('address', 'consequatur');
body.append('phone', 'consequatur');
body.append('phone_code', 'consequatur');
body.append('invoice_number', 'consequatur');
body.append('prefix', 'consequatur');
body.append('online', '');
body.append('event_id', '98adc52b-966d-39db-809a-55902ee7228f');
body.append('logo', document.querySelector('input[name="logo"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/shop

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

name   string   

Example: consequatur

address   string  optional  

Example: consequatur

phone   string  optional  

Example: consequatur

phone_code   string  optional  

Example: consequatur

invoice_number   string  optional  

Example: consequatur

prefix   string  optional  

Example: consequatur

online   boolean  optional   true false

Example: false

event_id   string  optional  

Must be a valid UUID. The id of an existing record in the events table. Example: 98adc52b-966d-39db-809a-55902ee7228f

logo   file  optional  

Must be an image. Must not be greater than 10240 kilobytes. Example: /tmp/phpwcW2LU

POST api/v1/update/{shop_id}/shop

Example request:

curl --request POST \
    "http://core.localhost/api/v1/update/consequatur/shop" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=consequatur"\
    --form "address=consequatur"\
    --form "phone=consequatur"\
    --form "phone_code=consequatur"\
    --form "invoice_number=consequatur"\
    --form "prefix=consequatur"\
    --form "online=1"\
    --form "event_id=98adc52b-966d-39db-809a-55902ee7228f"\
    --form "event_type=consequatur"\
    --form "delete_logo=1"\
    --form "logo=@/tmp/phpnMJppW" 

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/shop"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('name', 'consequatur');
body.append('address', 'consequatur');
body.append('phone', 'consequatur');
body.append('phone_code', 'consequatur');
body.append('invoice_number', 'consequatur');
body.append('prefix', 'consequatur');
body.append('online', '1');
body.append('event_id', '98adc52b-966d-39db-809a-55902ee7228f');
body.append('event_type', 'consequatur');
body.append('delete_logo', '1');
body.append('logo', document.querySelector('input[name="logo"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/update/{shop_id}/shop

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

shop_id   string   

The ID of the shop. Example: consequatur

Body Parameters

name   string   

Example: consequatur

address   string  optional  

Example: consequatur

phone   string  optional  

Example: consequatur

phone_code   string  optional  

Example: consequatur

invoice_number   string  optional  

Example: consequatur

prefix   string  optional  

Example: consequatur

online   boolean  optional   true false

Example: true

event_id   string  optional  

Must be a valid UUID. Example: 98adc52b-966d-39db-809a-55902ee7228f

event_type   string  optional  

Example: consequatur

logo   file  optional  

Must be an image. Must not be greater than 10240 kilobytes. Example: /tmp/phpnMJppW

delete_logo   boolean  optional   true false

Example: true

DELETE api/v1/delete/{shop_id}/shop

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/shop" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/shop"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{shop_id}/shop

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shop_id   string   

The ID of the shop. Example: consequatur

GET api/v1/get/detail/{shop}/shop

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/detail/consequatur/shop" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/detail/consequatur/shop"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/detail/{shop}/shop

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shop   string   

Example: consequatur

GET api/v1/get/categories/{shop_id}/shop

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/categories/consequatur/shop" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/categories/consequatur/shop"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/categories/{shop_id}/shop

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shop_id   string   

The ID of the shop. Example: consequatur

GET api/v1/get/categories/{shop_id}/shop/datatable

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/categories/consequatur/shop/datatable" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/categories/consequatur/shop/datatable"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/categories/{shop_id}/shop/datatable

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shop_id   string   

The ID of the shop. Example: consequatur

GET api/v1/get/categories/{shop_id}/shop/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/categories/consequatur/shop/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/categories/consequatur/shop/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/categories/{shop_id}/shop/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shop_id   string   

The ID of the shop. Example: consequatur

POST api/v1/store/category/{shop_id}/shop

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/category/consequatur/shop" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=vmqeopfuudtdsufvyvddq"\
    --form "categories[]=462ee709-6d9f-345a-95e6-76f833111fb8"\
    --form "image=@/tmp/php3f62qY" 

const url = new URL(
    "http://core.localhost/api/v1/store/category/consequatur/shop"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('name', 'vmqeopfuudtdsufvyvddq');
body.append('categories[]', '462ee709-6d9f-345a-95e6-76f833111fb8');
body.append('image', document.querySelector('input[name="image"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/category/{shop_id}/shop

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

shop_id   string   

The ID of the shop. Example: consequatur

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

categories   string[]   

Must be a valid UUID. The id of an existing record in the categories table.

image   file  optional  

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/php3f62qY

POST api/v1/upload/image/category/{shop_id}/shop

Example request:

curl --request POST \
    "http://core.localhost/api/v1/upload/image/category/consequatur/shop" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/upload/image/category/consequatur/shop"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/upload/image/category/{shop_id}/shop

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shop_id   string   

The ID of the shop. Example: consequatur

PUT api/v1/update/{category}/category/{shop_id}/shop

Example request:

curl --request PUT \
    "http://core.localhost/api/v1/update/consequatur/category/consequatur/shop" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/category/consequatur/shop"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PUT api/v1/update/{category}/category/{shop_id}/shop

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

category   string   

Example: consequatur

shop_id   string   

The ID of the shop. Example: consequatur

DELETE api/v1/delete/{category}/category/{shop_id}/shop

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/category/consequatur/shop" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/category/consequatur/shop"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{category}/category/{shop_id}/shop

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

category   string   

Example: consequatur

shop_id   string   

The ID of the shop. Example: consequatur

GET api/v1/get/taxes/{shop_id}/shop/datatable

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/taxes/consequatur/shop/datatable" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/taxes/consequatur/shop/datatable"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/taxes/{shop_id}/shop/datatable

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shop_id   string   

The ID of the shop. Example: consequatur

GET api/v1/get/taxes/{shop_id}/shop/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/taxes/consequatur/shop/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/taxes/consequatur/shop/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/taxes/{shop_id}/shop/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shop_id   string   

The ID of the shop. Example: consequatur

POST api/v1/store/taxe/{shop_id}/shop

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/taxe/consequatur/shop" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/store/taxe/consequatur/shop"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/taxe/{shop_id}/shop

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shop_id   string   

The ID of the shop. Example: consequatur

PUT api/v1/update/{taxe}/taxe/shop

Example request:

curl --request PUT \
    "http://core.localhost/api/v1/update/consequatur/taxe/shop" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/taxe/shop"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PUT api/v1/update/{taxe}/taxe/shop

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

taxe   string   

Example: consequatur

DELETE api/v1/delete/{taxe}/taxe/shop

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/taxe/shop" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/taxe/shop"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{taxe}/taxe/shop

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

taxe   string   

Example: consequatur

POST api/v1/store/product/shop

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/product/shop" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "shop_id=66529e01-d113-3473-8d6f-9e11e09332ea"\
    --form "reference=consequatur"\
    --form "name=consequatur"\
    --form "description=Dolores dolorum amet iste laborum eius est dolor."\
    --form "category=fefb079f-5b81-3552-831f-ed3f89669781"\
    --form "purchase_price=11613.31890586"\
    --form "selling_price=11613.31890586"\
    --form "brand=57357f37-0ea3-38e5-8a6c-9de9d06e75fd"\
    --form "type=PRODUCT"\
    --form "online=1"\
    --form "product=c2cdda66-81e5-3060-a4eb-049b4a810d76"\
    --form "barcode=udtdsufvyvddqamniihfq"\
    --form "image=@/tmp/phpqlBYQ4" 

const url = new URL(
    "http://core.localhost/api/v1/store/product/shop"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('shop_id', '66529e01-d113-3473-8d6f-9e11e09332ea');
body.append('reference', 'consequatur');
body.append('name', 'consequatur');
body.append('description', 'Dolores dolorum amet iste laborum eius est dolor.');
body.append('category', 'fefb079f-5b81-3552-831f-ed3f89669781');
body.append('purchase_price', '11613.31890586');
body.append('selling_price', '11613.31890586');
body.append('brand', '57357f37-0ea3-38e5-8a6c-9de9d06e75fd');
body.append('type', 'PRODUCT');
body.append('online', '1');
body.append('product', 'c2cdda66-81e5-3060-a4eb-049b4a810d76');
body.append('barcode', 'udtdsufvyvddqamniihfq');
body.append('image', document.querySelector('input[name="image"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/product/shop

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

shop_id   string   

Must be a valid UUID. The id of an existing record in the shops table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

reference   string  optional  

Example: consequatur

name   string   

Example: consequatur

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

category   string   

Must be a valid UUID. The id of an existing record in the categories table. Example: fefb079f-5b81-3552-831f-ed3f89669781

purchase_price   number  optional  

Example: 11613.31890586

selling_price   number   

Example: 11613.31890586

brand   string  optional  

Must be a valid UUID. The id of an existing record in the brands table. Example: 57357f37-0ea3-38e5-8a6c-9de9d06e75fd

type   string  optional  

Example: PRODUCT

Must be one of:

• PRODUCT
• SERVICE

online   boolean  optional   true false

Example: true

product   string  optional  

Must be a valid UUID. The id of an existing record in the products table. Example: c2cdda66-81e5-3060-a4eb-049b4a810d76

taxes   string[]  optional  

The id of an existing record in the taxes table.

barcode   string  optional  

Must be at least 8 characters. Must not be greater than 128 characters. Example: udtdsufvyvddqamniihfq

image   file  optional  

Must be an image. Must not be greater than 10240 kilobytes. Example: /tmp/phpqlBYQ4

GET api/v1/get/{product_id}/product/shop

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/product/shop" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/product/shop"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{product_id}/product/shop

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

product_id   string   

The ID of the product. Example: consequatur

GET api/v1/get/{shopID}/product/shop

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/product/shop" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/product/shop"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{shopID}/product/shop

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shopID   string   

Example: consequatur

GET api/v1/get/product/{shop_id}/shop

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/product/consequatur/shop" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/product/consequatur/shop"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/product/{shop_id}/shop

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shop_id   string   

The ID of the shop. Example: consequatur

GET api/v1/get/product/shop/datatable

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/product/shop/datatable" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/product/shop/datatable"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/product/shop/datatable

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

DELETE api/v1/delete/{shop_id}/products/shop

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/products/shop" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"product_ids\": [
        \"66529e01-d113-3473-8d6f-9e11e09332ea\"
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/products/shop"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "product_ids": [
        "66529e01-d113-3473-8d6f-9e11e09332ea"
    ]
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{shop_id}/products/shop

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shop_id   string   

The ID of the shop. Example: consequatur

Body Parameters

product_ids   string[]  optional  

Must be a valid UUID. The id of an existing record in the products table.

POST api/v1/add/shop/product/sale/element

Example request:

curl --request POST \
    "http://core.localhost/api/v1/add/shop/product/sale/element" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/add/shop/product/sale/element"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/add/shop/product/sale/element

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/{shopID}/shop/product/sale/element/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/shop/product/sale/element/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/shop/product/sale/element/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{shopID}/shop/product/sale/element/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shopID   string   

Example: consequatur

GET api/v1/get/shop/product/sale/element/datatable

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/shop/product/sale/element/datatable" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/shop/product/sale/element/datatable"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/shop/product/sale/element/datatable

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

DELETE api/v1/delete/{shop_id}/shop/product/sale/element

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/shop/product/sale/element" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"product_sale_element_ids\": [
        \"66529e01-d113-3473-8d6f-9e11e09332ea\"
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/shop/product/sale/element"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "product_sale_element_ids": [
        "66529e01-d113-3473-8d6f-9e11e09332ea"
    ]
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{shop_id}/shop/product/sale/element

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shop_id   string   

The ID of the shop. Example: consequatur

Body Parameters

product_sale_element_ids   string[]  optional  

Must be a valid UUID. The product_sale_element_id of an existing record in the shop_products table.

GET api/v1/get/shop/{shop}/members

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/shop/consequatur/members" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/shop/consequatur/members"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/shop/{shop}/members

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shop   string   

The shop. Example: consequatur

GET api/v1/get/shop/{shop}/members/datatable

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/shop/consequatur/members/datatable" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/shop/consequatur/members/datatable"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/shop/{shop}/members/datatable

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shop   string   

The shop. Example: consequatur

GET api/v1/remove/shop/{shop_id}/member

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/remove/shop/consequatur/member" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/remove/shop/consequatur/member"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/remove/shop/{shop_id}/member

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shop_id   string   

The ID of the shop. Example: consequatur

GET api/v1/participator/shop/{shop}

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/participator/shop/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/participator/shop/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/participator/shop/{shop}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shop   string   

The shop. Example: consequatur

POST api/v1/add/participator/in/shop/{shop}

Example request:

curl --request POST \
    "http://core.localhost/api/v1/add/participator/in/shop/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"shop_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"participator_ids\": [
        \"consequatur\"
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/add/participator/in/shop/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "shop_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "participator_ids": [
        "consequatur"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/add/participator/in/shop/{shop}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shop   string   

The shop. Example: consequatur

Body Parameters

shop_id   string  optional  

Must be a valid UUID. The id of an existing record in the shops table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

participator_ids   string[]   

The id of an existing record in the participators table.

GET api/v1/change/participator/{participator}/status/in/shop/{shop}

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/change/participator/consequatur/status/in/shop/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/change/participator/consequatur/status/in/shop/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/change/participator/{participator}/status/in/shop/{shop}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

participator   string   

The participator. Example: consequatur

shop   string   

The shop. Example: consequatur

GET api/v1/get/shop/information

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/shop/information" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/shop/information"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/shop/information

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/shop/{shop_id}/sales/statistic

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/shop/consequatur/sales/statistic" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/shop/consequatur/sales/statistic"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/shop/{shop_id}/sales/statistic

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shop_id   string   

The ID of the shop. Example: consequatur

GET api/v1/get/shop/{shop}/category/statistic

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/shop/consequatur/category/statistic" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/shop/consequatur/category/statistic"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/shop/{shop}/category/statistic

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shop   string   

The shop. Example: consequatur

GET api/v1/get/event/{event}/participator

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/event/consequatur/participator" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/event/consequatur/participator"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/event/{event}/participator

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event   string   

The event. Example: consequatur

GET api/v1/event/shop/{shop}/sales/stats

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/event/shop/consequatur/sales/stats" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/event/shop/consequatur/sales/stats"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/event/shop/{shop}/sales/stats

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shop   string   

The shop. Example: consequatur

GET api/v1/event/shop/{shop}/stats/by/products

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/event/shop/consequatur/stats/by/products" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/event/shop/consequatur/stats/by/products"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/event/shop/{shop}/stats/by/products

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shop   string   

The shop. Example: consequatur

GET api/v1/event/shop/{shop}/get/checkout/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/event/shop/consequatur/get/checkout/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/event/shop/consequatur/get/checkout/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/event/shop/{shop}/get/checkout/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

shop   string   

The shop. Example: consequatur

GET api/v1/get/events/{event}/shops/{shop}/unlinked/participators

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/events/consequatur/shops/consequatur/unlinked/participators" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/events/consequatur/shops/consequatur/unlinked/participators"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/events/{event}/shops/{shop}/unlinked/participators

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

event   string   

The event. Example: consequatur

shop   string   

The shop. Example: consequatur

GET api/v1/get/shop/checkout/status/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/shop/checkout/status/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/shop/checkout/status/enum"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/shop/checkout/status/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/society/{society}/offices

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/society/consequatur/offices" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/society/consequatur/offices"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/society/{society}/offices

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

society   string   

The society. Example: consequatur

GET api/v1/get/datatable/offices

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/datatable/offices" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/datatable/offices"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/datatable/offices

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/societies

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/societies" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/societies"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/societies

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/set/society/{society}/default/timeZone

Example request:

curl --request POST \
    "http://core.localhost/api/v1/set/society/consequatur/default/timeZone" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"timezone_id\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/set/society/consequatur/default/timeZone"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "timezone_id": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/set/society/{society}/default/timeZone

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

society   string   

The society. Example: consequatur

Body Parameters

timezone_id   string   

The id of an existing record in the time_zones table. Example: consequatur

GET api/v1/get/{office}/office/users

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/office/users" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/office/users"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{office}/office/users

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

office   string   

Example: consequatur

GET api/v1/get/datatable/{office}/office/users

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/datatable/consequatur/office/users" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/datatable/consequatur/office/users"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/datatable/{office}/office/users

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

office   string   

Example: consequatur

GET api/v1/get/datatable/societies

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/datatable/societies" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/datatable/societies"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/datatable/societies

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/{society_id}/society

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/society" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/society"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{society_id}/society

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

society_id   string   

The ID of the society. Example: consequatur

POST api/v1/store/society

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/society" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"society_email\": \"kunde.eloisa@example.com\",
    \"ifu_number\": \"hfqcoynlazghdtqtqxbaj\",
    \"phone_code\": \"wbpilpmuf\",
    \"phone\": \"inllwloauydlsmsju\",
    \"address\": \"ryvojcybzvrbyickznkyg\",
    \"city\": \"loigmkwxphlvazjrcnfba\",
    \"zipcode\": \"qywuxhgjjmzuxjubqouzs\",
    \"tva_number\": \"wiwxtrkimfcatbxspzmra\",
    \"rccm_number\": \"zsroyjpxmqesedyghenqc\",
    \"website\": \"opwvownkbamlnfngefbei\",
    \"country_id\": \"54dbae45-3895-310c-b6e2-585a51b39333\",
    \"currency_id\": \"6dc72f7b-ee24-3889-a4ba-2ec77a721b79\",
    \"siren\": \"yuxoezbdt\",
    \"siret\": \"abptcyyerevrlj\",
    \"capital\": 7,
    \"headquarters_address\": \"bwkthjnescwsestcouxpq\",
    \"legal_form\": \"sydkigioyoyprjkfdjsne\",
    \"latitude\": -90,
    \"longitude\": -179
}"

const url = new URL(
    "http://core.localhost/api/v1/store/society"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "society_email": "kunde.eloisa@example.com",
    "ifu_number": "hfqcoynlazghdtqtqxbaj",
    "phone_code": "wbpilpmuf",
    "phone": "inllwloauydlsmsju",
    "address": "ryvojcybzvrbyickznkyg",
    "city": "loigmkwxphlvazjrcnfba",
    "zipcode": "qywuxhgjjmzuxjubqouzs",
    "tva_number": "wiwxtrkimfcatbxspzmra",
    "rccm_number": "zsroyjpxmqesedyghenqc",
    "website": "opwvownkbamlnfngefbei",
    "country_id": "54dbae45-3895-310c-b6e2-585a51b39333",
    "currency_id": "6dc72f7b-ee24-3889-a4ba-2ec77a721b79",
    "siren": "yuxoezbdt",
    "siret": "abptcyyerevrlj",
    "capital": 7,
    "headquarters_address": "bwkthjnescwsestcouxpq",
    "legal_form": "sydkigioyoyprjkfdjsne",
    "latitude": -90,
    "longitude": -179
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/society

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 25 characters. Example: vmqeopfuudtdsufvyvddq

society_email   string   

Must be a valid email address. Must match the regex /^.+@.+$/i. Must not be greater than 255 characters. Example: kunde.eloisa@example.com

ifu_number   string   

Must not be greater than 255 characters. Example: hfqcoynlazghdtqtqxbaj

phone_code   string  optional  

Must not be greater than 10 characters. Example: wbpilpmuf

phone   string  optional  

Must not be greater than 20 characters. Example: inllwloauydlsmsju

address   string  optional  

Must not be greater than 255 characters. Example: ryvojcybzvrbyickznkyg

city   string   

Must not be greater than 255 characters. Example: loigmkwxphlvazjrcnfba

zipcode   string  optional  

Must not be greater than 255 characters. Example: qywuxhgjjmzuxjubqouzs

tva_number   string  optional  

Must not be greater than 255 characters. Example: wiwxtrkimfcatbxspzmra

rccm_number   string   

Must not be greater than 255 characters. Example: zsroyjpxmqesedyghenqc

website   string  optional  

Must not be greater than 255 characters. Example: opwvownkbamlnfngefbei

country_id   string   

Must be a valid UUID. The id of an existing record in the countries table. Example: 54dbae45-3895-310c-b6e2-585a51b39333

currency_id   string   

Must be a valid UUID. The id of an existing record in the currencies table. Example: 6dc72f7b-ee24-3889-a4ba-2ec77a721b79

siren   string  optional  

Must match the regex /^\d{9}$/. Must be 9 characters. Example: yuxoezbdt

siret   string  optional  

Must match the regex /^\d{14}$/. Must be 14 characters. Example: abptcyyerevrlj

capital   number  optional  

Must be at least 0. Example: 7

headquarters_address   string  optional  

Must not be greater than 255 characters. Example: bwkthjnescwsestcouxpq

legal_form   string  optional  

Must not be greater than 100 characters. Example: sydkigioyoyprjkfdjsne

latitude   number  optional  

Must be between -90 and 90. Example: -90

longitude   number  optional  

Must be between -180 and 180. Example: -179

timezone_id   string  optional  

The id of an existing record in the time_zones table.

PATCH api/v1/update/{society}/society

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/society" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"society_email\": \"kunde.eloisa@example.com\",
    \"phone_code\": \"hfqcoynla\",
    \"ifu_number\": \"zghdtqtqxbajwbpilpmuf\",
    \"rccm_number\": \"inllwloauydlsmsjuryvo\",
    \"phone\": \"jcybzvrbyickznkyg\",
    \"address\": \"loigmkwxphlvazjrcnfba\",
    \"city\": \"qywuxhgjjmzuxjubqouzs\",
    \"zipcode\": \"wiwxtrkimfcatbxspzmra\",
    \"tva_number\": \"zsroyjpxmqesedyghenqc\",
    \"website\": \"opwvownkbamlnfngefbei\",
    \"country_id\": \"54dbae45-3895-310c-b6e2-585a51b39333\",
    \"currency_id\": \"6dc72f7b-ee24-3889-a4ba-2ec77a721b79\",
    \"siren\": \"yuxoezbdt\",
    \"siret\": \"abptcyyerevrlj\",
    \"capital\": 7,
    \"headquarters_address\": \"bwkthjnescwsestcouxpq\",
    \"legal_form\": \"sydkigioyoyprjkfdjsne\",
    \"latitude\": -90,
    \"longitude\": -179
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/society"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "society_email": "kunde.eloisa@example.com",
    "phone_code": "hfqcoynla",
    "ifu_number": "zghdtqtqxbajwbpilpmuf",
    "rccm_number": "inllwloauydlsmsjuryvo",
    "phone": "jcybzvrbyickznkyg",
    "address": "loigmkwxphlvazjrcnfba",
    "city": "qywuxhgjjmzuxjubqouzs",
    "zipcode": "wiwxtrkimfcatbxspzmra",
    "tva_number": "zsroyjpxmqesedyghenqc",
    "website": "opwvownkbamlnfngefbei",
    "country_id": "54dbae45-3895-310c-b6e2-585a51b39333",
    "currency_id": "6dc72f7b-ee24-3889-a4ba-2ec77a721b79",
    "siren": "yuxoezbdt",
    "siret": "abptcyyerevrlj",
    "capital": 7,
    "headquarters_address": "bwkthjnescwsestcouxpq",
    "legal_form": "sydkigioyoyprjkfdjsne",
    "latitude": -90,
    "longitude": -179
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{society}/society

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

society   string   

Example: consequatur

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

society_email   string   

Must be a valid email address. Must match the regex /^.+@.+$/i. Must not be greater than 255 characters. Example: kunde.eloisa@example.com

phone_code   string   

Must not be greater than 10 characters. Example: hfqcoynla

ifu_number   string   

Must not be greater than 255 characters. Example: zghdtqtqxbajwbpilpmuf

rccm_number   string   

Must not be greater than 255 characters. Example: inllwloauydlsmsjuryvo

phone   string   

Must not be greater than 20 characters. Example: jcybzvrbyickznkyg

address   string  optional  

Must not be greater than 255 characters. Example: loigmkwxphlvazjrcnfba

city   string   

Must not be greater than 255 characters. Example: qywuxhgjjmzuxjubqouzs

zipcode   string  optional  

Must not be greater than 255 characters. Example: wiwxtrkimfcatbxspzmra

tva_number   string  optional  

Must not be greater than 255 characters. Example: zsroyjpxmqesedyghenqc

website   string  optional  

Must not be greater than 255 characters. Example: opwvownkbamlnfngefbei

country_id   string   

Must be a valid UUID. The id of an existing record in the countries table. Example: 54dbae45-3895-310c-b6e2-585a51b39333

currency_id   string   

Must be a valid UUID. The id of an existing record in the currencies table. Example: 6dc72f7b-ee24-3889-a4ba-2ec77a721b79

siren   string  optional  

Must match the regex /^\d{9}$/. Must be 9 characters. Example: yuxoezbdt

siret   string  optional  

Must match the regex /^\d{14}$/. Must be 14 characters. Example: abptcyyerevrlj

capital   number  optional  

Must be at least 0. Example: 7

headquarters_address   string  optional  

Must not be greater than 255 characters. Example: bwkthjnescwsestcouxpq

legal_form   string  optional  

Must not be greater than 100 characters. Example: sydkigioyoyprjkfdjsne

latitude   number  optional  

Must be between -90 and 90. Example: -90

longitude   number  optional  

Must be between -180 and 180. Example: -179

timezone_id   string  optional  

The id of an existing record in the time_zones table.

DELETE api/v1/delete/{society_id}/society

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/society" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/society"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{society_id}/society

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

society_id   string   

The ID of the society. Example: consequatur

POST api/v1/store/office

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/office" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"phone_code\": \"amniihfqc\",
    \"phone\": \"oynlazghdtqtqxbaj\",
    \"address\": \"wbpilpmufinllwloauydl\",
    \"email\": \"micheal37@example.net\",
    \"society_id\": \"975203ab-8c3a-30ee-af4c-f3538e9c13aa\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/office"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "phone_code": "amniihfqc",
    "phone": "oynlazghdtqtqxbaj",
    "address": "wbpilpmufinllwloauydl",
    "email": "micheal37@example.net",
    "society_id": "975203ab-8c3a-30ee-af4c-f3538e9c13aa"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/office

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

phone_code   string   

Must not be greater than 10 characters. Example: amniihfqc

phone   string   

Must not be greater than 20 characters. Example: oynlazghdtqtqxbaj

address   string  optional  

Must not be greater than 255 characters. Example: wbpilpmufinllwloauydl

email   string  optional  

Must be a valid email address. Must not be greater than 255 characters. Example: micheal37@example.net

society_id   string   

Must be a valid UUID. The id of an existing record in the societies table. Example: 975203ab-8c3a-30ee-af4c-f3538e9c13aa

GET api/v1/get/office/{office}

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/office/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/office/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/office/{office}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

office   string   

The office. Example: consequatur

PUT api/v1/update/{office}/office

Example request:

curl --request PUT \
    "http://core.localhost/api/v1/update/consequatur/office" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"email\": \"kunde.eloisa@example.com\",
    \"phone_code\": \"hfqcoynla\",
    \"phone\": \"zghdtqtqxbajwbpil\",
    \"address\": \"pmufinllwloauydlsmsju\",
    \"society_id\": \"975203ab-8c3a-30ee-af4c-f3538e9c13aa\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/office"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "email": "kunde.eloisa@example.com",
    "phone_code": "hfqcoynla",
    "phone": "zghdtqtqxbajwbpil",
    "address": "pmufinllwloauydlsmsju",
    "society_id": "975203ab-8c3a-30ee-af4c-f3538e9c13aa"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PUT api/v1/update/{office}/office

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

office   string   

Example: consequatur

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

email   string  optional  

Must be a valid email address. Must not be greater than 255 characters. Example: kunde.eloisa@example.com

phone_code   string   

Must not be greater than 10 characters. Example: hfqcoynla

phone   string   

Must not be greater than 20 characters. Example: zghdtqtqxbajwbpil

address   string  optional  

Must not be greater than 255 characters. Example: pmufinllwloauydlsmsju

society_id   string   

Must be a valid UUID. The id of an existing record in the societies table. Example: 975203ab-8c3a-30ee-af4c-f3538e9c13aa

DELETE api/v1/delete/{office}/office

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/office" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/office"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{office}/office

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

office   string   

Example: consequatur

POST api/v1/set/users/to/office

Example request:

curl --request POST \
    "http://core.localhost/api/v1/set/users/to/office" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"users\": [
        \"consequatur\"
    ],
    \"office_id\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/set/users/to/office"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "users": [
        "consequatur"
    ],
    "office_id": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/set/users/to/office

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

users   string[]   

Must be a valid UUID. The id of an existing record in the users table.

office_id   string   

The id of an existing record in the offices table. Example: consequatur

POST api/v1/delete/user/from/office

Example request:

curl --request POST \
    "http://core.localhost/api/v1/delete/user/from/office" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/delete/user/from/office"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user_id": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/delete/user/from/office

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

user_id   string   

The id of an existing record in the users table. Example: consequatur

GET api/v1/get/society/infos

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/society/infos" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/society/infos"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/society/infos

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/statistics

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/statistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/statistics"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/statistics

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/sales/statistics

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/sales/statistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/sales/statistics"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/sales/statistics

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/crm/statistics

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/crm/statistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/crm/statistics"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/crm/statistics

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/crm/pipeline/statistics

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/crm/pipeline/statistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/crm/pipeline/statistics"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/crm/pipeline/statistics

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/crm/invoice/statistics

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/crm/invoice/statistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/crm/invoice/statistics"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/crm/invoice/statistics

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/crm/appointments/statistics

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/crm/appointments/statistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/crm/appointments/statistics"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/crm/appointments/statistics

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/download/crm/pipeline/statistics

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/download/crm/pipeline/statistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/download/crm/pipeline/statistics"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/download/crm/pipeline/statistics

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/download/crm/estimate/statistics

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/download/crm/estimate/statistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/download/crm/estimate/statistics"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/download/crm/estimate/statistics

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/download/crm/invoice/statistics

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/download/crm/invoice/statistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/download/crm/invoice/statistics"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/download/crm/invoice/statistics

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/download/crm/appointment/statistics

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/download/crm/appointment/statistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/download/crm/appointment/statistics"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/download/crm/appointment/statistics

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/reaction/type/enum

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/reaction/type/enum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/reaction/type/enum"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/reaction/type/enum

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/story-groups

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/story-groups" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/story-groups"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/story-groups

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/story-group

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/story-group" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"description\": \"Dolores molestias ipsam sit.\",
    \"is_private\": true
}"

const url = new URL(
    "http://core.localhost/api/v1/store/story-group"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "description": "Dolores molestias ipsam sit.",
    "is_private": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/story-group

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 25 characters. Example: vmqeopfuudtdsufvyvddq

description   string  optional  

Must not be greater than 255 characters. Example: Dolores molestias ipsam sit.

is_private   boolean  optional   true false

Example: true

PUT api/v1/update/story-group/{storyGroupId}

Example request:

curl --request PUT \
    "http://core.localhost/api/v1/update/story-group/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/update/story-group/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PUT api/v1/update/story-group/{storyGroupId}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

storyGroupId   string   

Example: consequatur

DELETE api/v1/delete/story-group/{storyGroupId}

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/story-group/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/story-group/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/story-group/{storyGroupId}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

storyGroupId   string   

Example: consequatur

POST api/v1/store/story-group-member

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/story-group-member" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/store/story-group-member"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/story-group-member

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

DELETE api/v1/delete/story-group-member/{storyGroupMemberId}

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/story-group-member/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/story-group-member/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/story-group-member/{storyGroupMemberId}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

storyGroupMemberId   string   

Example: consequatur

GET api/v1/get/publications

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/publications" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/publications"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/publications

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/user/publication/with/group

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/user/publication/with/group" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/user/publication/with/group"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/user/publication/with/group

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/user/project/{project}/publications

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/user/project/consequatur/publications" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/user/project/consequatur/publications"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/user/project/{project}/publications

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

project   string   

The project. Example: consequatur

POST api/v1/store/publication

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/publication" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"content\": \"amniihfqcoynlazghdtqt\",
    \"is_private\": true,
    \"model\": \"project\",
    \"model_id\": \"82bcef28-e633-3da0-8d78-f8d6e14eee9e\",
    \"story_group_id\": \"e4419155-5319-3498-a793-1f20eeafc66a\",
    \"files\": [
        \"jwbpilpmufinllwloauyd\"
    ],
    \"mention_ids\": [
        \"3c2683a5-3c45-3931-809f-b50d08823b39\"
    ],
    \"latitude\": -90,
    \"longitude\": -179,
    \"location_name\": \"juryvojcybzvrbyickznk\",
    \"address\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/publication"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "content": "amniihfqcoynlazghdtqt",
    "is_private": true,
    "model": "project",
    "model_id": "82bcef28-e633-3da0-8d78-f8d6e14eee9e",
    "story_group_id": "e4419155-5319-3498-a793-1f20eeafc66a",
    "files": [
        "jwbpilpmufinllwloauyd"
    ],
    "mention_ids": [
        "3c2683a5-3c45-3931-809f-b50d08823b39"
    ],
    "latitude": -90,
    "longitude": -179,
    "location_name": "juryvojcybzvrbyickznk",
    "address": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/publication

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

content   string   

Must not be greater than 1000 characters. Example: amniihfqcoynlazghdtqt

is_private   boolean  optional   true false

Example: true

model   string   

Example: project

Must be one of:

• project

model_id   string  optional  

Must be a valid UUID. Example: 82bcef28-e633-3da0-8d78-f8d6e14eee9e

story_group_id   string  optional  

Must be a valid UUID. The id of an existing record in the story_groups table. Example: e4419155-5319-3498-a793-1f20eeafc66a

files   string[]  optional  

Must not be greater than 10240 characters.

mention_ids   string[]  optional  

Must be a valid UUID. The id of an existing record in the users table.

latitude   number  optional  

Must be between -90 and 90. Example: -90

longitude   number  optional  

Must be between -180 and 180. Example: -179

location_name   string  optional  

Must not be greater than 255 characters. Example: juryvojcybzvrbyickznk

address   string  optional  

Example: consequatur

POST api/v1/update/publication/{publication}

Example request:

curl --request POST \
    "http://core.localhost/api/v1/update/publication/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"content\": \"amniihfqcoynlazghdtqt\",
    \"is_private\": true,
    \"story_group_id\": \"82bcef28-e633-3da0-8d78-f8d6e14eee9e\",
    \"model\": \"project\",
    \"files\": [
        \"bajwbpilpmufinllwloau\"
    ],
    \"mention_ids\": [
        \"c099f01a-21d1-3e3d-9e1f-32307232547f\"
    ],
    \"latitude\": -90,
    \"longitude\": -179,
    \"location_name\": \"msjuryvojcybzvrbyickz\",
    \"address\": \"consequatur\",
    \"detach_files\": [
        \"98adc52b-966d-39db-809a-55902ee7228f\"
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/update/publication/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "content": "amniihfqcoynlazghdtqt",
    "is_private": true,
    "story_group_id": "82bcef28-e633-3da0-8d78-f8d6e14eee9e",
    "model": "project",
    "files": [
        "bajwbpilpmufinllwloau"
    ],
    "mention_ids": [
        "c099f01a-21d1-3e3d-9e1f-32307232547f"
    ],
    "latitude": -90,
    "longitude": -179,
    "location_name": "msjuryvojcybzvrbyickz",
    "address": "consequatur",
    "detach_files": [
        "98adc52b-966d-39db-809a-55902ee7228f"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/update/publication/{publication}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

publication   string   

The publication. Example: consequatur

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

content   string   

Must not be greater than 1000 characters. Example: amniihfqcoynlazghdtqt

is_private   boolean  optional   true false

Example: true

story_group_id   string  optional  

Must be a valid UUID. The id of an existing record in the story_groups table. Example: 82bcef28-e633-3da0-8d78-f8d6e14eee9e

model   string   

Example: project

Must be one of:

• project

files   string[]  optional  

Must not be greater than 10240 characters.

mention_ids   string[]  optional  

Must be a valid UUID. The id of an existing record in the users table.

latitude   number  optional  

Must be between -90 and 90. Example: -90

longitude   number  optional  

Must be between -180 and 180. Example: -179

location_name   string  optional  

Must not be greater than 255 characters. Example: msjuryvojcybzvrbyickz

address   string  optional  

Example: consequatur

detach_files   string[]  optional  

Must be a valid UUID. The id of an existing record in the publication_files table.

DELETE api/v1/delete/publication/{publicationId}

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/publication/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/publication/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/publication/{publicationId}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

publicationId   string   

Example: consequatur

GET api/v1/get/publication/list

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/publication/list" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/publication/list"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/publication/list

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/{publication}/publication

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/publication" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/publication"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{publication}/publication

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

publication   string   

Example: consequatur

GET api/v1/download/{publication_id}/publication/files

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/download/consequatur/publication/files" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/download/consequatur/publication/files"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/download/{publication_id}/publication/files

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

publication_id   string   

The ID of the publication. Example: consequatur

POST api/v1/join/files/publication/{publicationId}

Example request:

curl --request POST \
    "http://core.localhost/api/v1/join/files/publication/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/join/files/publication/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/join/files/publication/{publicationId}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

publicationId   string   

Example: consequatur

POST api/v1/store/reaction

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/reaction" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"😄\",
    \"model\": \"PUBLICATION\",
    \"model_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/reaction"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "😄",
    "model": "PUBLICATION",
    "model_id": "66529e01-d113-3473-8d6f-9e11e09332ea"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/reaction

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

type   string   

Example: 😄

Must be one of:

• 😐
• 🙂
• 😄
• 😎

model   string   

Example: PUBLICATION

Must be one of:

• PUBLICATION
• COMMENT

model_id   string  optional  

Must be a valid UUID. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

POST api/v1/store/publication/comment

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/publication/comment" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"content\": \"consequatur\",
    \"publication_id\": \"98adc52b-966d-39db-809a-55902ee7228f\",
    \"mention_ids\": [
        \"d48a46b6-3a18-3763-951d-66b7fdb284ae\"
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/store/publication/comment"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "content": "consequatur",
    "publication_id": "98adc52b-966d-39db-809a-55902ee7228f",
    "mention_ids": [
        "d48a46b6-3a18-3763-951d-66b7fdb284ae"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/publication/comment

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

content   string   

Example: consequatur

publication_id   string   

Must be a valid UUID. The id of an existing record in the publications table. Example: 98adc52b-966d-39db-809a-55902ee7228f

mention_ids   string[]  optional  

Must be a valid UUID. The id of an existing record in the users table.

POST api/v1/reply/to/comment/{commentId}

Example request:

curl --request POST \
    "http://core.localhost/api/v1/reply/to/comment/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"content\": \"consequatur\",
    \"publication_id\": \"98adc52b-966d-39db-809a-55902ee7228f\",
    \"mention_ids\": [
        \"d48a46b6-3a18-3763-951d-66b7fdb284ae\"
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/reply/to/comment/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "content": "consequatur",
    "publication_id": "98adc52b-966d-39db-809a-55902ee7228f",
    "mention_ids": [
        "d48a46b6-3a18-3763-951d-66b7fdb284ae"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/reply/to/comment/{commentId}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

commentId   string   

Example: consequatur

Body Parameters

content   string   

Example: consequatur

publication_id   string   

Must be a valid UUID. The id of an existing record in the publications table. Example: 98adc52b-966d-39db-809a-55902ee7228f

mention_ids   string[]  optional  

Must be a valid UUID. The id of an existing record in the users table.

GET api/v1/get/{publication}/comments

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/comments" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/comments"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{publication}/comments

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

publication   string   

Example: consequatur

POST api/v1/store/survey

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/survey" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"label\": \"consequatur\",
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"is_sent\": true,
    \"atelier_id\": \"consequatur\",
    \"is_anonymous\": true,
    \"options\": [],
    \"type\": \"select_multiple\",
    \"placeholder\": \"consequatur\",
    \"help\": \"consequatur\",
    \"required\": true,
    \"repeatable\": true
}"

const url = new URL(
    "http://core.localhost/api/v1/store/survey"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "label": "consequatur",
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "is_sent": true,
    "atelier_id": "consequatur",
    "is_anonymous": true,
    "options": [],
    "type": "select_multiple",
    "placeholder": "consequatur",
    "help": "consequatur",
    "required": true,
    "repeatable": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/survey

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

label   string   

Example: consequatur

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

is_sent   boolean    true false

Example: true

atelier_id   string   

The id of an existing record in the ateliers table. Example: consequatur

is_anonymous   boolean    true false

Example: true

options   object   

type   string   

Example: select_multiple

Must be one of:

• select
• select_multiple

placeholder   string  optional  

Example: consequatur

help   string  optional  

Example: consequatur

required   boolean    true false

Example: true

repeatable   boolean  optional   true false

Example: true

PUT api/v1/update/{survey}/survey

Example request:

curl --request PUT \
    "http://core.localhost/api/v1/update/consequatur/survey" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"label\": \"consequatur\",
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"is_sent\": false,
    \"atelier_id\": \"consequatur\",
    \"is_anonymous\": false,
    \"options\": [],
    \"type\": \"select\",
    \"placeholder\": \"consequatur\",
    \"help\": \"consequatur\",
    \"required\": false,
    \"repeatable\": true
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/survey"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "label": "consequatur",
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "is_sent": false,
    "atelier_id": "consequatur",
    "is_anonymous": false,
    "options": [],
    "type": "select",
    "placeholder": "consequatur",
    "help": "consequatur",
    "required": false,
    "repeatable": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PUT api/v1/update/{survey}/survey

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

survey   string   

Example: consequatur

Body Parameters

label   string   

Example: consequatur

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

is_sent   boolean    true false

Example: false

atelier_id   string   

The id of an existing record in the ateliers table. Example: consequatur

is_anonymous   boolean    true false

Example: false

options   object   

type   string   

Example: select

Must be one of:

• select
• select_multiple

placeholder   string  optional  

Example: consequatur

help   string  optional  

Example: consequatur

required   boolean    true false

Example: false

repeatable   boolean  optional   true false

Example: true

PATCH api/v1/send/{survey}/survey

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/send/consequatur/survey" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/send/consequatur/survey"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/send/{survey}/survey

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

survey   string   

Example: consequatur

DELETE api/v1/delete/{survey}/survey

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/survey" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/survey"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{survey}/survey

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

survey   string   

Example: consequatur

GET api/v1/get/surveys/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/surveys/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/surveys/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/surveys/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/atelier/{atelier}/surveys/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/atelier/consequatur/surveys/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/atelier/consequatur/surveys/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/atelier/{atelier}/surveys/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

atelier   string   

The atelier. Example: consequatur

PATCH api/v1/close/survey/{survey}

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/close/survey/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/close/survey/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/close/survey/{survey}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

survey   string   

The survey. Example: consequatur

GET api/v1/get/{survey}/survey

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/survey" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/survey"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{survey}/survey

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

survey   string   

Example: consequatur

GET api/v1/get/statistic/{survey}/survey

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/statistic/consequatur/survey" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/statistic/consequatur/survey"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/statistic/{survey}/survey

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

survey   string   

Example: consequatur

POST api/v1/survey_response/store

Example request:

curl --request POST \
    "http://core.localhost/api/v1/survey_response/store" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"survey_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"data\": []
}"

const url = new URL(
    "http://core.localhost/api/v1/survey_response/store"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "survey_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "data": []
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/survey_response/store

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

survey_id   string   

Must be a valid UUID. The id of an existing record in the surveys table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

data   object   

PUT api/v1/survey_response/{surveyResponse}/update

Example request:

curl --request PUT \
    "http://core.localhost/api/v1/survey_response/consequatur/update" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"survey_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\"
}"

const url = new URL(
    "http://core.localhost/api/v1/survey_response/consequatur/update"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "survey_id": "66529e01-d113-3473-8d6f-9e11e09332ea"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PUT api/v1/survey_response/{surveyResponse}/update

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

surveyResponse   string   

Example: consequatur

Body Parameters

survey_id   string   

Must be a valid UUID. The id of an existing record in the surveys table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

data   object  optional  

GET api/v1/get/survey_response/{surveyId}/survey

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/survey_response/consequatur/survey" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/survey_response/consequatur/survey"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/survey_response/{surveyId}/survey

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

surveyId   string   

Example: consequatur

GET api/v1/get/survey_response/{participatorId}/participant

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/survey_response/consequatur/participant" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/survey_response/consequatur/participant"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/survey_response/{participatorId}/participant

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

participatorId   string   

Example: consequatur

GET api/v1/sync/pull

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/sync/pull" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/sync/pull"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/sync/pull

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/sync/push

Example request:

curl --request POST \
    "http://core.localhost/api/v1/sync/push" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

const url = new URL(
    "http://core.localhost/api/v1/sync/push"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/sync/push

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

0   string  optional  

1   string  optional  

POST api/v1/send-invoice

Example request:

curl --request POST \
    "http://core.localhost/api/v1/send-invoice" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"qkunze@example.com\",
    \"stand_name\": \"consequatur\",
    \"stand_phone\": \"consequatur\",
    \"invoice_date\": \"consequatur\",
    \"invoice_number\": \"consequatur\",
    \"customer_name\": \"consequatur\",
    \"user\": \"consequatur\",
    \"products\": [
        {
            \"name\": \"consequatur\",
            \"quantity\": 45,
            \"price\": 56
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/send-invoice"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "qkunze@example.com",
    "stand_name": "consequatur",
    "stand_phone": "consequatur",
    "invoice_date": "consequatur",
    "invoice_number": "consequatur",
    "customer_name": "consequatur",
    "user": "consequatur",
    "products": [
        {
            "name": "consequatur",
            "quantity": 45,
            "price": 56
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/send-invoice

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

Must be a valid email address. Example: qkunze@example.com

stand_name   string   

Example: consequatur

stand_phone   string   

Example: consequatur

invoice_date   string   

Example: consequatur

invoice_number   string   

Example: consequatur

customer_name   string   

Example: consequatur

user   string   

Example: consequatur

products   object[]   

Must have at least 1 items.

name   string   

Example: consequatur

quantity   number   

Must be at least 1. Example: 45

price   number   

Must be at least 0. Example: 56

GET api/v1/builder/get/files

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/builder/get/files" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/builder/get/files"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/builder/get/files

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/builder/upload/files

Example request:

curl --request POST \
    "http://core.localhost/api/v1/builder/upload/files" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"files\": [
        \"vmqeopfuudtdsufvyvddq\"
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/builder/upload/files"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "files": [
        "vmqeopfuudtdsufvyvddq"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/builder/upload/files

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

files   string[]   

Must not be greater than 10240 characters.

DELETE api/v1/builder/delete/files

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/builder/delete/files" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"files\": [
        \"consequatur\"
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/builder/delete/files"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "files": [
        "consequatur"
    ]
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/builder/delete/files

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

files   string[]   

POST api/v1/builder/template/{template_id}/save

Example request:

curl --request POST \
    "http://core.localhost/api/v1/builder/template/consequatur/save" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"content\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/builder/template/consequatur/save"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "content": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/builder/template/{template_id}/save

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

template_id   string   

The ID of the template. Example: consequatur

Body Parameters

content   string   

Example: consequatur

POST api/v1/builder/template/{template}/save/subject

Example request:

curl --request POST \
    "http://core.localhost/api/v1/builder/template/consequatur/save/subject" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"subject\": \"vmqeopfuudtdsufvyvddq\",
    \"detach_files\": [
        \"462ee709-6d9f-345a-95e6-76f833111fb8\"
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/builder/template/consequatur/save/subject"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "subject": "vmqeopfuudtdsufvyvddq",
    "detach_files": [
        "462ee709-6d9f-345a-95e6-76f833111fb8"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/builder/template/{template}/save/subject

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

template   string   

The template. Example: consequatur

Body Parameters

subject   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

attachments   string[]  optional  

detach_files   string[]  optional  

Must be a valid UUID. The id of an existing record in the builder_template_attachements table.

GET api/v1/builder/template/{template_id}/load

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/builder/template/consequatur/load" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/builder/template/consequatur/load"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/builder/template/{template_id}/load

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

template_id   string   

The ID of the template. Example: consequatur

GET api/v1/builder/template/{template_id}/show

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/builder/template/consequatur/show" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/builder/template/consequatur/show"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/builder/template/{template_id}/show

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

template_id   string   

The ID of the template. Example: consequatur

POST api/v1/store/key/builder

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/key/builder" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"key\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/key/builder"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "key": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/key/builder

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

key   string   

Example: consequatur

GET api/v1/get/key/builder

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/key/builder" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/key/builder"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/key/builder

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/register

Example request:

curl --request POST \
    "http://core.localhost/api/v1/register" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"firstname\": \"vmqeopfuudtdsufvyvddq\",
    \"lastname\": \"amniihfqcoynlazghdtqt\",
    \"email\": \"andreanne00@example.org\",
    \"password\": \"O[2UZ5ij-e\\/dl4m{o,\"
}"

const url = new URL(
    "http://core.localhost/api/v1/register"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "firstname": "vmqeopfuudtdsufvyvddq",
    "lastname": "amniihfqcoynlazghdtqt",
    "email": "andreanne00@example.org",
    "password": "O[2UZ5ij-e\/dl4m{o,"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/register

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

firstname   string   

Must not be greater than 55 characters. Example: vmqeopfuudtdsufvyvddq

lastname   string   

Must not be greater than 55 characters. Example: amniihfqcoynlazghdtqt

email   string   

Must be a valid email address. Example: andreanne00@example.org

password   string   

Example: O[2UZ5ij-e/dl4m{o,

POST api/v1/login

Example request:

curl --request POST \
    "http://core.localhost/api/v1/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"qkunze@example.com\",
    \"password\": \"O[2UZ5ij-e\\/dl4m{o,\"
}"

const url = new URL(
    "http://core.localhost/api/v1/login"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "qkunze@example.com",
    "password": "O[2UZ5ij-e\/dl4m{o,"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/login

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

Must be a valid email address. The email of an existing record in the users table. Example: qkunze@example.com

password   string   

Example: O[2UZ5ij-e/dl4m{o,

POST api/v1/reset/password

Example request:

curl --request POST \
    "http://core.localhost/api/v1/reset/password" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"token\": \"consequatur\",
    \"password\": \"O[2UZ5ij-e\\/dl4m{o,\"
}"

const url = new URL(
    "http://core.localhost/api/v1/reset/password"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "token": "consequatur",
    "password": "O[2UZ5ij-e\/dl4m{o,"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/reset/password

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

token   string   

Example: consequatur

password   string   

Example: O[2UZ5ij-e/dl4m{o,

POST api/v1/create/password

Example request:

curl --request POST \
    "http://core.localhost/api/v1/create/password" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"token\": \"consequatur\",
    \"password\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/create/password"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "token": "consequatur",
    "password": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/create/password

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

token   string   

The confirmation_token of an existing record in the users table. Example: consequatur

password   string   

Example: consequatur

POST api/v1/logout

Example request:

curl --request POST \
    "http://core.localhost/api/v1/logout" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/logout"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/logout

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/user

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/user" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/user"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/user

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/user/password/update

Example request:

curl --request POST \
    "http://core.localhost/api/v1/user/password/update" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"old_password\": \"consequatur\",
    \"password\": \"O[2UZ5ij-e\\/dl4m{o,\"
}"

const url = new URL(
    "http://core.localhost/api/v1/user/password/update"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "old_password": "consequatur",
    "password": "O[2UZ5ij-e\/dl4m{o,"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/user/password/update

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

old_password   string   

Example: consequatur

password   string   

Example: O[2UZ5ij-e/dl4m{o,

POST api/v1/user/profile/update

Example request:

curl --request POST \
    "http://core.localhost/api/v1/user/profile/update" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/user/profile/update"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/user/profile/update

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

PATCH api/v1/user/{user}/info/update

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/user/consequatur/info/update" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"address\": \"vmqeopfuudtdsufvyvddq\",
    \"date_in_service\": \"12-06-2025\",
    \"social_security_number\": \"amniihfqcoynlazghdtqt\",
    \"employee_family_status_id\": \"82bcef28-e633-3da0-8d78-f8d6e14eee9e\",
    \"employee_post_category_id\": \"e4419155-5319-3498-a793-1f20eeafc66a\"
}"

const url = new URL(
    "http://core.localhost/api/v1/user/consequatur/info/update"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "address": "vmqeopfuudtdsufvyvddq",
    "date_in_service": "12-06-2025",
    "social_security_number": "amniihfqcoynlazghdtqt",
    "employee_family_status_id": "82bcef28-e633-3da0-8d78-f8d6e14eee9e",
    "employee_post_category_id": "e4419155-5319-3498-a793-1f20eeafc66a"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/user/{user}/info/update

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user   string   

The user. Example: consequatur

Body Parameters

address   string  optional  

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

date_in_service   string  optional  

Must be a valid date. Must be a valid date in the format d-m-Y. Example: 12-06-2025

social_security_number   string  optional  

Must not be greater than 50 characters. Example: amniihfqcoynlazghdtqt

employee_family_status_id   string  optional  

Must be a valid UUID. The id of an existing record in the employee_family_statuses table. Example: 82bcef28-e633-3da0-8d78-f8d6e14eee9e

employee_post_category_id   string  optional  

Must be a valid UUID. The id of an existing record in the employee_post_categories table. Example: e4419155-5319-3498-a793-1f20eeafc66a

GET api/v1/get/roles/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/roles/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/roles/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/roles/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/roles/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/roles/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/roles/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/roles/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/role

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/role" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/store/role"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/role

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

PATCH api/v1/update/{role_id}/role

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/role" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/role"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{role_id}/role

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

role_id   string   

The ID of the role. Example: consequatur

DELETE api/v1/delete/{role}/role

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/role" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/role"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{role}/role

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

role   string   

Example: consequatur

GET api/v1/role/{role_id}/getPermissionToRole

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/role/consequatur/getPermissionToRole" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/role/consequatur/getPermissionToRole"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/role/{role_id}/getPermissionToRole

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

role_id   string   

The ID of the role. Example: consequatur

POST api/v1/role/{role_id}/attributePermissionToRole

Example request:

curl --request POST \
    "http://core.localhost/api/v1/role/consequatur/attributePermissionToRole" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"input\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/role/consequatur/attributePermissionToRole"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "input": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/role/{role_id}/attributePermissionToRole

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

role_id   string   

The ID of the role. Example: consequatur

Body Parameters

input   string   

The name of an existing record in the permissions table. Example: consequatur

GET api/v1/get/permissions

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/permissions" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/permissions"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/permissions

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/{role_id}/role

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/role" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/role"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{role_id}/role

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

role_id   string   

The ID of the role. Example: consequatur

PUT api/v1/role/{role}/attributePermissionToUser

Example request:

curl --request PUT \
    "http://core.localhost/api/v1/role/consequatur/attributePermissionToUser" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"input\": \"consequatur\",
    \"value\": true
}"

const url = new URL(
    "http://core.localhost/api/v1/role/consequatur/attributePermissionToUser"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "input": "consequatur",
    "value": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PUT api/v1/role/{role}/attributePermissionToUser

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

role   string   

The role. Example: consequatur

Body Parameters

input   string   

The name of an existing record in the permissions table. Example: consequatur

team   string  optional  

The id of an existing record in the teams table.

value   boolean    true false

Example: true

GET api/v1/get/users/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/users/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/users/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/users/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/users/datatables

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/users/datatables" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/users/datatables"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/users/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/user

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/user" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "gender=male"\
    --form "lastname=vmqeopfuudtdsufvyvddq"\
    --form "firstname=amniihfqcoynlazghdtqt"\
    --form "email=andreanne00@example.org"\
    --form "phone_code=consequatur"\
    --form "phone=mqeopfuudtdsufvyv"\
    --form "role=92f7c094-3063-3c79-bbfc-7e096d42f6dd"\
    --form "office_id=consequatur"\
    --form "avatar=@/tmp/phpB0PLWI" 

const url = new URL(
    "http://core.localhost/api/v1/store/user"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('gender', 'male');
body.append('lastname', 'vmqeopfuudtdsufvyvddq');
body.append('firstname', 'amniihfqcoynlazghdtqt');
body.append('email', 'andreanne00@example.org');
body.append('phone_code', 'consequatur');
body.append('phone', 'mqeopfuudtdsufvyv');
body.append('role', '92f7c094-3063-3c79-bbfc-7e096d42f6dd');
body.append('office_id', 'consequatur');
body.append('avatar', document.querySelector('input[name="avatar"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/user

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

gender   string   

Example: male

Must be one of:

• male
• female

lastname   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

firstname   string   

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

email   string   

Must be a valid email address. Must not be greater than 255 characters. Example: andreanne00@example.org

phone_code   string  optional  

This field is required when phone is present. Example: consequatur

phone   string  optional  

This field is required when phone_code is present. Must not be greater than 20 characters. Example: mqeopfuudtdsufvyv

role   string  optional  

Must be a valid UUID. The id of an existing record in the roles table. Example: 92f7c094-3063-3c79-bbfc-7e096d42f6dd

office_id   string   

The id of an existing record in the offices table. Example: consequatur

avatar   file  optional  

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/phpB0PLWI

PATCH api/v1/update/{user}/status

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/status"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{user}/status

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user   string   

Example: consequatur

PATCH api/v1/update/{user}/user

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/cc2b2bc3-dfd1-1a07-8554-3a18f870f341/user" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "gender=male"\
    --form "lastname=vmqeopfuudtdsufvyvddq"\
    --form "firstname=amniihfqcoynlazghdtqt"\
    --form "email=andreanne00@example.org"\
    --form "phone_code=consequatur"\
    --form "phone=mqeopfuudtdsufvyv"\
    --form "role=92f7c094-3063-3c79-bbfc-7e096d42f6dd"\
    --form "active="\
    --form "office_id=consequatur"\
    --form "delete_image=1"\
    --form "nbrHolidays=11613.31890586"\
    --form "avatar=@/tmp/phphdzTjG" 

const url = new URL(
    "http://core.localhost/api/v1/update/cc2b2bc3-dfd1-1a07-8554-3a18f870f341/user"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('gender', 'male');
body.append('lastname', 'vmqeopfuudtdsufvyvddq');
body.append('firstname', 'amniihfqcoynlazghdtqt');
body.append('email', 'andreanne00@example.org');
body.append('phone_code', 'consequatur');
body.append('phone', 'mqeopfuudtdsufvyv');
body.append('role', '92f7c094-3063-3c79-bbfc-7e096d42f6dd');
body.append('active', '');
body.append('office_id', 'consequatur');
body.append('delete_image', '1');
body.append('nbrHolidays', '11613.31890586');
body.append('avatar', document.querySelector('input[name="avatar"]').files[0]);

fetch(url, {
    method: "PATCH",
    headers,
    body,
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/{user}/user

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

user   string   

Example: cc2b2bc3-dfd1-1a07-8554-3a18f870f341

Body Parameters

gender   string   

Example: male

Must be one of:

• male
• female

lastname   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

firstname   string   

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

email   string   

Must be a valid email address. Must not be greater than 255 characters. Example: andreanne00@example.org

phone_code   string  optional  

This field is required when phone is present. Example: consequatur

phone   string  optional  

This field is required when phone_code is present. Must not be greater than 20 characters. Example: mqeopfuudtdsufvyv

role   string  optional  

Must be a valid UUID. The id of an existing record in the roles table. Example: 92f7c094-3063-3c79-bbfc-7e096d42f6dd

active   boolean  optional   true false

Example: false

office_id   string   

The id of an existing record in the offices table. Example: consequatur

avatar   file  optional  

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/phphdzTjG

delete_image   boolean  optional   true false

Example: true

nbrHolidays   number  optional  

Example: 11613.31890586

DELETE api/v1/delete/{user_id}/user

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/user" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/user"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/{user_id}/user

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   string   

The ID of the user. Example: consequatur

GET api/v1/download-user-model

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/download-user-model" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/download-user-model"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/download-user-model

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/import/users

Example request:

curl --request POST \
    "http://core.localhost/api/v1/import/users" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/import/users"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/import/users

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/export/users

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/export/users" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/export/users"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/export/users

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/permission/{permissionName}

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/permission/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/permission/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/permission/{permissionName}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

permissionName   string   

Example: consequatur

GET api/v1/{user}/user

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/consequatur/user" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/consequatur/user"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/{user}/user

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user   string   

Example: consequatur

POST api/v1/users/assignTeam

Example request:

curl --request POST \
    "http://core.localhost/api/v1/users/assignTeam" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/users/assignTeam"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/users/assignTeam

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/imap-config/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/imap-config/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/imap-config/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/imap-config/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/imap-config

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/imap-config" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"incoming\": {
        \"host\": \"vmqeopfuudtdsufvyvddq\",
        \"port\": 1,
        \"encryption\": \"starttls\",
        \"validate_cert\": false
    },
    \"outgoing\": {
        \"host\": \"vmqeopfuudtdsufvyvddq\",
        \"port\": 1,
        \"encryption\": \"ssl\"
    }
}"

const url = new URL(
    "http://core.localhost/api/v1/store/imap-config"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "incoming": {
        "host": "vmqeopfuudtdsufvyvddq",
        "port": 1,
        "encryption": "starttls",
        "validate_cert": false
    },
    "outgoing": {
        "host": "vmqeopfuudtdsufvyvddq",
        "port": 1,
        "encryption": "ssl"
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/imap-config

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

incoming   object   

host   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

port   integer   

Must be at least 1. Must not be greater than 65535. Example: 1

encryption   string   

Example: starttls

Must be one of:

• tls
• ssl
• false
• starttls
• notls

validate_cert   boolean  optional   true false

Example: false

outgoing   object   

host   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

port   integer   

Must be at least 1. Must not be greater than 65535. Example: 1

encryption   string   

Example: ssl

Must be one of:

• tls
• ssl
• false
• starttls
• notls

POST api/v1/set/user/imap/configs

Example request:

curl --request POST \
    "http://core.localhost/api/v1/set/user/imap/configs" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"username\": \"qkunze@example.com\",
    \"fullname\": \"opfuudtdsufvyvddqamni\",
    \"password\": \";4[*UyPJ\\\"}\"
}"

const url = new URL(
    "http://core.localhost/api/v1/set/user/imap/configs"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "username": "qkunze@example.com",
    "fullname": "opfuudtdsufvyvddqamni",
    "password": ";4[*UyPJ\"}"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/set/user/imap/configs

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

username   string   

Must be a valid email address. Example: qkunze@example.com

fullname   string   

Must not be greater than 255 characters. Example: opfuudtdsufvyvddqamni

password   string   

Must be at least 8 characters. Example: ;4[*UyPJ"}

GET api/v1/get/user/imap/configs

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/user/imap/configs" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/user/imap/configs"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/user/imap/configs

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/logout/user/imap/configs

Example request:

curl --request POST \
    "http://core.localhost/api/v1/logout/user/imap/configs" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/logout/user/imap/configs"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/logout/user/imap/configs

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/folders

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/folders" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/folders"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/folders

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/emails

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/emails" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/emails"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/emails

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/folder/email

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/folder/email" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/folder/email"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/folder/email

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/send-email

Example request:

curl --request POST \
    "http://core.localhost/api/v1/send-email" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "to[]=qkunze@example.com"\
    --form "cc[]=claire77@example.net"\
    --form "bcc[]=reynolds.monty@example.net"\
    --form "subject=fvyvddqamniihfqcoynla"\
    --form "message=consequatur"\
    --form "scheduled_at=2025-06-12 12:56"\
    --form "priority=1 (Highest)"\
    --form "request_receipt="\
    --form "attachments[]=@/tmp/php1O5Gdr" 

const url = new URL(
    "http://core.localhost/api/v1/send-email"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('to[]', 'qkunze@example.com');
body.append('cc[]', 'claire77@example.net');
body.append('bcc[]', 'reynolds.monty@example.net');
body.append('subject', 'fvyvddqamniihfqcoynla');
body.append('message', 'consequatur');
body.append('scheduled_at', '2025-06-12 12:56');
body.append('priority', '1 (Highest)');
body.append('request_receipt', '');
body.append('attachments[]', document.querySelector('input[name="attachments[]"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/send-email

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

to   string[]  optional  

Must be a valid email address.

cc   string[]  optional  

Must be a valid email address.

bcc   string[]  optional  

Must be a valid email address.

subject   string   

Must not be greater than 255 characters. Example: fvyvddqamniihfqcoynla

message   string   

Example: consequatur

attachments   file[]  optional  

Must be a file.

scheduled_at   string  optional  

Must be a valid date in the format Y-m-d H:i. Example: 2025-06-12 12:56

priority   string  optional  

Example: 1 (Highest)

Must be one of:

• 1 (Highest)
• 2 (High)
• 3 (Normal)
• 4 (Low)
• 5 (Lowest)

request_receipt   boolean  optional   true false

Example: false

GET api/v1/get/email/priorities

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/email/priorities" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/email/priorities"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/email/priorities

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/email/read

Example request:

curl --request POST \
    "http://core.localhost/api/v1/email/read" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"folder\": \"consequatur\",
    \"email_ids\": [
        17
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/email/read"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "folder": "consequatur",
    "email_ids": [
        17
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/email/read

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

folder   string   

Example: consequatur

email_ids   integer[]  optional  

POST api/v1/mark/asRead/email

Example request:

curl --request POST \
    "http://core.localhost/api/v1/mark/asRead/email" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"folder\": \"consequatur\",
    \"email_ids\": [
        17
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/mark/asRead/email"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "folder": "consequatur",
    "email_ids": [
        17
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/mark/asRead/email

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

folder   string   

Example: consequatur

email_ids   integer[]  optional  

POST api/v1/mark/asUnread/email

Example request:

curl --request POST \
    "http://core.localhost/api/v1/mark/asUnread/email" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"folder\": \"consequatur\",
    \"email_ids\": [
        17
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/mark/asUnread/email"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "folder": "consequatur",
    "email_ids": [
        17
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/mark/asUnread/email

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

folder   string   

Example: consequatur

email_ids   integer[]  optional  

POST api/v1/mark/important/email

Example request:

curl --request POST \
    "http://core.localhost/api/v1/mark/important/email" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"folder\": \"consequatur\",
    \"email_ids\": [
        17
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/mark/important/email"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "folder": "consequatur",
    "email_ids": [
        17
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/mark/important/email

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

folder   string   

Example: consequatur

email_ids   integer[]  optional  

POST api/v1/mark/not/important/email

Example request:

curl --request POST \
    "http://core.localhost/api/v1/mark/not/important/email" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"folder\": \"consequatur\",
    \"email_ids\": [
        17
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/mark/not/important/email"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "folder": "consequatur",
    "email_ids": [
        17
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/mark/not/important/email

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

folder   string   

Example: consequatur

email_ids   integer[]  optional  

POST api/v1/emails/reply/{emailId}

Example request:

curl --request POST \
    "http://core.localhost/api/v1/emails/reply/consequatur" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "folder=consequatur"\
    --form "to[]=carolyne.luettgen@example.org"\
    --form "cc[]=russel.bert@example.net"\
    --form "bcc[]=reichel.charity@example.net"\
    --form "subject=yvddqamniihfqcoynlazg"\
    --form "message=consequatur"\
    --form "request_receipt=1"\
    --form "attachments[]=@/tmp/phpCkUkY0" 

const url = new URL(
    "http://core.localhost/api/v1/emails/reply/consequatur"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('folder', 'consequatur');
body.append('to[]', 'carolyne.luettgen@example.org');
body.append('cc[]', 'russel.bert@example.net');
body.append('bcc[]', 'reichel.charity@example.net');
body.append('subject', 'yvddqamniihfqcoynlazg');
body.append('message', 'consequatur');
body.append('request_receipt', '1');
body.append('attachments[]', document.querySelector('input[name="attachments[]"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/emails/reply/{emailId}

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

emailId   string   

Example: consequatur

Body Parameters

folder   string   

Example: consequatur

to   string[]  optional  

Must be a valid email address.

cc   string[]  optional  

Must be a valid email address.

bcc   string[]  optional  

Must be a valid email address.

subject   string   

Must not be greater than 255 characters. Example: yvddqamniihfqcoynlazg

message   string   

Example: consequatur

attachments   file[]  optional  

Must be a file.

priority   string  optional  

request_receipt   boolean  optional   true false

Example: true

POST api/v1/transfer/email/{mailId}

Example request:

curl --request POST \
    "http://core.localhost/api/v1/transfer/email/consequatur" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "folder=consequatur"\
    --form "to[]=carolyne.luettgen@example.org"\
    --form "cc[]=russel.bert@example.net"\
    --form "bcc[]=reichel.charity@example.net"\
    --form "subject=yvddqamniihfqcoynlazg"\
    --form "message=consequatur"\
    --form "request_receipt="\
    --form "attachments[][url]=http://kunze.biz/iste-laborum-eius-est-dolor.html"\
    --form "attachments[][name]=consequatur"\
    --form "newAttachments[]=@/tmp/phpHh1Uwl" 

const url = new URL(
    "http://core.localhost/api/v1/transfer/email/consequatur"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('folder', 'consequatur');
body.append('to[]', 'carolyne.luettgen@example.org');
body.append('cc[]', 'russel.bert@example.net');
body.append('bcc[]', 'reichel.charity@example.net');
body.append('subject', 'yvddqamniihfqcoynlazg');
body.append('message', 'consequatur');
body.append('request_receipt', '');
body.append('attachments[][url]', 'http://kunze.biz/iste-laborum-eius-est-dolor.html');
body.append('attachments[][name]', 'consequatur');
body.append('newAttachments[]', document.querySelector('input[name="newAttachments[]"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/transfer/email/{mailId}

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

mailId   string   

Example: consequatur

Body Parameters

folder   string   

Example: consequatur

to   string[]  optional  

Must be a valid email address.

cc   string[]  optional  

Must be a valid email address.

bcc   string[]  optional  

Must be a valid email address.

subject   string   

Must not be greater than 255 characters. Example: yvddqamniihfqcoynlazg

message   string   

Example: consequatur

attachments   object[]  optional  

url   string   

Example: http://kunze.biz/iste-laborum-eius-est-dolor.html

name   string   

Example: consequatur

newAttachments   file[]  optional  

Must be a file.

priority   string  optional  

request_receipt   boolean  optional   true false

Example: false

POST api/v1/restore/email

Example request:

curl --request POST \
    "http://core.localhost/api/v1/restore/email" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email_ids\": [
        17
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/restore/email"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email_ids": [
        17
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/restore/email

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email_ids   integer[]  optional  

POST api/v1/email/changeFolder

Example request:

curl --request POST \
    "http://core.localhost/api/v1/email/changeFolder" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email_ids\": [
        17
    ],
    \"start_folder\": \"consequatur\",
    \"folder\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/email/changeFolder"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email_ids": [
        17
    ],
    "start_folder": "consequatur",
    "folder": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/email/changeFolder

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email_ids   integer[]  optional  

start_folder   string   

Example: consequatur

folder   string   

Example: consequatur

POST api/v1/delete/email

Example request:

curl --request POST \
    "http://core.localhost/api/v1/delete/email" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/email"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/delete/email

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/delete/email/to/Trash

Example request:

curl --request POST \
    "http://core.localhost/api/v1/delete/email/to/Trash" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email_ids\": [
        17
    ],
    \"folder\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/delete/email/to/Trash"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email_ids": [
        17
    ],
    "folder": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/delete/email/to/Trash

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email_ids   integer[]  optional  

folder   string   

Example: consequatur

POST api/v1/create/folder

Example request:

curl --request POST \
    "http://core.localhost/api/v1/create/folder" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"folder_name\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/create/folder"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "folder_name": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/create/folder

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

folder_name   string   

Example: consequatur

DELETE api/v1/delete/folder

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/folder" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"folder_name\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/delete/folder"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "folder_name": "consequatur"
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/folder

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

folder_name   string   

Example: consequatur

GET api/v1/get/user/contact/email

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/user/contact/email" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/user/contact/email"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/user/contact/email

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

PUT api/v1/cancel/scheduled-emails/{id}

Example request:

curl --request PUT \
    "http://core.localhost/api/v1/cancel/scheduled-emails/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/cancel/scheduled-emails/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PUT api/v1/cancel/scheduled-emails/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the scheduled email. Example: consequatur

PUT api/v1/update/scheduled-emails/{id}

Example request:

curl --request PUT \
    "http://core.localhost/api/v1/update/scheduled-emails/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"scheduled_at\": \"2106-07-12\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/scheduled-emails/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "scheduled_at": "2106-07-12"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PUT api/v1/update/scheduled-emails/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the scheduled email. Example: consequatur

Body Parameters

scheduled_at   string   

Must be a valid date. Must be a date after now. Example: 2106-07-12

DELETE api/v1/delete/scheduled-emails/{id}

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/scheduled-emails/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/scheduled-emails/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/scheduled-emails/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the scheduled email. Example: consequatur

POST api/v1/download/attachement

Example request:

curl --request POST \
    "http://core.localhost/api/v1/download/attachement" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"folder_path\": \"consequatur\",
    \"message_uid\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/download/attachement"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "folder_path": "consequatur",
    "message_uid": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/download/attachement

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

folder_path   string   

Example: consequatur

message_uid   string   

Example: consequatur

GET api/v1/get/signature

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/signature" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/signature"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/signature

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/actif/signature

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/actif/signature" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/actif/signature"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/actif/signature

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/signature

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/signature" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"content\": \"consequatur\",
    \"enabled\": false
}"

const url = new URL(
    "http://core.localhost/api/v1/store/signature"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "content": "consequatur",
    "enabled": false
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/signature

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

content   string   

Example: consequatur

enabled   boolean  optional   true false

Example: false

PATCH api/v1/update/signature/{signature}

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/signature/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"content\": \"consequatur\",
    \"enabled\": true
}"

const url = new URL(
    "http://core.localhost/api/v1/update/signature/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "content": "consequatur",
    "enabled": true
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/signature/{signature}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

signature   string   

The signature. Example: consequatur

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

content   string   

Example: consequatur

enabled   boolean  optional   true false

Example: true

PATCH api/v1/select/signature/{signature}

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/select/signature/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/select/signature/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/select/signature/{signature}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

signature   string   

The signature. Example: consequatur

DELETE api/v1/delete/signature/{signature}

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/signature/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/signature/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/delete/signature/{signature}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

signature   string   

The signature. Example: consequatur

DELETE api/v1/remove/image/signature/{signature}

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/remove/image/signature/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/remove/image/signature/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/remove/image/signature/{signature}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

signature   string   

The signature. Example: consequatur

GET api/v1/get/schedule/mail/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/schedule/mail/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/schedule/mail/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/schedule/mail/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/schedule/{mail}/mail

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/schedule/consequatur/mail" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/schedule/consequatur/mail"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/schedule/{mail}/mail

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

mail   string   

Example: consequatur

GET api/v1/get/widgets

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/widgets" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/widgets"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/widgets

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/get/{widget}/widget

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/widget" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/widget"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/{widget}/widget

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

widget   string   

Example: consequatur

GET api/v1/get/user-widgets

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/user-widgets" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/user-widgets"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/user-widgets

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/store/user-widget

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/user-widget" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"widget_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"weight\": 56
}"

const url = new URL(
    "http://core.localhost/api/v1/store/user-widget"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "widget_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "weight": 56
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/user-widget

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

widget_id   string   

Must be a valid UUID. The id of an existing record in the widgets table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

weight   integer   

Must be at least 0. Example: 56

PUT api/v1/update/user-widgets

Example request:

curl --request PUT \
    "http://core.localhost/api/v1/update/user-widgets" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"widgets\": [
        {
            \"id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
            \"row\": 56,
            \"column\": 16,
            \"weight\": 50,
            \"height\": 55
        }
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/update/user-widgets"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "widgets": [
        {
            "id": "66529e01-d113-3473-8d6f-9e11e09332ea",
            "row": 56,
            "column": 16,
            "weight": 50,
            "height": 55
        }
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PUT api/v1/update/user-widgets

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

widgets   object[]   

id   string   

Must be a valid UUID. The id of an existing record in the user_widgets table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

row   integer   

Must be at least 0. Example: 56

column   integer   

Must be at least 0. Example: 16

weight   integer   

Must be at least 0. Example: 50

height   integer   

Must be at least 0. Example: 55

DELETE api/v1/remove/{id}/user-widget

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/remove/consequatur/user-widget" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/remove/consequatur/user-widget"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request    Try it out ⚡   

DELETE api/v1/remove/{id}/user-widget

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the remove. Example: consequatur

Gestion de rendez-vous

APIs pour gerer les rendez-vous

Récupère la liste des rendez-vous de la société.

requires authentication

GET /get/appointment/collection

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/appointment/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/appointment/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
  "appointments": [
    {
      "id": "7e6f3a3b-bb98-4a6e-89fd-0f8ce1cf67a1",
      "title": "Réunion stratégique",
      "status": "scheduled",
      "status_en": "Scheduled",
      "status_fr": "Programmé",
     "status_color": "primary",
     "frequency_appointment": "minute",
     "frequency_count_appointment": "2",
     "period": "before",
     "start_time": "11-06-2025 17:33",
     "end_time": "11-06-2025 19:32",
      "description": "Réunion mensuelle avec l'équipe",
      "location": "cotonou",
      "send_location": false,
      "link": "https:\/\/meet.example.com\/abc123",
      "time_zone_id": "415778a5-f3c0-437a-ace2-bc9cf4b7bfbc",
      "appointment_type_id": "cefc8802-882c-487e-a97d-7e7474215e8d",
      "recurring_appointment_id": null,
      "appointment_room_id": "35106371-a711-48ba-a1d2-6c8e8a608b81",

      "appointment_room": {
      "id": "35106371-a711-48ba-a1d2-6c8e8a608b81",
      "name": "SALLE 1",
      "created_at": "2025-06-10 18:44:59",
      "updated_at": "2025-06-10 18:44:59",
      "society_id": "17da4b27-32b3-4fb3-82b6-3d93967d00fe"
      },

        "creator_id": "47dd45d7-7381-46c0-a18d-94c19e8b26d4",
         "participants_count": null,

         "participants": [
         {
         "appointment_id": "f2ae1d21-d1de-4052-a575-a3bca297f508",
         "participant": {
         "id": "2f195329-4e9a-4f7e-8569-7fda1c5f6b55",
         "gender": "male",
         "contactType": "particular",
         "lastname": "JOHN",
         "firstname": "DOE",
         "phone": [
         "62786175"
         ],
         "email": "johndoe@gmail.com",
         "customer": true,
         "supplier": false,
         "birthday": null,
         "website": null,
         "avatar": null,
         "created_at": "2025-05-23 13:04:42",
         "updated_at": "2025-05-23 13:04:42",
         "currency_id": "c69a3d9f-c986-4149-a761-42b85bfb491a",
         "company_id": null,
         "post_id": null,
         "office_id": null,
         "society_id": "17da4b27-32b3-4fb3-82b6-3d93967d00fe",
         "enable_portal": false,
         "confirmation_token": "$2y$12$eVnYsZqvOPbgTveoVOR.Qe6YnM0cgatQ7GxCTLohwxnVawlji",
         "email_verified_at": null,
         "subcontractor": false,
         "partner": false,
         "exchange_rate": "1.0000",
         "prospect": false,
         "job_title": null,
         "status": null,
         "avatar_url": "http:\/\/netbyus.core.localhost\/assets\/blank.png",
         "first_address_infos": "",
         "birth": "",
         "fullname": "JOHN doe",
         "phones": "62786175"
         },
         "available_status": "WAITING",
         "available_status_en": "Waiting",
         "available_status_fr": "En attente",
         "available_status_color": "warning",
         "presence_status": null,
         "created_at": "2025-06-11 16:33:02",
         "updated_at": "2025-06-11 16:33:02"
         }


         "notes": [],
         "guests": [],

         "customers": [
         {
         "id": "2f195329-4e9a-4f7e-8569-7fda1c5f6b55",
        "fullname": "JOHN doe",
         "lastname": "JOHN",
         "firstname": "doe",
         "gender": "male",
         "contactType_fr": "Particulier",
         "contactType_en": "Particular",
         "contactType": "particular",
         "phone": [
         "62786175"
         ],

         "birthday": null,
         "email": "johndoe@gmail.com",
         "avatar": "http:\/\/netbyus.core.localhost\/assets\/blank.png",
         "supplier": false,
         "customer": true,
         "subcontractor": false,
         "partner": false,
         "prospect": false,
         "website": null,
         "company_id": null,
         "post_id": null,
         "exchange_rate": "1.0000",
         "city_id": null,
         "district": null,
         "block": null,
         "square_number": null,
         "plot": null,
         "house": null
         }

         ],
         "collaborators": []

    }
  ]
}
 

Request    Try it out ⚡   

GET api/v1/get/appointment/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

tenant   string   

UUID du tenant.

Cette route retourne tous les rendez-vous associés à la société du locataire courant, triés par date de création décroissante. Example: consequatur

Récupère les rendez-vous à afficher dans le calendrier

requires authentication

GET get/calendar/appointment

Cette méthode retourne les rendez-vous filtrés selon une période donnée et d'autres critères facultatifs pour un affichage dans un calendrier L'utilisateur doit avoir les permissions.

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/calendar/appointment?startDate=consequatur&endDate=consequatur&appointmentType=consequatur&status=consequatur&search=consequatur&rdv_created=&rdv_guested=" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/calendar/appointment"
);

const params = {
    "startDate": "consequatur",
    "endDate": "consequatur",
    "appointmentType": "consequatur",
    "status": "consequatur",
    "search": "consequatur",
    "rdv_created": "0",
    "rdv_guested": "0",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
"appointments": [
         {
         "id": "7e6f3a3b-bb98-4a6e-89fd-0f8ce1cf67a1",
         "title": "Réunion stratégique",
         "status": "scheduled",
         "status_en": "Scheduled",
         "status_fr": "Programmé",
         "status_color": "primary",
         "frequency_appointment": "minute",
         "frequency_count_appointment": "2",
         "period": "before",
         "start_time": "11-06-2025 17:33",
         "end_time": "11-06-2025 19:32",
         "description": "Réunion mensuelle avec l'équipe",
         "location": "cotonou",
         "send_location": false,
         "link": "https:\/\/meet.example.com\/abc123",
         "time_zone_id": "415778a5-f3c0-437a-ace2-bc9cf4b7bfbc",
         "appointment_type_id": "cefc8802-882c-487e-a97d-7e7474215e8d",
         "recurring_appointment_id": null,
         "appointment_room_id": "35106371-a711-48ba-a1d2-6c8e8a608b81",

         "appointment_room": {
         "id": "35106371-a711-48ba-a1d2-6c8e8a608b81",
         "name": "SALLE 1",
         "created_at": "2025-06-10 18:44:59",
         "updated_at": "2025-06-10 18:44:59",
         "society_id": "17da4b27-32b3-4fb3-82b6-3d93967d00fe"
         },

         "creator_id": "47dd45d7-7381-46c0-a18d-94c19e8b26d4",
         "participants_count": null,

         "participants": [
         {
         "appointment_id": "f2ae1d21-d1de-4052-a575-a3bca297f508",
         "participant": {
         "id": "2f195329-4e9a-4f7e-8569-7fda1c5f6b55",
         "gender": "male",
         "contactType": "particular",
         "lastname": "JOHN",
         "firstname": "DOE",
         "phone": [
         "62786175"
         ],
         "email": "johndoe@gmail.com",
         "customer": true,
         "supplier": false,
         "birthday": null,
         "website": null,
         "avatar": null,
         "created_at": "2025-05-23 13:04:42",
         "updated_at": "2025-05-23 13:04:42",
         "currency_id": "c69a3d9f-c986-4149-a761-42b85bfb491a",
         "company_id": null,
         "post_id": null,
         "office_id": null,
         "society_id": "17da4b27-32b3-4fb3-82b6-3d93967d00fe",
         "enable_portal": false,
         "confirmation_token": "$2y$12$eVnYsZqvOPbgTveoVOR.Qe6YnM0cgatQ7GxCTLohwxnVawlji",
         "email_verified_at": null,
         "subcontractor": false,
         "partner": false,
         "exchange_rate": "1.0000",
         "prospect": false,
         "job_title": null,
         "status": null,
         "avatar_url": "http:\/\/netbyus.core.localhost\/assets\/blank.png",
         "first_address_infos": "",
         "birth": "",
         "fullname": "JOHN Doe",
         "phones": "62786175"
         },
         "available_status": "WAITING",
         "available_status_en": "Waiting",
         "available_status_fr": "En attente",
         "available_status_color": "warning",
         "presence_status": null,
         "created_at": "2025-06-11 16:33:02",
         "updated_at": "2025-06-11 16:33:02"
         }
 

Example response (403):

{
    "message": "Vous n'avez pas la permission d'effectuer cette action."
}
 

Request    Try it out ⚡   

GET api/v1/get/calendar/appointment

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

tenant   string   

. Example: consequatur

Query Parameters

startDate   string   

date . Example: consequatur

endDate   string   

date . Example: consequatur

appointmentType   string  optional  

uuid . Example: consequatur

status   string  optional  

. Example: consequatur

search   string  optional  

. Example: consequatur

rdv_created   boolean  optional   true false

. Example: false

rdv_guested   boolean  optional   true false

. Example: false

Récupère les rendez-vous formatés pour un tableau de données (DataTable)

GET get/appointments/datatables

Cette méthode retourne les rendez-vous sous un format compatible avec les DataTables JS. Elle inclut la pagination, le tri, les filtres par date, type, statut et recherche globale. L'accès est restreint aux utilisateurs avec les permissions VIEW ou VIEW_ALL.

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/appointments/datatables?startDate=consequatur&endDate=consequatur&appointmentType=consequatur&status=consequatur&length=17&start=17&order[]=consequatur&search=consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/appointments/datatables"
);

const params = {
    "startDate": "consequatur",
    "endDate": "consequatur",
    "appointmentType": "consequatur",
    "status": "consequatur",
    "length": "17",
    "start": "17",
    "order[0]": "consequatur",
    "search": "consequatur",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "draw": 1,
    "recordsTotal": 25,
    "recordsFiltered": 10,
    "data": [
        {
            "id": "2f6b234a-9b99-4a4c-bccf-71c8411fd1b5",
            "title": "Réunion mensuelle",
            "start_time": "2025-06-10 10:00:00",
            "end_time": "2025-06-10 11:00:00",
            "status": "scheduled",
            "description": "Point sur les performances du mois",
            "location": "Salle 3A",
            "participants_count": 5,
            "link": "https://meet.example.com/rdv123",
            "appointmentType": "Réunion d'équipe",
            "Actions": null
        }
    ]
}
 

Example response (403):

{
    "message": "Vous n'avez pas la permission d'effectuer cette action."
}
 

Request    Try it out ⚡   

GET api/v1/get/appointments/datatables

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

tenant   string  optional  

required. Example: consequatur

Query Parameters

startDate   string  optional  

date required. Example: consequatur

endDate   string  optional  

date required. Example: consequatur

appointmentType   string  optional  

UUID. Example: consequatur

status   string  optional  

Statut du rendez-vous (doit faire partie des statuts définis). Example: consequatur

length   integer   

Nombre de résultats par page. Example: 17

start   integer   

Index de départ pour la pagination. Example: 17

order   string[]   

Informations de tri.

search   string  optional  

Recherche globale. Example: consequatur

Crée un nouveau rendez-vous.

requires authentication

POST store/appointment

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/appointment" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"consequatur\",
    \"appointment_type_id\": \"consequatur\",
    \"start_time\": \"consequatur\",
    \"end_time\": \"consequatur\",
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"location\": \"consequatur\",
    \"link\": \"consequatur\",
    \"sent_email\": \"qkunze@example.com\",
    \"time_zone_id\": \"consequatur\",
    \"send_location\": false,
    \"appointment_room_id\": \"consequatur\",
    \"users\": [
        \"consequatur\"
    ],
    \"contacts\": [
        \"consequatur\"
    ],
    \"guest_emails\": [
        \"consequatur\"
    ],
    \"frequency_appointment\": \"consequatur\",
    \"frequency_count_appointment\": 17,
    \"recurring_date\": \"consequatur\",
    \"frequency\": \"consequatur\",
    \"limit_by\": \"consequatur\",
    \"limit_count\": 17,
    \"frequency_count\": 17,
    \"limit_date\": \"consequatur\",
    \"is_recurring\": false
}"

const url = new URL(
    "http://core.localhost/api/v1/store/appointment"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "consequatur",
    "appointment_type_id": "consequatur",
    "start_time": "consequatur",
    "end_time": "consequatur",
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "location": "consequatur",
    "link": "consequatur",
    "sent_email": "qkunze@example.com",
    "time_zone_id": "consequatur",
    "send_location": false,
    "appointment_room_id": "consequatur",
    "users": [
        "consequatur"
    ],
    "contacts": [
        "consequatur"
    ],
    "guest_emails": [
        "consequatur"
    ],
    "frequency_appointment": "consequatur",
    "frequency_count_appointment": 17,
    "recurring_date": "consequatur",
    "frequency": "consequatur",
    "limit_by": "consequatur",
    "limit_count": 17,
    "frequency_count": 17,
    "limit_date": "consequatur",
    "is_recurring": false
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):

{
"appointments": [
{
"id": "7e6f3a3b-bb98-4a6e-89fd-0f8ce1cf67a1",
"title": "Réunion stratégique",
"status": "scheduled",
"status_en": "Scheduled",
"status_fr": "Programmé",
"status_color": "primary",
"frequency_appointment": "minute",
"frequency_count_appointment": "2",
"period": "before",
"start_time": "11-06-2025 17:33",
"end_time": "11-06-2025 19:32",
"description": "Réunion mensuelle avec l'équipe",
"location": "cotonou",
"send_location": false,
"link": "https:\/\/meet.example.com\/abc123",
"time_zone_id": "415778a5-f3c0-437a-ace2-bc9cf4b7bfbc",
"appointment_type_id": "cefc8802-882c-487e-a97d-7e7474215e8d",
"recurring_appointment_id": null,
"appointment_room_id": "35106371-a711-48ba-a1d2-6c8e8a608b81",

"appointment_room": {
"id": "35106371-a711-48ba-a1d2-6c8e8a608b81",
"name": "SALLE 1",
"created_at": "2025-06-10 18:44:59",
"updated_at": "2025-06-10 18:44:59",
"society_id": "17da4b27-32b3-4fb3-82b6-3d93967d00fe"
},

"creator_id": "47dd45d7-7381-46c0-a18d-94c19e8b26d4",
"participants_count": null,

"participants": [
{
"appointment_id": "f2ae1d21-d1de-4052-a575-a3bca297f508",
"participant": {
"id": "2f195329-4e9a-4f7e-8569-7fda1c5f6b55",
"gender": "male",
"contactType": "particular",
"lastname": "JOHN",
"firstname": "DOE",
"phone": [
"62786175"
],
"email": "johndoe@gmail.com",
"customer": true,
"supplier": false,
"birthday": null,
"website": null,
"avatar": null,
"created_at": "2025-05-23 13:04:42",
"updated_at": "2025-05-23 13:04:42",
"currency_id": "c69a3d9f-c986-4149-a761-42b85bfb491a",
"company_id": null,
"post_id": null,
"office_id": null,
"society_id": "17da4b27-32b3-4fb3-82b6-3d93967d00fe",
"enable_portal": false,
"confirmation_token": "$2y$12$eVnYsZqvOPbgTveoVOR.Qe6YnM0cgatQ7GxCTLohwxnVawlji",
"email_verified_at": null,
"subcontractor": false,
"partner": false,
"exchange_rate": "1.0000",
"prospect": false,
"job_title": null,
"status": null,
"avatar_url": "http:\/\/netbyus.core.localhost\/assets\/blank.png",
"first_address_infos": "",
"birth": "",
"fullname": "JOHN doe",
"phones": "62786175"
},
"available_status": "WAITING",
"available_status_en": "Waiting",
"available_status_fr": "En attente",
"available_status_color": "warning",
"presence_status": null,
"created_at": "2025-06-11 16:33:02",
"updated_at": "2025-06-11 16:33:02"
}
 

Example response (403):

{
    "message": "Action non autorisée."
}
 

Example response (422):

{
    "message": "Le champ start_time est requis.",
    "errors": {
        "start_time": [
            "Le champ start_time est requis."
        ],
        "appointment_room_id": [
            "La salle est déjà prise sur ce créneau."
        ]
    }
}
 

Request    Try it out ⚡   

POST api/v1/store/appointment

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

tenant   string   

. Example: consequatur

Body Parameters

title   string   

. Example: consequatur

appointment_type_id   uuid  optional  

. Example: consequatur

start_time   string  optional  

. Example: consequatur

end_time   string   

. Example: consequatur

description   string  optional  

. Example: Dolores dolorum amet iste laborum eius est dolor.

location   string  optional  

. Example: consequatur

link   string  optional  

. Example: consequatur

sent_email   boolean  optional   true false

. Example: qkunze@example.com

time_zone_id   uuid   

. Example: consequatur

send_location   boolean  optional   true false

. Example: false

appointment_room_id   uuid   

. Example: consequatur

users   string[]  optional  

.

contacts   string[]  optional  

.

guest_emails   string[]  optional  

.

frequency_appointment   string  optional  

. Example: consequatur

frequency_count_appointment   integer  optional  

. Example: 17

recurring_date   date  optional  

. Example: consequatur

frequency   string.  optional  

Example: consequatur

limit_by   string  optional  

. Example: consequatur

limit_count   integer  optional  

. Example: 17

frequency_count   integer  optional  

. Example: 17

limit_date   date  optional  

. Example: consequatur

is_recurring   boolean  optional   true false

. Example: false

Affiche les détails d’un rendez-vous.

requires authentication

Cette route permet de récupérer toutes les informations d’un rendez-vous spécifique, y compris les participants, invités, notes, récurrence, etc.

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/show/consequatur/appointment" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/show/consequatur/appointment"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
  "data": {
    "id": "e42c99c3-1a60-4f9b-a87f-0bd6fdfdce70",
    "title": "Réunion RH",
    "start_time": "2025-06-11 14:00:00",
    "end_time": "2025-06-11 15:30:00",
    "description": "Entretien annuel",
    "location": "Salle de réunion B",
    "link": "https://zoom.us/j/123456789",
    "appointment_type": {
      "id": "a901c244-8eaf-4c6e-b6ab-7e986f803ed7",
      "name": "Réunion RH"
    },
    "participants": [
      {
        "id": "user-id-1",
        "name": "Jean Dupont",
        "sent_email": true
      }
    ],
    "guests": [
      {
        "email": "client@example.com",
        "name": "Client Test"
      }
    ],
    "notes": [
      {
        "content": "Préparer le plan de carrière",
        "files": [
          {
            "name": "plan.pdf",
            "url": "https://example.com/files/plan.pdf"
          }
        ]
      }
    ],
    "recurring": {
      "id": "uuid-recurring",
      "frequency": "weekly"
    },
    ...
  }
}
 

Example response (403):

{
    "message": "Action non autorisée."
}
 

Example response (422):

{
    "message": "Le champ appointment_id est requis.",
    "errors": {
        "appointment_id": [
            "Le champ appointment_id est requis."
        ]
    }
}
 

Request    Try it out ⚡   

GET api/v1/show/{appointment}/appointment

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

appointment   string  optional  

uuid required. Example: consequatur

tenant   string   

. Example: consequatur

Met à jour un rendez-vous existant.

requires authentication

Cette route permet de modifier les informations d’un rendez-vous, y compris la gestion des rendez-vous récurrents, l’envoi d’e-mails, et la mise à jour de l’activité liée.

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/appointment" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"consequatur\",
    \"appointment_type_id\": \"consequatur\",
    \"start_time\": \"consequatur\",
    \"end_time\": \"consequatur\",
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"location\": \"consequatur\",
    \"link\": \"consequatur\",
    \"sent_email\": \"qkunze@example.com\",
    \"time_zone_id\": \"consequatur\",
    \"send_location\": true,
    \"appointment_room_id\": \"consequatur\",
    \"users\": [
        \"consequatur\"
    ],
    \"contacts\": [
        \"consequatur\"
    ],
    \"guest_emails\": [
        \"consequatur\"
    ],
    \"frequency_appointment\": \"hour\",
    \"frequency_count_appointment\": 17,
    \"recurring_date\": \"consequatur\",
    \"frequency\": \"consequatur\",
    \"limit_by\": \"consequatur\",
    \"limit_count\": 17,
    \"frequency_count\": 17,
    \"limit_date\": \"consequatur\",
    \"appointment_id\": \"98adc52b-966d-39db-809a-55902ee7228f\",
    \"is_recurring\": false
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/appointment"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "consequatur",
    "appointment_type_id": "consequatur",
    "start_time": "consequatur",
    "end_time": "consequatur",
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "location": "consequatur",
    "link": "consequatur",
    "sent_email": "qkunze@example.com",
    "time_zone_id": "consequatur",
    "send_location": true,
    "appointment_room_id": "consequatur",
    "users": [
        "consequatur"
    ],
    "contacts": [
        "consequatur"
    ],
    "guest_emails": [
        "consequatur"
    ],
    "frequency_appointment": "hour",
    "frequency_count_appointment": 17,
    "recurring_date": "consequatur",
    "frequency": "consequatur",
    "limit_by": "consequatur",
    "limit_count": 17,
    "frequency_count": 17,
    "limit_date": "consequatur",
    "appointment_id": "98adc52b-966d-39db-809a-55902ee7228f",
    "is_recurring": false
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):

{
"appointments": [
{
"id": "7e6f3a3b-bb98-4a6e-89fd-0f8ce1cf67a1",
"title": "Réunion stratégique",
"status": "scheduled",
"status_en": "Scheduled",
"status_fr": "Programmé",
"status_color": "primary",
"frequency_appointment": "minute",
"frequency_count_appointment": "2",
"period": "before",
"start_time": "11-06-2025 17:33",
"end_time": "11-06-2025 19:32",
"description": "Réunion mensuelle avec l'équipe",
"location": "cotonou",
"send_location": false,
"link": "https:\/\/meet.example.com\/abc123",
"time_zone_id": "415778a5-f3c0-437a-ace2-bc9cf4b7bfbc",
"appointment_type_id": "cefc8802-882c-487e-a97d-7e7474215e8d",
"recurring_appointment_id": null,
"appointment_room_id": "35106371-a711-48ba-a1d2-6c8e8a608b81",

"appointment_room": {
"id": "35106371-a711-48ba-a1d2-6c8e8a608b81",
"name": "SALLE 1",
"created_at": "2025-06-10 18:44:59",
"updated_at": "2025-06-10 18:44:59",
"society_id": "17da4b27-32b3-4fb3-82b6-3d93967d00fe"
},

"creator_id": "47dd45d7-7381-46c0-a18d-94c19e8b26d4",
"participants_count": null,

"participants": [
{
"appointment_id": "f2ae1d21-d1de-4052-a575-a3bca297f508",
"participant": {
"id": "2f195329-4e9a-4f7e-8569-7fda1c5f6b55",
"gender": "male",
"contactType": "particular",
"lastname": "JOHN",
"firstname": "DOE",
"phone": [
"62786175"
],
"email": "johndoe@gmail.com",
"customer": true,
"supplier": false,
"birthday": null,
"website": null,
"avatar": null,
"created_at": "2025-05-23 13:04:42",
"updated_at": "2025-05-23 13:04:42",
"currency_id": "c69a3d9f-c986-4149-a761-42b85bfb491a",
"company_id": null,
"post_id": null,
"office_id": null,
"society_id": "17da4b27-32b3-4fb3-82b6-3d93967d00fe",
"enable_portal": false,
"confirmation_token": "$2y$12$eVnYsZqvOPbgTveoVOR.Qe6YnM0cgatQ7GxCTLohwxnVawlji",
"email_verified_at": null,
"subcontractor": false,
"partner": false,
"exchange_rate": "1.0000",
"prospect": false,
"job_title": null,
"status": null,
"avatar_url": "http:\/\/netbyus.core.localhost\/assets\/blank.png",
"first_address_infos": "",
"birth": "",
"fullname": "JOHN doe",
"phones": "62786175"
},
"available_status": "WAITING",
"available_status_en": "Waiting",
"available_status_fr": "En attente",
"available_status_color": "warning",
"presence_status": null,
"created_at": "2025-06-11 16:33:02",
"updated_at": "2025-06-11 16:33:02"
}
 

Example response (403):

{
    "message": "Action non autorisée."
}
 

Example response (422):

{
    "message": "Le champ appointment_id est requis.",
    "errors": {
        "appointment_id": [
            "Le champ appointment_id est requis."
        ]
    }
}
 

Request    Try it out ⚡   

PATCH api/v1/update/{appointment}/appointment

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

appointment   string   

Example: consequatur

tenant   string   

. Example: consequatur

appointmentId   string  optional  

uuid required. Example: consequatur

Body Parameters

title   string   

. Example: consequatur

appointment_type_id   string  optional  

. Example: consequatur

start_time   string   

. Example: consequatur

end_time   string   

. Example: consequatur

description   string  optional  

. Example: Dolores dolorum amet iste laborum eius est dolor.

location   string  optional  

. Example: consequatur

link   string  optional  

. Example: consequatur

sent_email   boolean  optional   true false

. Example: qkunze@example.com

time_zone_id   string   

. Example: consequatur

send_location   boolean  optional   true false

Example: true

appointment_room_id   string   

. Example: consequatur

users   string[]  optional  

.

contacts   string[]  optional  

.

guest_emails   string[]  optional  

.

frequency_appointment   string  optional  

Example: hour

Must be one of:

• minute
• hour
• day
• month

frequency_count_appointment   integer  optional  

Example: 17

recurring_date   string  optional  

. Example: consequatur

frequency   string  optional  

. Example: consequatur

limit_by   string  optional  

. Example: consequatur

limit_count   integer  optional  

. Example: 17

frequency_count   integer  optional  

. Example: 17

limit_date   string  optional  

. Example: consequatur

appointment_id   string   

Must be a valid UUID. The id of an existing record in the appointments table. Example: 98adc52b-966d-39db-809a-55902ee7228f

is_recurring   boolean  optional   true false

. Example: false

Supprime un rendez-vous existant.

requires authentication

Cette route permet de supprimer un rendez-vous identifié par son UUID. L'utilisateur doit avoir la permission de suppression appropriée.

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/appointment" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/appointment"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):

{
    "message": "Le rendez-vous a été supprimé avec succès."
}
 

Example response (403):

{
    "message": "Action non autorisée."
}
 

Example response (422):

{
    "message": "Impossible de supprimer le rendez-vous."
}
 

Request    Try it out ⚡   

DELETE api/v1/delete/{appointment}/appointment

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

appointment   string  optional  

uuid required . Example: consequatur

tenant   string   

. Example: consequatur

Annule un rendez-vous donné.

requires authentication

Cette route permet de changer le statut d'un rendez-vous en "Annulé". L'utilisateur doit avoir la permission de mise à jour appropriée. Un email de notification est envoyé aux participants qui ont reçu un email.

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/cancel/appointment/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/cancel/appointment/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Example response (200):

{
    "message": "Le rendez-vous a été annulé avec succès."
}
 

Example response (403):

{
    "message": "Action non autorisée."
}
 

Example response (422):

{
    "message": "Le rendez-vous est déjà annulé ou invalide."
}
 

Request    Try it out ⚡   

PATCH api/v1/cancel/appointment/{appointment}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

appointment   string   

The appointment. Example: consequatur

tenant   string   

. Example: consequatur

appointmentId   string  optional  

uuid required . Example: consequatur

Reprogramme un rendez-vous existant.

requires authentication

Met à jour les dates, le lieu, le lien et le statut du rendez-vous. Envoie une notification par email aux participants.

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/reschedule/appointment/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"appointment_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"start_time\": \"consequatur\",
    \"end_time\": \"consequatur\",
    \"location\": \"consequatur\",
    \"link\": \"consequatur\",
    \"time_zone_id\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/reschedule/appointment/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "appointment_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "start_time": "consequatur",
    "end_time": "consequatur",
    "location": "consequatur",
    "link": "consequatur",
    "time_zone_id": "consequatur"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):

{
  "message": "Le rendez-vous a été reprogrammé avec succès.",
  "appointment": {
    "id": "e42c99c3-1a60-4f9b-a87f-0bd6fdfdce70",
    "start_time": "2025-06-20 14:00:00",
    "end_time": "2025-06-20 15:30:00",
    "location": "Salle de réunion 3",
    "link": "https://zoom.us/j/123456789",
    "status": "scheduled",
    ...
  }
}
 

Request    Try it out ⚡   

PATCH api/v1/reschedule/appointment/{appointment}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

appointment   string  optional  

uuid required . Example: consequatur

tenant   string   

. Example: consequatur

Body Parameters

appointment_id   string   

Must be a valid UUID. The id of an existing record in the appointments table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

start_time   string   

. Example: consequatur

end_time   string  optional  

. Example: consequatur

location   string  optional  

. Example: consequatur

link   string  optional  

. Example: consequatur

time_zone_id   uuid  optional  

. Example: consequatur

Met à jour le statut d’un rendez-vous

requires authentication

Ce endpoint permet de modifier le statut d’un rendez-vous existant dans le tenant spécifié. L’utilisateur doit avoir la permission pour pouvoir effectuer cette opération.

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/appointment/consequatur/status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/appointment/consequatur/status"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "status": "consequatur"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):

{
    "message": "Le statut du rendez-vous a été mis à jour."
}
 

Example response (403):

{
    "message": "Vous n’avez pas la permission d’effectuer cette action."
}
 

Example response (422):

{
    "message": "Les données fournies sont invalides.",
    "errors": {
        "appointment_id": [
            "Le champ appointment_id est requis."
        ],
        "status": [
            "Le statut fourni n’est pas valide."
        ]
    }
}
 

Request    Try it out ⚡   

PATCH api/v1/update/appointment/{appointment}/status

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

appointment   string  optional  

uuid required . Example: consequatur

tenant   string   

. Example: consequatur

Body Parameters

status   string   

. Example: consequatur

Ajouter des participants à un rendez-vous

requires authentication

Ce endpoint permet d’ajouter des utilisateurs, des contacts ou des invités (emails) à un rendez-vous existant. L'utilisateur doit disposer de la permission .

Example request:

curl --request POST \
    "http://core.localhost/api/v1/add/appointment/consequatur/participants" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"appointment_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"users\": [
        \"consequatur\"
    ],
    \"contacts\": [
        \"consequatur\"
    ],
    \"guest_emails\": [
        \"consequatur\"
    ],
    \"sent_email\": \"qkunze@example.com\"
}"

const url = new URL(
    "http://core.localhost/api/v1/add/appointment/consequatur/participants"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "appointment_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "users": [
        "consequatur"
    ],
    "contacts": [
        "consequatur"
    ],
    "guest_emails": [
        "consequatur"
    ],
    "sent_email": "qkunze@example.com"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):

{
    "message": "Les participants ont été ajoutés avec succès."
}
 

Example response (403):

{
    "message": "Vous n’avez pas la permission d’effectuer cette action."
}
 

Example response (422):

{
    "message": "Une erreur est survenue lors de l’ajout des participants."
}
 

Request    Try it out ⚡   

POST api/v1/add/appointment/{appointment}/participants

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

appointment   string  optional  

uuid required . Example: consequatur

tenant   string   

. Example: consequatur

Body Parameters

appointment_id   string   

Must be a valid UUID. The id of an existing record in the appointments table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

users   string[]  optional  

.

contacts   string[]  optional  

.

guest_emails   string[]  optional  

.

sent_email   boolean.  optional  

Example: qkunze@example.com

Ajouter une note à un rendez-vous

requires authentication

Ce endpoint permet d’ajouter une note (avec ou sans fichiers joints) à un rendez-vous existant. Cela met également à jour le statut du rendez-vous à "Terminé".

Example request:

curl --request POST \
    "http://core.localhost/api/v1/add/appointment/consequatur/note" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"appointment_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"note\": \"Le rendez-vous s\'est bien déroulé.\",
    \"files\": [
        \"consequatur\"
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/add/appointment/consequatur/note"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "appointment_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "note": "Le rendez-vous s'est bien déroulé.",
    "files": [
        "consequatur"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):

{
    "message": "Appointment Note successfully added",
    "note": {
        "appointment_id": "f2ae1d21-d1de-4052-a575-a3bca297f508",
        "note": "dncjebjhcvdbhjcdvcghdvchgec",
        "id": "97acee4b-5df8-4ea6-b229-9c799cb3c8a4",
        "updated_at": "2025-06-12 11:48:03",
        "created_at": "2025-06-12 11:48:03",
        "files": [
            {
                "file": "rap-suite-co-22-1749728883.pdf",
                "appointment_note_id": "97acee4b-5df8-4ea6-b229-9c799cb3c8a4",
                "id": "aaf224e0-8875-4605-b275-ff37db33b45c",
                "updated_at": "2025-06-12 11:48:03",
                "created_at": "2025-06-12 11:48:03",
                "file_url": "http://netbyus.core.localhost/storage/images/appointments/rap-suite-co-22-1749728883.pdf"
            }
        ]
    }
}
 

Example response (403):

{
    "message": "Vous n’avez pas la permission d’effectuer cette action."
}
 

Example response (422):

{
    "message": "Le champ note est requis.",
    "errors": {
        "note": [
            "Le champ note est requis."
        ]
    }
}
 

Request    Try it out ⚡   

POST api/v1/add/appointment/{appointment}/note

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

appointment   string  optional  

uuid required Example: consequatur

tenant   string   

Example: consequatur

Body Parameters

appointment_id   string   

Must be a valid UUID. The id of an existing record in the appointments table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

note   string   

Le contenu de la note. Example: Le rendez-vous s'est bien déroulé.

files   string[]  optional  

optional Des fichiers à joindre à la note. Formats autorisés : pdf, doc, docx, jpeg, png, jpg, xls, xlsx. Taille max : 2Mo par fichier.

Mettre à jour une note de rendez-vous

requires authentication

Ce endpoint permet de modifier une note associée à un rendez-vous, y compris ses fichiers joints. Il est également possible de détacher certains fichiers de la note. Une fois la mise à jour effectuée, le statut du rendez-vous passe à "Terminé" .

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/appointment/consequatur/note/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"appointment_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"appointment_note_id\": \"fa010f60-df29-3f05-8bc7-bed48f550d13\",
    \"note\": \"consequatur\",
    \"files\": [
        \"consequatur\"
    ],
    \"detach_files\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/appointment/consequatur/note/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "appointment_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "appointment_note_id": "fa010f60-df29-3f05-8bc7-bed48f550d13",
    "note": "consequatur",
    "files": [
        "consequatur"
    ],
    "detach_files": "consequatur"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):

{
{
"message": "Appointment Note successfully updated",
"note": {
"appointment_id": "f2ae1d21-d1de-4052-a575-a3bca297f508",
"note": "dncjebjhcvdbhjcdvcghdvchgec",
"id": "97acee4b-5df8-4ea6-b229-9c799cb3c8a4",
"updated_at": "2025-06-12 11:48:03",
"created_at": "2025-06-12 11:48:03",
"files": [
{
"file": "rap-suite-co-22-1749728883.pdf",
"appointment_note_id": "97acee4b-5df8-4ea6-b229-9c799cb3c8a4",
"id": "aaf224e0-8875-4605-b275-ff37db33b45c",
"updated_at": "2025-06-12 11:48:03",
"created_at": "2025-06-12 11:48:03",
"file_url": "http://netbyus.core.localhost/storage/images/appointments/rap-suite-co-22-1749728883.pdf"
}
]
}
}
 

Example response (403):

{
    "message": "Vous n’avez pas la permission d’effectuer cette action."
}
 

Example response (422):

{
    "message": "Le champ note est requis.",
    "errors": {
        "note": [
            "Le champ note est requis."
        ]
    }
}
 

Request    Try it out ⚡   

PATCH api/v1/update/appointment/{appointment}/note/{note}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

appointment   string   

The appointment. Example: consequatur

note   string   

The note. Example: consequatur

tenant   string   

Example: consequatur

appointmentId   string  optional  

uuid required Example: consequatur

noteId   string  optional  

uuid required Example: consequatur

Body Parameters

appointment_id   string   

Must be a valid UUID. The id of an existing record in the appointments table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

appointment_note_id   string   

Must be a valid UUID. The id of an existing record in the appointment_notes table. Example: fa010f60-df29-3f05-8bc7-bed48f550d13

note   string   

Example: consequatur

files   string[]  optional  

detach_files   array.  optional  

Example: consequatur

Supprimer une note de rendez-vous

requires authentication

Ce endpoint permet de supprimer une note associée à un rendez-vous donné. La suppression est définitive. Cette opération est protégée par une validation d'existence de la note et du rendez-vous associé.

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/appointment/consequatur/note/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/appointment/consequatur/note/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):

{
    "message": "La note a été supprimée avec succès."
}
 

Example response (422):

{
    "message": "Le rendez-vous est introuvable."
}
 

Example response (422):

{
    "message": "La note est introuvable."
}
 

Example response (422):

{
    "message": "Une erreur est survenue lors de la suppression de la note."
}
 

Request    Try it out ⚡   

DELETE api/v1/delete/appointment/{appointment}/note/{note}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

appointment   string   

The appointment. Example: consequatur

note   string   

The note. Example: consequatur

tenant   string   

Example: consequatur

appointmentId   string  optional  

uuid required Example: consequatur

noteId   string  optional  

uuid required Example: consequatur

Mettre à jour le statut de présence d’un participant à un rendez-vous

requires authentication

Ce endpoint permet de définir si un participant était présent ou non à un rendez-vous donné.

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/set/appointment/consequatur/presence" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"participant_id\": \"consequatur\",
    \"presence_status\": false
}"

const url = new URL(
    "http://core.localhost/api/v1/set/appointment/consequatur/presence"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "participant_id": "consequatur",
    "presence_status": false
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):

{
    "message": "Statut de présence mis à jour avec succès."
}
 

Example response (403):

{
    "message": "Vous n'avez pas les autorisations nécessaires."
}
 

Example response (422):

{
    "message": "Impossible de mettre à jour le statut de présence."
}
 

Request    Try it out ⚡   

PATCH api/v1/set/appointment/{appointment}/presence

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

appointment   string  optional  

uuid required Example: consequatur

tenant   string   

Example: consequatur

Body Parameters

participant_id   uuid   

Example: consequatur

presence_status   boolean  optional   true false

Example: false

Mettre à jour la disponibilité d’un participant pour un rendez-vous

requires authentication

Ce endpoint permet de définir si un participant est disponible, indisponible ou en attente pour un rendez-vous spécifique.

Example request:

curl --request POST \
    "http://core.localhost/api/v1/set/appointment/availability" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"appointment_id\": \"consequatur\",
    \"participant_id\": \"consequatur\",
    \"available_status\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/set/appointment/availability"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "appointment_id": "consequatur",
    "participant_id": "consequatur",
    "available_status": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):

{
"message": "operation successfully completed.",
"participant": {
"id": "32d6945b-01e6-4266-8ef1-627fe29b844a",
"appointment_id": "f2ae1d21-d1de-4052-a575-a3bca297f508",
"available_status": "AVAILABLE",
"presence_status": false,
"participant_type": "Core\\v1\\Contact\\Models\\Contact",
"participant_id": "2f195329-4e9a-4f7e-8569-7fda1c5f6b55",
"created_at": "2025-06-11 16:33:02",
"updated_at": "2025-06-12 11:53:14",
"sent_email": false,
"customer": null,
"collaborator": null,
"guest": null
}
}
}
 

Example response (422):

{
    "message": "Une erreur est survenue."
}
 

Request    Try it out ⚡   

POST api/v1/set/appointment/availability

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

tenant   string   

Example: consequatur

Body Parameters

appointment_id   uuid   

Example: consequatur

participant_id   uuid   

Example: consequatur

available_status   string   

Example: consequatur

Récupérer les détails d’un rendez-vous

requires authentication

Ce endpoint permet de récupérer toutes les informations d’un rendez-vous spécifique, y compris le type de rendez-vous et les participants.

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/consequatur/appointment" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/consequatur/appointment"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "data": {
        "id": "f2ae1d21-d1de-4052-a575-a3bca297f508",
        "title": "Peésentation",
        "status": "COMPLETED",
        "status_en": "Completed",
        "status_fr": "Terminé",
        "status_color": "success",
        "frequency_appointment": "minute",
        "frequency_count_appointment": 2,
        "period": "before",
        "start_time": "11-06-2025 17:33",
        "end_time": "11-06-2025 19:32",
        "description": "<p>frjkfhrfrghjrfhfgjgefr</p>",
        "location": "cotonou",
        "send_location": false,
        "link": "https://meet.example.com/abc123",
        "time_zone_id": "415778a5-f3c0-437a-ace2-bc9cf4b7bfbc",
        "appointment_type_id": "cefc8802-882c-487e-a97d-7e7474215e8d",
        "recurring_appointment_id": null,
        "is_recurring": null,
        "appointment_room_id": "35106371-a711-48ba-a1d2-6c8e8a608b81",
        "appointment_room": {
            "id": "35106371-a711-48ba-a1d2-6c8e8a608b81",
            "name": "SALLE 1",
            "created_at": "2025-06-10 18:44:59",
            "updated_at": "2025-06-10 18:44:59",
            "society_id": "17da4b27-32b3-4fb3-82b6-3d93967d00fe"
        },
        "creator_id": "47dd45d7-7381-46c0-a18d-94c19e8b26d4",
        "participants_count": null,
        "appointmentType": {
            "id": "cefc8802-882c-487e-a97d-7e7474215e8d",
            "name": "meeting"
        },
        "recurring": null,
        "participants": [
            {
                "appointment_id": "f2ae1d21-d1de-4052-a575-a3bca297f508",
                "participant": {
                    "id": "2f195329-4e9a-4f7e-8569-7fda1c5f6b55",
                    "gender": "male",
                    "contactType": "particular",
                    "lastname": "ADAM",
                    "firstname": "Chola Oluwa Akinni Chacour",
                    "phone": [
                        "62786175"
                    ],
                    "email": "adamchacour118@gmail.com",
                    "customer": true,
                    "supplier": false,
                    "birthday": null,
                    "website": null,
                    "avatar": null,
                    "created_at": "2025-05-23 13:04:42",
                    "updated_at": "2025-05-23 13:04:42",
                    "currency_id": "c69a3d9f-c986-4149-a761-42b85bfb491a",
                    "company_id": null,
                    "post_id": null,
                    "office_id": null,
                    "society_id": "17da4b27-32b3-4fb3-82b6-3d93967d00fe",
                    "enable_portal": false,
                    "confirmation_token": "$2y$12$eVnYsZqvOPbgTveoVOR.Qe6YnM0cgatQ7GxCTLohwxnVawlji",
                    "email_verified_at": null,
                    "subcontractor": false,
                    "partner": false,
                    "exchange_rate": "1.0000",
                    "prospect": false,
                    "job_title": null,
                    "status": null,
                    "avatar_url": "http://netbyus.core.localhost/assets/blank.png",
                    "first_address_infos": "",
                    "birth": "",
                    "fullname": "ADAM Chola Oluwa Akinni Chacour",
                    "phones": "62786175"
                },
                "available_status": "AVAILABLE",
                "available_status_en": "Available",
                "available_status_fr": "Disponible",
                "available_status_color": "success",
                "presence_status": false,
                "created_at": "2025-06-11 16:33:02",
                "updated_at": "2025-06-12 11:53:14"
            }
        ],
        "notes": [
            {
                "id": "97acee4b-5df8-4ea6-b229-9c799cb3c8a4",
                "appointment_id": "f2ae1d21-d1de-4052-a575-a3bca297f508",
                "note": "dncjebjhcvdbhjcdvcghdvchgec",
                "files": [
                    {
                        "id": "aaf224e0-8875-4605-b275-ff37db33b45c",
                        "appointment_note_id": "97acee4b-5df8-4ea6-b229-9c799cb3c8a4",
                        "file": "rap-suite-co-22-1749728883.pdf",
                        "created_at": "2025-06-12 11:48:03",
                        "updated_at": "2025-06-12 11:48:03",
                        "file_url": "http://netbyus.core.localhost/storage/images/appointments/rap-suite-co-22-1749728883.pdf"
                    }
                ],
                "created_at": "2025-06-12 11:48:03",
                "updated_at": "2025-06-12 11:48:03"
            }
        ],
        "guests": [],
        "customers": [
            {
                "id": "2f195329-4e9a-4f7e-8569-7fda1c5f6b55",
                "fullname": "ADAM Chola Oluwa Akinni Chacour",
                "lastname": "ADAM",
                "firstname": "Chola Oluwa Akinni Chacour",
                "gender": "male",
                "contactType_fr": "Particulier",
                "contactType_en": "Particular",
                "contactType": "particular",
                "phone": [
                    "62786175"
                ],
                "birthday": null,
                "email": "adamchacour118@gmail.com",
                "avatar": "http://netbyus.core.localhost/assets/blank.png",
                "supplier": false,
                "customer": true,
                "subcontractor": false,
                "partner": false,
                "prospect": false,
                "website": null,
                "company_id": null,
                "post_id": null,
                "exchange_rate": "1.0000",
                "city_id": null,
                "district": null,
                "block": null,
                "square_number": null,
                "plot": null,
                "house": null
            }
        ],
        "collaborators": []
    }
}
 

Example response (422):

{
    "message": "The given data was invalid.",
    "errors": {
        "appointment_id": [
            "The selected appointment_id is invalid."
        ]
    }
}
 

Request    Try it out ⚡   

GET api/v1/get/{appointment}/appointment

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

appointment   string  optional  

uuid required Example: consequatur

tenant   string   

Example: consequatur

Gestion des caisses

APIs pour gerer les caisses

Récupère les statistic d'un compte par annee sur une caisse

GET get/box/{boxId}/{year}/statistics

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/box/consequatur/consequatur/statistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/box/consequatur/consequatur/statistics"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/box/{boxId}/{year}/statistics

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

boxId   string   

Example: consequatur

year   string   

Example: consequatur

Récupère les statistic d'un compte par mois sur une caisse

GET get/box/{boxId}/{month}/{year}/statistics

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/box/consequatur/consequatur/consequatur/statistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/box/consequatur/consequatur/consequatur/statistics"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/box/{boxId}/{month}/{year}/statistics

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

boxId   string   

Example: consequatur

month   string   

Example: consequatur

year   string   

Example: consequatur

Récupère la collection des caisses

GET get/boxes

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/boxes" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/boxes"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/boxes

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Récupère la liste des caisse d'un bureau

GET get/boxes/{boxId}/office

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/boxes/consequatur/office" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/boxes/consequatur/office"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/boxes/{boxId}/office

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

boxId   string   

Example: consequatur

Crée une caisse pour un bureau

POST store/box/{officeId}/office

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/box/consequatur/office" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"office_id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"name\": \"consequatur\",
    \"currency_id\": \"consequatur\",
    \"exchange_rate\": 11613.31890586
}"

const url = new URL(
    "http://core.localhost/api/v1/store/box/consequatur/office"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "office_id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "name": "consequatur",
    "currency_id": "consequatur",
    "exchange_rate": 11613.31890586
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/box/{officeId}/office

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

officeId   string   

Example: consequatur

Body Parameters

office_id   string   

Must be a valid UUID. The id of an existing record in the offices table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

name   string   

Example: consequatur

initial_amount   string  optional  

currency_id   string   

The id of an existing record in the currencies table. Example: consequatur

exchange_rate   number  optional  

Example: 11613.31890586

Modifie une caisse

PATCH update/box/{boxId}/office

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/box/consequatur/office" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"name\": \"qeopfuudtdsufvyvddqam\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/box/consequatur/office"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "name": "qeopfuudtdsufvyvddqam"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

PATCH api/v1/update/box/{boxId}/office

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

boxId   string   

Example: consequatur

Body Parameters

id   string   

Must be a valid UUID. The id of an existing record in the boxes table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

name   string   

Must not be greater than 255 characters. Example: qeopfuudtdsufvyvddqam

Récupère l'historique d'une caisse

GET get/box/{boxId}/histories

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/box/consequatur/histories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/box/consequatur/histories"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/box/{boxId}/histories

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

boxId   string   

Example: consequatur

Faire un depot sur une caisse

POST store/box/{boxId}/deposit

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/box/consequatur/deposit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"amount\": \"consequatur\",
    \"reason\": \"mqeopfuudtdsufvyvddqa\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/box/consequatur/deposit"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "amount": "consequatur",
    "reason": "mqeopfuudtdsufvyvddqa"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/box/{boxId}/deposit

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

boxId   string   

Example: consequatur

Body Parameters

id   string   

Must be a valid UUID. The id of an existing record in the boxes table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

amount   string   

Example: consequatur

reason   string   

Must be at least 3 characters. Must not be greater than 1000 characters. Example: mqeopfuudtdsufvyvddqa

Faire un retrait sur une caisse

POST store/box/{boxId}/withdrawal

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/box/consequatur/withdrawal" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"amount\": \"consequatur\",
    \"reason\": \"mqeopfuudtdsufvyvddqa\",
    \"invoices\": [
        \"mniihfqcoynlazghdtqtq\"
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/store/box/consequatur/withdrawal"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "amount": "consequatur",
    "reason": "mqeopfuudtdsufvyvddqa",
    "invoices": [
        "mniihfqcoynlazghdtqtq"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/box/{boxId}/withdrawal

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

boxId   string   

Example: consequatur

Body Parameters

id   string   

Must be a valid UUID. The id of an existing record in the boxes table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

amount   string   

Example: consequatur

office_id   string  optional  

This field is required when expense_created is true. The id of an existing record in the offices table.

reason   string   

Must be at least 3 characters. Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

invoices   string[]  optional  

Must not be greater than 10240 characters.

expense_created   string  optional  

Faire un transfert surune caisse

POST store/box/{boxId}/transfer

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/box/consequatur/transfer" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"box\",
    \"debit_box_id\": \"consequatur\",
    \"credit_box_id\": \"98adc52b-966d-39db-809a-55902ee7228f\",
    \"amount\": \"consequatur\",
    \"reason\": \"mqeopfuudtdsufvyvddqa\",
    \"rate\": 45
}"

const url = new URL(
    "http://core.localhost/api/v1/store/box/consequatur/transfer"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "box",
    "debit_box_id": "consequatur",
    "credit_box_id": "98adc52b-966d-39db-809a-55902ee7228f",
    "amount": "consequatur",
    "reason": "mqeopfuudtdsufvyvddqa",
    "rate": 45
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/box/{boxId}/transfer

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

boxId   string   

Example: consequatur

Body Parameters

type   string   

Example: box

Must be one of:

• account
• box

debit_box_id   string   

The id of an existing record in the boxes table. Example: consequatur

credit_box_id   string   

Must be a valid UUID. Example: 98adc52b-966d-39db-809a-55902ee7228f

amount   string   

Example: consequatur

reason   string   

Must be at least 3 characters. Must not be greater than 1000 characters. Example: mqeopfuudtdsufvyvddqa

rate   number  optional  

Must be at least 0. Example: 45

Récupère l'historique d'une caisse au format excel

GET box/{boxId}/excel

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/box/consequatur/excel" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/box/consequatur/excel"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/box/{boxId}/excel

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

boxId   string   

Example: consequatur

Gestion des comptes

APIs pour gerer les comptes

Récupère la liste des comptes d'une société

requires authentication

GET /get/accounts/{office}/office

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/accounts/consequatur/office" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/accounts/consequatur/office"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
  "accounts": {
    "c8fe58b8-b1a5-4389-813c-1edb3dd939b7": {
      "id": "c8fe58b8-b1a5-4389-813c-1edb3dd939b7",
      "name": "Testaccount",
      "bank": "testBank",
      "currency_id": "96f5ba1d-8235-49e9-97af-3b226b777a57",
      "currency_iso": "KMF",
      "currency_symbol": "CF",
      "account_number": "1324794616561",
      "amount": "13943.12",
      "account_histories": []
    }
  },
 "officeCurrency":{
  "id": "bae3a483-4ec6-4c51-9e31-574da46e2fcc",
  "name": "Afghan",
  "iso": "AFN",
  "symbol": "Af",
  "exchange": "1",
  "online": false,
  "default": false,
  "created_at": "2024-06-07 18:07:16",
  "updated_at": "2024-06-07 18:07:16"
 },
 "office": {
   "id": "e6a957a1-d65c-45cd-b65f-309a780e3e0a",
   "name": "netbyus",
   "created_at": "2025-02-03 00:00:00",
   "updated_at": "2025-06-05 15:16:21",
}
 

Request    Try it out ⚡   

GET api/v1/get/accounts/{office}/office

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

office   string   

Example: consequatur

society   string   

Example: consequatur

Crée un nouveau compte pour une société

requires authentication

POST store/account/{society}/office

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/account/consequatur/office" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\",
    \"bank\": \"consequatur\",
    \"account_number\": \"consequatur\",
    \"initial_amount\": 11613.31890586,
    \"exchange_rate\": 11613.31890586,
    \"currency_id\": \"consequatur\",
    \"society_id\": \"c2cdda66-81e5-3060-a4eb-049b4a810d76\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/account/consequatur/office"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "consequatur",
    "bank": "consequatur",
    "account_number": "consequatur",
    "initial_amount": 11613.31890586,
    "exchange_rate": 11613.31890586,
    "currency_id": "consequatur",
    "society_id": "c2cdda66-81e5-3060-a4eb-049b4a810d76"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):

{
    "account": {
        "id": "e6a957a1-d65c-45cd-b65f-309a780e3e0a",
        "name": "account1"
    }
}
 

Request    Try it out ⚡   

POST api/v1/store/account/{society}/office

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

society   string   

Example: consequatur

Body Parameters

name   string   

Example: consequatur

bank   string   

Example: consequatur

account_number   string   

Example: consequatur

initial_amount   number  optional  

nullable Example: 11613.31890586

exchange_rate   number  optional  

nullable Example: 11613.31890586

currency_id   string   

Example: consequatur

society_id   string   

Must be a valid UUID. The id of an existing record in the societies table. Example: c2cdda66-81e5-3060-a4eb-049b4a810d76

Modifier un compte

requires authentication

PATCH update/account/{accountId}/office

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/account/consequatur/office" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\",
    \"bank\": \"consequatur\",
    \"account_number\": \"consequatur\",
    \"initial_amount\": 11613.31890586,
    \"exchange_rate\": 11613.31890586,
    \"currency_id\": \"consequatur\",
    \"id\": \"c2cdda66-81e5-3060-a4eb-049b4a810d76\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/account/consequatur/office"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "consequatur",
    "bank": "consequatur",
    "account_number": "consequatur",
    "initial_amount": 11613.31890586,
    "exchange_rate": 11613.31890586,
    "currency_id": "consequatur",
    "id": "c2cdda66-81e5-3060-a4eb-049b4a810d76"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):

{
    "account": {
        "id": "e6a957a1-d65c-45cd-b65f-309a780e3e0a",
        "name": "account1"
    }
}
 

Request    Try it out ⚡   

PATCH api/v1/update/account/{accountId}/office

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

accountId   string   

Example: consequatur

Body Parameters

name   string   

Le nom du compte Example: consequatur

bank   string   

Example: consequatur

account_number   string   

Example: consequatur

initial_amount   number  optional  

Example: 11613.31890586

exchange_rate   number  optional  

Example: 11613.31890586

currency_id   string   

Example: consequatur

id   string   

Must be a valid UUID. The id of an existing record in the accounts table. Example: c2cdda66-81e5-3060-a4eb-049b4a810d76

Récupère l'historique d'un compte

requires authentication

GET get/account/{accountId}/histories

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/account/consequatur/histories?startDate=consequatur&endDate=consequatur&account_id=consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/account/consequatur/histories"
);

const params = {
    "startDate": "consequatur",
    "endDate": "consequatur",
    "account_id": "consequatur",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
  "histories": [
     {
        ""
     }
  ],
  "count": 0,
}
 

Request    Try it out ⚡   

GET api/v1/get/account/{accountId}/histories

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

accountId   string   

Example: consequatur

Query Parameters

startDate   string  optional  

Example: consequatur

endDate   string  optional  

Example: consequatur

account_id   string   

Example: consequatur

Faire un depot sur un compte

requires authentication

POST store/account/{accountId}/deposit

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/account/consequatur/deposit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"amount\": 11613.31890586,
    \"reason\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/account/consequatur/deposit"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "amount": 11613.31890586,
    "reason": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/account/{accountId}/deposit

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

accountId   string  optional  

Example: consequatur

tenant   string  optional  

Example: consequatur

Body Parameters

id   string   

Must be a valid UUID. The id of an existing record in the accounts table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

amount   number   

Example: 11613.31890586

reason   string   

Example: consequatur

Faire un retrait sur un compte

POST store/account/{accountId}/withdrawal

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/account/consequatur/withdrawal" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"amount\": \"consequatur\",
    \"reason\": \"mqeopfuudtdsufvyvddqa\",
    \"invoices\": [
        \"mniihfqcoynlazghdtqtq\"
    ]
}"

const url = new URL(
    "http://core.localhost/api/v1/store/account/consequatur/withdrawal"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "amount": "consequatur",
    "reason": "mqeopfuudtdsufvyvddqa",
    "invoices": [
        "mniihfqcoynlazghdtqtq"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/account/{accountId}/withdrawal

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

accountId   string   

Example: consequatur

Body Parameters

id   string   

Must be a valid UUID. The id of an existing record in the accounts table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

amount   string   

Example: consequatur

office_id   string  optional  

This field is required when expense_created is true. The id of an existing record in the offices table.

reason   string   

Must be at least 3 characters. Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

invoices   string[]  optional  

Must not be greater than 10240 characters.

expense_created   string  optional  

Faire un transfert sur un compte

POST store/account/{accountId}/transfer

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/account/consequatur/transfer" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"66529e01-d113-3473-8d6f-9e11e09332ea\",
    \"type\": \"box\",
    \"debit_account_id\": \"consequatur\",
    \"credit_account_id\": \"98adc52b-966d-39db-809a-55902ee7228f\",
    \"amount\": \"consequatur\",
    \"reason\": \"mqeopfuudtdsufvyvddqa\",
    \"rate\": 45
}"

const url = new URL(
    "http://core.localhost/api/v1/store/account/consequatur/transfer"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "id": "66529e01-d113-3473-8d6f-9e11e09332ea",
    "type": "box",
    "debit_account_id": "consequatur",
    "credit_account_id": "98adc52b-966d-39db-809a-55902ee7228f",
    "amount": "consequatur",
    "reason": "mqeopfuudtdsufvyvddqa",
    "rate": 45
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request    Try it out ⚡   

POST api/v1/store/account/{accountId}/transfer

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

accountId   string   

Example: consequatur

Body Parameters

id   string   

Must be a valid UUID. The id of an existing record in the accounts table. Example: 66529e01-d113-3473-8d6f-9e11e09332ea

type   string   

Example: box

Must be one of:

• account
• box

debit_account_id   string   

The id of an existing record in the accounts table. Example: consequatur

credit_account_id   string   

Must be a valid UUID. Example: 98adc52b-966d-39db-809a-55902ee7228f

amount   string   

Example: consequatur

reason   string   

Must be at least 3 characters. Must not be greater than 1000 characters. Example: mqeopfuudtdsufvyvddqa

rate   number  optional  

Must be at least 0. Example: 45

Récupère le statistique des comptes

GET get/offices/accounts/statistics

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/offices/accounts/statistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/offices/accounts/statistics"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/offices/accounts/statistics

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Récupère le statistique d'un compte par année

GET get/account/{accountId}/{year}/statistics

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/account/consequatur/consequatur/statistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/account/consequatur/consequatur/statistics"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/account/{accountId}/{year}/statistics

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

accountId   string   

Example: consequatur

year   string   

Example: consequatur

Récupère le statistique d'un compte par mois

GET get/account/{accountId}/{month}/{year}/statistics

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/account/consequatur/consequatur/consequatur/statistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/account/consequatur/consequatur/consequatur/statistics"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/account/{accountId}/{month}/{year}/statistics

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

accountId   string   

Example: consequatur

month   string   

Example: consequatur

year   string   

Example: consequatur

Récupère en excel l'historique d'un compte

GET account/{accountId}/excel

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/account/consequatur/excel" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/account/consequatur/excel"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/account/{accountId}/excel

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

accountId   string   

Example: consequatur

Récupère les détails d'une transaction

GET get/transaction/{transaction}/details

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/transaction/consequatur/details" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/transaction/consequatur/details"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers

cache-control: no-cache, private
content-type: application/json
 

{
    "message": "Bad request."
}
 

Request    Try it out ⚡   

GET api/v1/get/transaction/{transaction}/details

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

transaction   string   

The transaction. Example: consequatur

Gestion des salles de rendez-vous

APIs pour gerer les salles de rendez-vous

Récupérer les salles de rendez-vous (format DataTable)

requires authentication

Ce endpoint retourne une liste paginée et filtrable des salles de rendez-vous appartenant à la société de l'utilisateur, au format compatible avec DataTables.js.

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/appointment/room/datatable?draw=17&start=17&length=17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/appointment/room/datatable"
);

const params = {
    "draw": "17",
    "start": "17",
    "length": "17",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "draw": 1,
    "recordsTotal": 25,
    "recordsFiltered": 10,
    "data": [
        {
            "id": "room-uuid-1",
            "name": "Salle Conférence A",
            "Actions": null
        },
        {
            "id": "room-uuid-2",
            "name": "Salle Réunion B",
            "Actions": null
        }
    ]
}
 

Request    Try it out ⚡   

GET api/v1/get/appointment/room/datatable

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

draw   integer  optional  

Example: 17

start   integer  optional  

Example: 17

length   integer  optional  

Example: 17

search.value   string  optional  

Example: consequatur

order.0.column   integer  optional  

Example: 17

order.0.dir   string  optional  

Example: consequatur

Récupérer la liste des salles de rendez-vous

requires authentication

Ce endpoint retourne toutes les salles disponibles pour la planification de rendez-vous.

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/appointment/room" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/appointment/room"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "rooms": [
        {
            "id": "1",
            "name": "Salle A",
            "created_at": "2025-06-01T10:00:00Z",
            "updated_at": "2025-06-01T10:00:00Z",
            "society_id": "17da4b27-32b3-4fb3-82b6-3d93967d00fe"
        },
        {
            "id": "2",
            "name": "Salle B",
            "location": "Étage 2",
            "created_at": "2025-06-01T11:00:00Z",
            "updated_at": "2025-06-01T11:00:00Z",
            "society_id": "17da4b27-32b3-4fb3-82b6-3d93967d00fe"
        }
    ]
}
 

Request    Try it out ⚡   

GET api/v1/get/appointment/room

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Créer une nouvelle salle de rendez-vous

requires authentication

Ce endpoint permet de créer une nouvelle salle de rendez-vous dans le système. La salle peut ensuite être associée à des rendez-vous.

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/appointment/room" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/appointment/room"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):

{
    "message": "La salle a été ajoutée avec succès.",
    "room": {
        "id": "1",
        "name": "Salle A",
        "created_at": "2025-06-11T10:00:00Z",
        "updated_at": "2025-06-11T10:00:00Z",
        "society_id": "17da4b27-32b3-4fb3-82b6-3d93967d00fe"
    }
}
 

Example response (422):

{
    "message": "Le champ name est obligatoire.",
    "errors": {
        "name": [
            "Le champ name est obligatoire."
        ]
    }
}
 

Request    Try it out ⚡   

POST api/v1/store/appointment/room

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Example: consequatur

Mettre à jour une salle de rendez-vous

requires authentication

Ce endpoint permet de modifier les informations d'une salle de rendez-vous existante.

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/appointment/room/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/appointment/room/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "consequatur"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):

{
    "message": "Salle mise à jour avec succès",
    "room": {
        "id": "17da4b27-32b3-4fb3-82b6-3d93967d00fe",
        "name": "Salle Réunion 2",
        "created_at": "2025-06-01T10:00:00Z",
        "updated_at": "2025-06-11T09:30:00Z",
        "society_id": "d221053a-42c2-48a1-8de3-80a3e3c5ef84"
    }
}
 

Example response (422):

{
    "message": "Le nom de la salle est déjà utilisé."
}
 

Request    Try it out ⚡   

PATCH api/v1/update/appointment/room/{room}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

room   string   

The room. Example: consequatur

roomId   string  optional  

uuid required Example: consequatur

Body Parameters

name   string   

Example: consequatur

Afficher les détails d'une salle de rendez-vous

requires authentication

Ce endpoint permet de récupérer les informations d'une salle spécifique à partir de son identifiant.

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/appointment/room/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/appointment/room/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "room": {
        "id": "17da4b27-32b3-4fb3-82b6-3d93967d00fe",
        "name": "Salle Conférence 1",
        "created_at": "2025-06-01T10:00:00Z",
        "updated_at": "2025-06-01T10:00:00Z",
        "society_id": "d221053a-42c2-48a1-8de3-80a3e3c5ef84"
    }
}
 

Example response (404):

{
    "message": "No query results for model [App\\Models\\AppointmentRoom] 17da4b27-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
 

Request    Try it out ⚡   

GET api/v1/get/appointment/room/{room}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

room   string   

The room. Example: consequatur

roomId   string  optional  

uuid required Example: consequatur

Supprimer une salle de rendez-vous

requires authentication

Ce endpoint permet de supprimer définitivement une salle de rendez-vous à partir de son identifiant.

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/appointment/room/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/appointment/room/consequatur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):

{
    "message": "Salle supprimée avec succès"
}
 

Example response (422):

{
    "message": "La salle n'a pas pu être supprimée"
}
 

Request    Try it out ⚡   

DELETE api/v1/delete/appointment/room/{room}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

room   string   

The room. Example: consequatur

roomId   string  optional  

uuid required Example: consequatur

Gestion des types de rendez-vous

APIs pour gerer les types de rendez-vous

Récupérer la liste des types de rendez-vous

requires authentication

Ce endpoint retourne tous les types de rendez-vous disponibles pour l’organisation actuelle (société).

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/appointmentType/collection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/appointmentType/collection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

[
  {
    "id": "01e3c93b-d9c1-49b3-8a24-8fd3e2f28b3f",
    "name": "Consultation médicale",
  },
  {
    "id": "22ab4c6d-7a62-4b1b-b3fd-9e0e9bd347f3",
    "name": "Réunion interne",
  }
]
 

Request    Try it out ⚡   

GET api/v1/get/appointmentType/collection

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Récupérer la liste paginée des types de rendez-vous (Datatable)

requires authentication

Ce endpoint retourne une liste paginée et filtrable des types de rendez-vous selon les paramètres utilisés par la bibliothèque DataTables.

Example request:

curl --request GET \
    --get "http://core.localhost/api/v1/get/appointmentType/datatable?draw=17&start=17&length=17&order=consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/get/appointmentType/datatable"
);

const params = {
    "draw": "17",
    "start": "17",
    "length": "17",
    "order": "consequatur",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "draw": 1,
    "recordsTotal": 2,
    "recordsFiltered": 1,
    "data": [
        {
            "id": "01e3c93b-d9c1-49b3-8a24-8fd3e2f28b3f",
            "name": "Consultation médicale",
            "Actions": null
        }
    ]
}
 

Example response (403):

{
    "message": "Vous n’avez pas la permission d’effectuer cette action."
}
 

Request    Try it out ⚡   

GET api/v1/get/appointmentType/datatable

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

draw   integer  optional  

Example: 17

start   integer  optional  

Example: 17

length   integer  optional  

Example: 17

order   string  optional  

array Example: consequatur

search.value   string  optional  

Example: consequatur

Créer un nouveau type de rendez-vous

requires authentication

Ce endpoint permet de créer un nouveau type de rendez-vous dans la société de l'utilisateur. L'utilisateur doit avoir la permission de création de rendez-vous.

Example request:

curl --request POST \
    "http://core.localhost/api/v1/store/appointmentType" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/store/appointmentType"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):

{
    data{
        "id": "01e3c93b-d9c1-49b3-8a24-8fd3e2f28b3f",
         "name": "Consultation médicale",
     }
 }
 

Example response (403):

{
    "message": "Vous n’avez pas la permission d’effectuer cette action."
}
 

Request    Try it out ⚡   

POST api/v1/store/appointmentType

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Example: consequatur

Mettre à jour un type de rendez-vous existant

requires authentication

Ce endpoint permet de modifier les informations d'un type de rendez-vous. L'utilisateur doit disposer de la permission de mise à jour des rendez-vous.

Example request:

curl --request PATCH \
    "http://core.localhost/api/v1/update/consequatur/appointmentType" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\"
}"

const url = new URL(
    "http://core.localhost/api/v1/update/consequatur/appointmentType"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "consequatur"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):

{
    data{
        "id": "01e3c93b-d9c1-49b3-8a24-8fd3e2f28b3f",
         "name": "Consultation médicale",
     }
  }
 

Example response (403):

{
    "message": "Vous n’avez pas la permission d’effectuer cette action."
}
 

Request    Try it out ⚡   

PATCH api/v1/update/{appointmentType_id}/appointmentType

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

appointmentType_id   string   

The ID of the appointmentType. Example: consequatur

appointmentType   string  optional  

AppointmentType required Example: consequatur

Body Parameters

name   string   

Example: consequatur

Supprimer un type de rendez-vous

requires authentication

Ce endpoint supprime un type de rendez-vous spécifié par son identifiant UUID. L'utilisateur doit avoir la permission de suppression pour effectuer cette action.

Example request:

curl --request DELETE \
    "http://core.localhost/api/v1/delete/consequatur/appointmentType" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://core.localhost/api/v1/delete/consequatur/appointmentType"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):

{
    "message": "Type de rendez-vous supprimé avec succès."
}
 

Example response (403):

{
    "message": "Vous n’avez pas la permission d’effectuer cette action."
}
 

Example response (422):

{
    "message": "Impossible de supprimer ce type de rendez-vous."
}
 

Request    Try it out ⚡   

DELETE api/v1/delete/{appointmentType}/appointmentType

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

appointmentType   string  optional  

uuid required Example: consequatur