MENU navbar-image

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.

Counties

GET api/v1/counties

Example request:
curl --request GET \
    --get "http://localhost/api/v1/counties" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/counties"
);

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

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

Request      

GET api/v1/counties

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Data Items

Get a list of the resource.

requires authentication

Example request:
curl --request GET \
    --get "http://localhost/api/v1/formData" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/formData"
);

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

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

Example response (200):


{
    "message": "all stored form data",
    "formsData": [
        {
            "id": 2659,
            "name": "Balken und Boden in der AK 7/8 Gerätturnen weiblich Leistungssport",
            "manu": "261002012005",
            "unitAmount": 8,
            "type": "course",
            "currentState": "\"checked\"",
            "phoenixID": "f40a6578-e8d9-434c-b238-a7c8a29fa804",
            "phoenixAttachmentID": "21A3B751-27CC-43FF-B1F9-9E1C1CF46C1B",
            "form_id": 12,
            "chapter": "3.5.",
            "data": [
                {
                    "Terminstart": "2026-02-15",
                    "Terminende": "2026-02-15",
                    "end": "2026-02-01"
                },
                {
                    "Linzenzverlaengerung": [
                        {
                            "id": "GT",
                            "title": "Trainer C Leistungssport Gerätturnen"
                        },
                        {
                            "id": "GTB",
                            "title": "Trainer C Breitensport Gerätturnen"
                        },
                        {
                            "id": "All",
                            "title": "ÜL C Allround-Fitness"
                        },
                        {
                            "id": "ÜLCERW",
                            "title": "BLSV ÜL C Breitensport Profil Erwachsene/Ältere"
                        },
                        {
                            "id": "ÜLCKiJu",
                            "title": "BLSV ÜL C Breitensport Profil Kinder/Jugendliche"
                        }
                    ],
                    "content": "<p>Es werden methodische Wege zum Erlernen der Elemente aus den Balken- und Bodenübungen der AK 7/8 besprochen. Des Weiteren werden auch die relevanten Wertungsvorschriften behandelt.</p>",
                    "sonst": "<p>Alle Trainer C Leistungssport Gerätturnen Lizenzinhabenden bekommen einen Lehrgangsplatz nach Anmeldedatum und Kapazität (wie gewohnt). Breitensport-Lizenzinhabende kommen zuerst auf die Warteliste, werden darüber informiert und nach Meldeschluss zum Lehrgang zugelassen, sofern noch Kapazitäten frei sind. Dabei entscheidet das Datum der Anmeldung über die Reihenfolge der Zulassung.&nbsp;</p>",
                    "minda": "16",
                    "zulasv": [
                        {
                            "id": "118",
                            "title": "Teilnehmende mit Trainer C Leistungssport Lizenz werden bevorzugt zugelassen"
                        }
                    ]
                },
                {
                    "fee": 70,
                    "feeextern": 105,
                    "Stornokosten": {
                        "id": "20,00 Euro",
                        "title": "20,00 Euro"
                    }
                },
                {
                    "ansp": {
                        "id": 14488,
                        "title": "Alessa Wirth"
                    },
                    "MaxTN": "25",
                    "MinTN": "10"
                },
                {
                    "SemO": {
                        "id": "27785036-641C-499D-9EB9-D228ED03D06C",
                        "title": "Landesleistungszentrum des BTV, Höglwörtherstr. 221, 81379 München"
                    },
                    "bezirk": {
                        "id": "AE2BC983-0335-4EDB-9DCC-C2F64A0C4FC0",
                        "title": "Oberbayern"
                    },
                    "gau": {
                        "id": "3843A6B3-1426-45DC-ABC6-95AF2F688C68",
                        "title": "München"
                    }
                },
                {
                    "Mitarbeiterserv": "Jannica Viehweg jannica.viehweg@btv-turnen.de"
                },
                {
                    "one": null,
                    "two": null,
                    "three": null,
                    "four": null,
                    "five": null,
                    "six": null
                }
            ],
            "created_at": "2025-06-23T11:43:37.000000Z",
            "updated_at": "2025-12-04T09:47:05.000000Z",
            "deleted_at": null,
            "created_by_user_id": 191,
            "updated_by_user_id": 191,
            "deleted_by_user_id": null,
            "transitions": [
                "print"
            ],
            "created_by": {
                "id": 191,
                "name": "Sabine Schönberger",
                "email": "sabine.schoenberger@btv-turnen.de",
                "last_login_at": "2026-01-26 12:18:07",
                "require_reset": 0,
                "created_at": "2024-08-21T09:48:37.000000Z",
                "updated_at": "2026-01-26T11:18:07.000000Z"
            },
            "comments": []
        }
    ]
}
 

Example response (401):


Unauthorized action.
 

Example response (403):


Forbidden action.
 

Example response (422):


Required parameter missing or wrong.
 

Example response (500):


Error while data item creation.
 

Request      

GET api/v1/formData

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

rows   integer  optional    

The max amount of returned items. Useful for e.g. pagination. Example: 17

type   string  optional    

The content item type. For now, only course is used. Example: consequatur

Store a newly created data item in storage.

requires authentication

Example request:
curl --request POST \
    "http://localhost/api/v1/formData" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\",
    \"unitAmount\": 45
}"
const url = new URL(
    "http://localhost/api/v1/formData"
);

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

let body = {
    "name": "consequatur",
    "unitAmount": 45
};

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

Example response (201):


Data item created successfully.
 

Example response (401):


Unauthorized action..
 

Example response (403):


Forbidden action.
 

Example response (422):


Required parameter missing or wrong.
 

Example response (500):


Error while data item creation.
 

Request      

POST api/v1/formData

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Example: consequatur

unitAmount   integer     

Must be at least 1. Example: 45

Display the specified resource.

requires authentication

Example request:
curl --request GET \
    --get "http://localhost/api/v1/formData/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/formData/consequatur"
);

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

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

Example response (401):


Unauthorized action..
 

Example response (403):


Forbidden action.
 

Example response (404):


Form not found.
 

Example response (500):


Error while data item creation.
 

Request      

GET api/v1/formData/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the formDatum. Example: consequatur

Update the specified resource in storage.

requires authentication

Example request:
curl --request PUT \
    "http://localhost/api/v1/formData/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\",
    \"unitAmount\": 45
}"
const url = new URL(
    "http://localhost/api/v1/formData/consequatur"
);

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

let body = {
    "name": "consequatur",
    "unitAmount": 45
};

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

Request      

PUT api/v1/formData/{id}

PATCH api/v1/formData/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the formDatum. Example: consequatur

Body Parameters

name   string     

Example: consequatur

unitAmount   integer     

Must be at least 1. Example: 45

Remove the specified resource from storage.

requires authentication

Example request:
curl --request DELETE \
    "http://localhost/api/v1/formData/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/formData/consequatur"
);

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

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

Request      

DELETE api/v1/formData/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the formDatum. Example: consequatur

POST api/v1/formData/states

requires authentication

Example request:
curl --request POST \
    "http://localhost/api/v1/formData/states" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/formData/states"
);

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

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

Request      

POST api/v1/formData/states

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/formData/comments

requires authentication

Example request:
curl --request POST \
    "http://localhost/api/v1/formData/comments" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 17
}"
const url = new URL(
    "http://localhost/api/v1/formData/comments"
);

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

let body = {
    "id": 17
};

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

Request      

POST api/v1/formData/comments

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

id   integer     

Example: 17

POST api/v1/formData/history

requires authentication

Example request:
curl --request POST \
    "http://localhost/api/v1/formData/history" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 17
}"
const url = new URL(
    "http://localhost/api/v1/formData/history"
);

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

let body = {
    "id": 17
};

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

Request      

POST api/v1/formData/history

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

id   integer     

Example: 17

POST api/v1/formData/myComments

requires authentication

Example request:
curl --request POST \
    "http://localhost/api/v1/formData/myComments" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"consequatur\"
}"
const url = new URL(
    "http://localhost/api/v1/formData/myComments"
);

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

let body = {
    "type": "consequatur"
};

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

Request      

POST api/v1/formData/myComments

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

type   string     

Example: consequatur

POST api/v1/formData/userStatistics

requires authentication

Example request:
curl --request POST \
    "http://localhost/api/v1/formData/userStatistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"consequatur\"
}"
const url = new URL(
    "http://localhost/api/v1/formData/userStatistics"
);

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

let body = {
    "type": "consequatur"
};

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

Request      

POST api/v1/formData/userStatistics

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

type   string     

Example: consequatur

POST api/v1/formData/workflow

requires authentication

Example request:
curl --request POST \
    "http://localhost/api/v1/formData/workflow" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"newState\": \"consequatur\"
}"
const url = new URL(
    "http://localhost/api/v1/formData/workflow"
);

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

let body = {
    "newState": "consequatur"
};

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

Request      

POST api/v1/formData/workflow

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

newState   string     

Example: consequatur

POST api/v1/formData/export

requires authentication

Example request:
curl --request POST \
    "http://localhost/api/v1/formData/export" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filter\": \"consequatur\"
}"
const url = new URL(
    "http://localhost/api/v1/formData/export"
);

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

let body = {
    "filter": "consequatur"
};

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

Request      

POST api/v1/formData/export

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

filter   string     

Example: consequatur

POST api/v1/formData/export/phoenix

requires authentication

Example request:
curl --request POST \
    "http://localhost/api/v1/formData/export/phoenix" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/formData/export/phoenix"
);

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

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

Request      

POST api/v1/formData/export/phoenix

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Endpoints

GET api/version

Example request:
curl --request GET \
    --get "http://localhost/api/version" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/version"
);

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

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

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 7200
x-ratelimit-remaining: 7199
vary: Origin
 

{
    "number": "v1.0.11-1000d2",
    "name": "V1"
}
 

Request      

GET api/version

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

login api

Example request:
curl --request POST \
    "http://localhost/api/v1/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/login"
);

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

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

Request      

POST api/v1/login

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Forms

Display a listing of the resource.

Example request:
curl --request GET \
    --get "http://localhost/api/v1/forms" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/forms"
);

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

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

Request      

GET api/v1/forms

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Store a newly created resource in storage.

Example request:
curl --request POST \
    "http://localhost/api/v1/forms" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\",
    \"definitions\": \"consequatur\"
}"
const url = new URL(
    "http://localhost/api/v1/forms"
);

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

let body = {
    "name": "consequatur",
    "definitions": "consequatur"
};

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

Request      

POST api/v1/forms

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Example: consequatur

definitions   string     

Example: consequatur

Display the specified resource.

Example request:
curl --request GET \
    --get "http://localhost/api/v1/forms/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/forms/17"
);

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

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

Request      

GET api/v1/forms/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the form. Example: 17

Update the specified resource in storage.

Example request:
curl --request PUT \
    "http://localhost/api/v1/forms/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\",
    \"definitions\": \"consequatur\"
}"
const url = new URL(
    "http://localhost/api/v1/forms/17"
);

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

let body = {
    "name": "consequatur",
    "definitions": "consequatur"
};

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

Request      

PUT api/v1/forms/{id}

PATCH api/v1/forms/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the form. Example: 17

Body Parameters

name   string     

Example: consequatur

definitions   string     

Example: consequatur

Remove the specified resource from storage.

Example request:
curl --request DELETE \
    "http://localhost/api/v1/forms/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/forms/17"
);

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

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

Request      

DELETE api/v1/forms/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the form. Example: 17

Locations

GET api/v1/locations

Example request:
curl --request GET \
    --get "http://localhost/api/v1/locations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/locations"
);

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

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

Request      

GET api/v1/locations

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Permissions

Display a listing of the resource.

Example request:
curl --request GET \
    --get "http://localhost/api/v1/permissions" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/permissions"
);

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

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

Request      

GET api/v1/permissions

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Store a newly created resource in storage.

Example request:
curl --request POST \
    "http://localhost/api/v1/permissions" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\"
}"
const url = new URL(
    "http://localhost/api/v1/permissions"
);

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());

Request      

POST api/v1/permissions

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Example: consequatur

Display the specified resource.

Example request:
curl --request GET \
    --get "http://localhost/api/v1/permissions/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/permissions/consequatur"
);

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

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

Request      

GET api/v1/permissions/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the permission. Example: consequatur

Update the specified resource in storage.

Example request:
curl --request PUT \
    "http://localhost/api/v1/permissions/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/permissions/consequatur"
);

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

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

Request      

PUT api/v1/permissions/{id}

PATCH api/v1/permissions/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the permission. Example: consequatur

Remove the specified resource from storage.

Example request:
curl --request DELETE \
    "http://localhost/api/v1/permissions/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/permissions/consequatur"
);

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

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

Request      

DELETE api/v1/permissions/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the permission. Example: consequatur

Roles

Display a listing of the resource.

Example request:
curl --request GET \
    --get "http://localhost/api/v1/roles" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/roles"
);

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

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

Request      

GET api/v1/roles

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Store a newly created resource in storage.

Example request:
curl --request POST \
    "http://localhost/api/v1/roles" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\"
}"
const url = new URL(
    "http://localhost/api/v1/roles"
);

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());

Request      

POST api/v1/roles

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Example: consequatur

Display the specified resource.

Example request:
curl --request GET \
    --get "http://localhost/api/v1/roles/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/roles/17"
);

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

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

Request      

GET api/v1/roles/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the role. Example: 17

Update the specified resource in storage.

Example request:
curl --request PUT \
    "http://localhost/api/v1/roles/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/roles/17"
);

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

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

Request      

PUT api/v1/roles/{id}

PATCH api/v1/roles/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the role. Example: 17

Remove the specified resource from storage.

Example request:
curl --request DELETE \
    "http://localhost/api/v1/roles/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/roles/17"
);

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

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

Request      

DELETE api/v1/roles/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the role. Example: 17

Settings

Get a list of all existing settings.

Example request:
curl --request GET \
    --get "http://localhost/api/v1/settings" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/settings"
);

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

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

Request      

GET api/v1/settings

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Store a newly created resource in storage.

Example request:
curl --request POST \
    "http://localhost/api/v1/settings" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\",
    \"type\": \"consequatur\",
    \"data\": \"consequatur\"
}"
const url = new URL(
    "http://localhost/api/v1/settings"
);

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

let body = {
    "name": "consequatur",
    "type": "consequatur",
    "data": "consequatur"
};

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

Request      

POST api/v1/settings

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Example: consequatur

type   string     

Example: consequatur

data   string     

Example: consequatur

Display the specified resource.

Example request:
curl --request GET \
    --get "http://localhost/api/v1/settings/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/settings/17"
);

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

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

Request      

GET api/v1/settings/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the setting. Example: 17

Update the specified resource in storage.

Example request:
curl --request PUT \
    "http://localhost/api/v1/settings/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\",
    \"type\": \"consequatur\",
    \"data\": \"consequatur\"
}"
const url = new URL(
    "http://localhost/api/v1/settings/17"
);

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

let body = {
    "name": "consequatur",
    "type": "consequatur",
    "data": "consequatur"
};

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

Request      

PUT api/v1/settings/{id}

PATCH api/v1/settings/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the setting. Example: 17

Body Parameters

name   string     

Example: consequatur

type   string     

Example: consequatur

data   string     

Example: consequatur

Remove the specified resource from storage.

Example request:
curl --request DELETE \
    "http://localhost/api/v1/settings/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/settings/17"
);

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

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

Request      

DELETE api/v1/settings/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the setting. Example: 17

Teams

Display a listing of the resource.

Example request:
curl --request GET \
    --get "http://localhost/api/v1/teams" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/teams"
);

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

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

Request      

GET api/v1/teams

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Store a newly created resource in storage.

Example request:
curl --request POST \
    "http://localhost/api/v1/teams" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\"
}"
const url = new URL(
    "http://localhost/api/v1/teams"
);

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());

Request      

POST api/v1/teams

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Example: consequatur

Display the specified resource.

Example request:
curl --request GET \
    --get "http://localhost/api/v1/teams/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/teams/17"
);

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

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

Request      

GET api/v1/teams/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the team. Example: 17

Update the specified resource in storage.

Example request:
curl --request PUT \
    "http://localhost/api/v1/teams/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/teams/17"
);

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

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

Request      

PUT api/v1/teams/{id}

PATCH api/v1/teams/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the team. Example: 17

Remove the specified resource from storage.

Example request:
curl --request DELETE \
    "http://localhost/api/v1/teams/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/teams/17"
);

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

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

Request      

DELETE api/v1/teams/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the team. Example: 17

Templates

Display a listing of the resource.

Example request:
curl --request GET \
    --get "http://localhost/api/v1/templates" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/templates"
);

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

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

Request      

GET api/v1/templates

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Store a newly created resource in storage.

Example request:
curl --request POST \
    "http://localhost/api/v1/templates" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\",
    \"text\": \"consequatur\"
}"
const url = new URL(
    "http://localhost/api/v1/templates"
);

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

let body = {
    "name": "consequatur",
    "text": "consequatur"
};

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

Request      

POST api/v1/templates

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Example: consequatur

text   string     

Example: consequatur

Display the specified resource.

Example request:
curl --request GET \
    --get "http://localhost/api/v1/templates/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/templates/17"
);

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

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

Request      

GET api/v1/templates/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the template. Example: 17

Update the specified resource in storage.

Example request:
curl --request PUT \
    "http://localhost/api/v1/templates/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\",
    \"text\": \"consequatur\"
}"
const url = new URL(
    "http://localhost/api/v1/templates/17"
);

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

let body = {
    "name": "consequatur",
    "text": "consequatur"
};

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

Request      

PUT api/v1/templates/{id}

PATCH api/v1/templates/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the template. Example: 17

Body Parameters

name   string     

Example: consequatur

text   string     

Example: consequatur

Remove the specified resource from storage.

Example request:
curl --request DELETE \
    "http://localhost/api/v1/templates/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/templates/17"
);

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

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

Request      

DELETE api/v1/templates/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the template. Example: 17

Text Blocks

Display a listing of the resource.

Example request:
curl --request GET \
    --get "http://localhost/api/v1/textBlocks" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/textBlocks"
);

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

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

Request      

GET api/v1/textBlocks

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Store a newly created resource in storage.

Example request:
curl --request POST \
    "http://localhost/api/v1/textBlocks" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\",
    \"text\": \"consequatur\"
}"
const url = new URL(
    "http://localhost/api/v1/textBlocks"
);

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

let body = {
    "name": "consequatur",
    "text": "consequatur"
};

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

Request      

POST api/v1/textBlocks

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Example: consequatur

text   string     

Example: consequatur

Display the specified resource.

Example request:
curl --request GET \
    --get "http://localhost/api/v1/textBlocks/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/textBlocks/17"
);

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

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

Request      

GET api/v1/textBlocks/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the textBlock. Example: 17

Update the specified resource in storage.

Example request:
curl --request PUT \
    "http://localhost/api/v1/textBlocks/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\",
    \"text\": \"consequatur\"
}"
const url = new URL(
    "http://localhost/api/v1/textBlocks/17"
);

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

let body = {
    "name": "consequatur",
    "text": "consequatur"
};

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

Request      

PUT api/v1/textBlocks/{id}

PATCH api/v1/textBlocks/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the textBlock. Example: 17

Body Parameters

name   string     

Example: consequatur

text   string     

Example: consequatur

Remove the specified resource from storage.

Example request:
curl --request DELETE \
    "http://localhost/api/v1/textBlocks/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/textBlocks/17"
);

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

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

Request      

DELETE api/v1/textBlocks/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the textBlock. Example: 17

Users

User management.

Get a list of all users.

requires authentication

Example request:
curl --request GET \
    --get "http://localhost/api/v1/users" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/users"
);

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

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

Request      

GET api/v1/users

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Create a new user.

requires authentication

Example request:
curl --request POST \
    "http://localhost/api/v1/users" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"John Doe\",
    \"email\": \"john.doe@example.com\",
    \"password\": \"ij-e\\/dl4m\"
}"
const url = new URL(
    "http://localhost/api/v1/users"
);

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

let body = {
    "name": "John Doe",
    "email": "john.doe@example.com",
    "password": "ij-e\/dl4m"
};

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

Example response (201):


User created successfully.
 

Example response (401):


Unauthorized action..
 

Example response (403):


Forbidden action.
 

Example response (422):


Required parameter missing or wrong.
 

Example response (500):


Error while user creation.
 

Request      

POST api/v1/users

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

The user name. Example: John Doe

email   string     

The user email. Example: john.doe@example.com

password   string     

Must be at least 8 characters. Example: ij-e/dl4m

role   string  optional    

The name of an existing record in the roles table.

Display the specified resource.

requires authentication

Example request:
curl --request GET \
    --get "http://localhost/api/v1/users/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/users/17"
);

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

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

Request      

GET api/v1/users/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the user. Example: 17

Remove the specified resource from storage.

requires authentication

Example request:
curl --request DELETE \
    "http://localhost/api/v1/users/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/users/17"
);

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

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

Request      

DELETE api/v1/users/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the user. Example: 17

Update the specified resource in storage.

requires authentication

Example request:
curl --request PUT \
    "http://localhost/api/v1/users/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\",
    \"password\": \"[2UZ5ij-e\\/dl4\"
}"
const url = new URL(
    "http://localhost/api/v1/users/17"
);

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

let body = {
    "name": "consequatur",
    "password": "[2UZ5ij-e\/dl4"
};

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

Request      

PUT api/v1/users/{id}

PATCH api/v1/users/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the user. Example: 17

Body Parameters

name   string     

Example: consequatur

password   string  optional    

'email' => 'required|email|unique:users',. Must be at least 8 characters. Example: [2UZ5ij-e/dl4

role   string  optional    

The name of an existing record in the roles table.