Public API
Laravel REST API
The following routes are public available for everyone with a valid access token or basic auth credentials.
The modesk module API provides programmatic access to get a list of all contacts, to create, update or delete existing items by ID.
To use this API, you need an Username and Password. Please contact us at [email protected] to get your own API key or credentials.
A JSON object containing the book details.
The server could not understand the request due to invalid syntax. The client should modify the request and try again.
Authentication is required to access the requested resource. The client must include the appropriate credentials.
The server understood the request, but refuses to authorize it. Ensure the client has appropriate permissions.
The server cannot find the requested resource. The endpoint may be invalid or the resource may no longer exist.
The server encountered an unexpected condition that prevented it from fulfilling the request. Report the issue to the support team if it persists.
GET /api/api/contact/{contactId} HTTP/1.1
Host: testapi.cuco.lu
Authorization: Basic username:password
Accept: */*
{
"gender": "text",
"firstname": "text",
"id": 1,
"lastname": "text",
"language": "text",
"phone": "text",
"mobile": "text",
"businessPhone": "text",
"businessMobile": "text",
"businessEmail": "text",
"email": "text",
"title": "text",
"birthday": "text"
}The request was successful, but there is no content to return in the response.
The server could not understand the request due to invalid syntax. The client should modify the request and try again.
Authentication is required to access the requested resource. The client must include the appropriate credentials.
The server understood the request, but refuses to authorize it. Ensure the client has appropriate permissions.
The server cannot find the requested resource. The endpoint may be invalid or the resource may no longer exist.
The request could not be completed due to a conflict with the current state of the resource. Resolve the conflict and try again.
The server encountered an unexpected condition that prevented it from fulfilling the request. Report the issue to the support team if it persists.
DELETE /api/api/contact/{contactId} HTTP/1.1
Host: testapi.cuco.lu
Authorization: Basic username:password
Accept: */*
No content
The request was successful, and the server has returned the requested resource in the response body.
Authentication is required to access the requested resource. The client must include the appropriate credentials.
The server cannot find the requested resource. The endpoint may be invalid or the resource may no longer exist.
PATCH /api/api/contact/{contactId} HTTP/1.1
Host: testapi.cuco.lu
Authorization: Basic username:password
Content-Type: multipart/form-data
Accept: */*
Content-Length: 221
{
"gender": "text",
"firstname": "text",
"lastname": "text",
"language": "text",
"phone": "text",
"mobile": "text",
"businessPhone": "text",
"businessMobile": "text",
"businessEmail": "text",
"email": "text",
"title": "text",
"birthday": "text"
}{
"gender": "text",
"firstname": "text",
"id": 1,
"lastname": "text",
"language": "text",
"phone": "text",
"mobile": "text",
"businessPhone": "text",
"businessMobile": "text",
"businessEmail": "text",
"email": "text",
"title": "text",
"birthday": "text"
}A JSON array containing book objects.
The server could not understand the request due to invalid syntax. The client should modify the request and try again.
Authentication is required to access the requested resource. The client must include the appropriate credentials.
The server understood the request, but refuses to authorize it. Ensure the client has appropriate permissions.
The server encountered an unexpected condition that prevented it from fulfilling the request. Report the issue to the support team if it persists.
GET /api/api/contact HTTP/1.1
Host: testapi.cuco.lu
Authorization: Basic username:password
Accept: */*
[
{
"gender": "text",
"firstname": "text",
"id": 1,
"lastname": "text",
"language": "text",
"phone": "text",
"mobile": "text",
"businessPhone": "text",
"businessMobile": "text",
"businessEmail": "text",
"email": "text",
"title": "text",
"birthday": "text"
}
]Data transfer object for creating a new Contact.
The request was successful, and a new resource was created. The URI of the newly created resource can be found in the response's Location header.
The server could not understand the request due to invalid syntax. The client should modify the request and try again.
Authentication is required to access the requested resource. The client must include the appropriate credentials.
The server understood the request, but refuses to authorize it. Ensure the client has appropriate permissions.
POST /api/api/contact HTTP/1.1
Host: testapi.cuco.lu
Authorization: Basic username:password
Content-Type: multipart/form-data
Accept: */*
Content-Length: 223
[
{
"gender": "text",
"firstname": "text",
"lastname": "text",
"language": "text",
"phone": "text",
"mobile": "text",
"businessPhone": "text",
"businessMobile": "text",
"businessEmail": "text",
"email": "text",
"title": "text",
"birthday": "text"
}
]{
"gender": "text",
"firstname": "text",
"id": 1,
"lastname": "text",
"language": "text",
"phone": "text",
"mobile": "text",
"businessPhone": "text",
"businessMobile": "text",
"businessEmail": "text",
"email": "text",
"title": "text",
"birthday": "text"
}Last updated