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.

Show Contact

get

Authorizations

BearerBasic

HTTPRequired

Path parameters

contactIdinteger · int64 · min: 1Required

Responses

200

A JSON object containing the book details.

application/json

genderstringOptional

firstnamestringRequired

idintegerOptional

lastnamestringRequired

languagestringOptional

phonestringOptional

mobilestringOptional

businessPhonestringOptional

businessMobilestringOptional

businessEmailstringOptional

emailstringOptional

titlestringOptional

birthdaystringOptional

Date in Format Y-m-d

400

The server could not understand the request due to invalid syntax. The client should modify the request and try again.

application/json

401

Authentication is required to access the requested resource. The client must include the appropriate credentials.

application/json

403

The server understood the request, but refuses to authorize it. Ensure the client has appropriate permissions.

application/json

404

The server cannot find the requested resource. The endpoint may be invalid or the resource may no longer exist.

application/json

500

The server encountered an unexpected condition that prevented it from fulfilling the request. Report the issue to the support team if it persists.

application/json

get

/contact/{contactId}

HTTPcURLJavaScriptPython

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"
}

Delete Contact

delete

Authorizations

BearerBasic

HTTPRequired

Path parameters

contactIdinteger · int64 · min: 1Required

Responses

204

The request was successful, but there is no content to return in the response.

application/json

400

The server could not understand the request due to invalid syntax. The client should modify the request and try again.

application/json

401

Authentication is required to access the requested resource. The client must include the appropriate credentials.

application/json

403

The server understood the request, but refuses to authorize it. Ensure the client has appropriate permissions.

application/json

404

The server cannot find the requested resource. The endpoint may be invalid or the resource may no longer exist.

application/json

409

The request could not be completed due to a conflict with the current state of the resource. Resolve the conflict and try again.

application/json

500

The server encountered an unexpected condition that prevented it from fulfilling the request. Report the issue to the support team if it persists.

application/json

delete

/contact/{contactId}

HTTPcURLJavaScriptPython

DELETE /api/api/contact/{contactId} HTTP/1.1
Host: testapi.cuco.lu
Authorization: Basic username:password
Accept: */*

No content

Update Contact

patch

Authorizations

BearerBasic

HTTPRequired

Path parameters

contactIdinteger · int64 · min: 1Required

Body

multipart/form-data

genderstringOptional

firstnamestringOptional

lastnamestringOptional

languagestringOptional

phonestringOptional

mobilestringOptional

businessPhonestringOptional

businessMobilestringOptional

businessEmailstringOptional

emailstringOptional

titlestringOptional

birthdaystringOptional

Responses

200

The request was successful, and the server has returned the requested resource in the response body.

application/json

genderstringOptional

firstnamestringRequired

idintegerOptional

lastnamestringRequired

languagestringOptional

phonestringOptional

mobilestringOptional

businessPhonestringOptional

businessMobilestringOptional

businessEmailstringOptional

emailstringOptional

titlestringOptional

birthdaystringOptional

Date in Format Y-m-d

401

Authentication is required to access the requested resource. The client must include the appropriate credentials.

application/json

404

The server cannot find the requested resource. The endpoint may be invalid or the resource may no longer exist.

application/json

patch

/contact/{contactId}

HTTPcURLJavaScriptPython

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"
}

Index Contacts

get

Authorizations

BearerBasic

HTTPRequired

Responses

200

A JSON array containing book objects.

application/json

genderstringOptional

firstnamestringRequired

idintegerOptional

lastnamestringRequired

languagestringOptional

phonestringOptional

mobilestringOptional

businessPhonestringOptional

businessMobilestringOptional

businessEmailstringOptional

emailstringOptional

titlestringOptional

birthdaystringOptional

Date in Format Y-m-d

400

The server could not understand the request due to invalid syntax. The client should modify the request and try again.

application/json

401

Authentication is required to access the requested resource. The client must include the appropriate credentials.

application/json

403

The server understood the request, but refuses to authorize it. Ensure the client has appropriate permissions.

application/json

500

The server encountered an unexpected condition that prevented it from fulfilling the request. Report the issue to the support team if it persists.

application/json

get

/contact

HTTPcURLJavaScriptPython

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"
  }
]

Create Contacts

post

Authorizations

BearerBasic

HTTPRequired

Bodyobject[]

multipart/form-data

Data transfer object for creating a new Contact.

genderstringOptional

firstnamestringRequired

lastnamestringRequired

languagestringOptional

phonestringOptional

mobilestringOptional

businessPhonestringOptional

businessMobilestringOptional

businessEmailstringOptional

emailstringOptional

titlestringOptional

birthdaystringOptional

Responses

201

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.

application/json

400

The server could not understand the request due to invalid syntax. The client should modify the request and try again.

application/json

401

Authentication is required to access the requested resource. The client must include the appropriate credentials.

application/json

403

The server understood the request, but refuses to authorize it. Ensure the client has appropriate permissions.

application/json

post

/contact

HTTPcURLJavaScriptPython

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"
}