Laminas API Tools

billing

billing operations

GET /companies/billing[/:billing_id]

Fields

Field	Type	Description	Required
priceId	integer	package price id which the client wants to book	YES
userId		if priceId = 9, provide a user id for which the job assitent should be activated	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/companies/billing"
       },
       "first": {
           "href": "/companies/billing?page={page}"
       },
       "prev": {
           "href": "/companies/billing?page={page}"
       },
       "next": {
           "href": "/companies/billing?page={page}"
       },
       "last": {
           "href": "/companies/billing?page={page}"
       }
   }
   "_embedded": {
       "billing": [
        {
            "id": "billing id",
            "paymentStatus": "payment status [pending, paid, canceled]",
            "email": "company contact email",
            "telephone": "company contact telephone number",
            "companyName": "company name",
            "companyNameBilling": "company billing name in case its different",
            "streetBilling": "billing street",
            "addressAdditional": "additional address info for billing address",
            "zipcodeBilling": "billing zipcode",
            "cityBilling": "billing city",
            "countryBilling": "billing country",
            "bill": "url path to billing document",
            "price": "price",
            "vat": "vat",
            "vatId": "company's VAT ID",
            "credits": "amount of credits",
            "orderDateTime": {
                "date": "2024-08-21 09:07:13.000000",
                "timezone_type": 3,
                "timezone": "Europe/Berlin"
            },
            "validFrom": {
                "date": "2024-08-21 09:07:13.000000",
                "timezone_type": 3,
                "timezone": "Europe/Berlin"
            },
            "validTo": {
                "date": "2025-08-21 09:07:13.000000",
                "timezone_type": 3,
                "timezone": "Europe/Berlin"
            },
            "_links": {
                "self": {
                    "href": "http://localhost:8080/companies/billing/[:billing_id]"
                }
            }
        }
       ]
   }
}

POST /companies/billing[/:billing_id]

Fields

Field	Type	Description	Required
priceId	integer	package price id which the client wants to book	YES
userId		if priceId = 9, provide a user id for which the job assitent should be activated	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Content-Type	application/vnd.application-api.v1+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

{
   "priceId": "package price id which the client wants to book"
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

Chat

chat operations

GET /employee/[:employee_id]/chat[/:chat_id]

Fields

Field	Type	Description	Required
message	text	message	YES

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

POST /employee/[:employee_id]/chat[/:chat_id]

Fields

Field	Type	Description	Required
message	text	message	YES

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Content-Type	application/vnd.application-api.v1+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

companiesJobapplicationEmployment

companies jobapplication employment operations

POST /companies/jobapplication/[:jobapplication_id]/employment[/:companies_jobapplication_employment_id]

Fields

Field	Type	Description	Required
employmentStart	String	date string when employment starts	NO
employmentExist	String	date string from when the emplyment status exists	NO
employmentType	Bool	[limited, unlimeted]	YES
professionalLicense	string	license type which is needed to work in offered position	NO
overtimeObligation	Bool	[y, n]	YES
overtimeExtend	String	to which extend is overtime obligated?	NO
overtimeCompansation	String	how is the overtime compansated?	NO
limitedEmploymentEnd	String	date string when limited employment ends	NO
applicationId	integer	job application id for which the employment agreement is created	YES

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Content-Type	application/vnd.application-api.v1+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

{
   "employmentStart": "date string when employment starts",
   "employmentExist": "date string from when the emplyment status exists",
   "employmentType": "[limited, unlimeted]",
   "professionalLicense": "license type which is needed to work in offered position",
   "overtimeObligation": "[y, n]",
   "overtimeExtend": "to which extend is overtime  obligated?",
   "overtimeCompansation": "how is the overtime compansated?",
   "limitedEmploymentEnd": "date string when limited employment ends",
   "applicationId": "job application id for which the employment agreement is created"
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /companies/jobapplication/[:jobapplication_id]/employment[/:companies_jobapplication_employment_id]

Fields

Field	Type	Description	Required
employmentStart	String	date string when employment starts	NO
employmentExist	String	date string from when the emplyment status exists	NO
employmentType	Bool	[limited, unlimeted]	YES
professionalLicense	string	license type which is needed to work in offered position	NO
overtimeObligation	Bool	[y, n]	YES
overtimeExtend	String	to which extend is overtime obligated?	NO
overtimeCompansation	String	how is the overtime compansated?	NO
limitedEmploymentEnd	String	date string when limited employment ends	NO
applicationId	integer	job application id for which the employment agreement is created	YES

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

companiesJobapplication

companiesJobapplication operations

GET /companies/[:joboffers_id]/jobapplication

Fields

Field	Type	Description	Required
joboffers_id	integer	joboffers id	YES
status	string	application status	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /companies/[:joboffers_id]/jobapplication[/:companies_jobapplication_id]

Fields

Field	Type	Description	Required
joboffers_id	integer	joboffers id	YES
status	string	application status	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

PATCH /companies/[:joboffers_id]/jobapplication[/:companies_jobapplication_id]

change the jobapplication status

Fields

Field	Type	Description	Required
joboffers_id	integer	joboffers id	YES
status	string	application status	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Content-Type	application/vnd.application-api.v1+json application/json

Body

{
    "status": "enum [preparing, pending, seen, ,approved, declined]"
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

PUT /companies/[:joboffers_id]/jobapplication[/:companies_jobapplication_id]

Fields

Field	Type	Description	Required
joboffers_id	integer	joboffers id	YES
status	string	application status	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Content-Type	application/vnd.application-api.v1+json application/json

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

companiesJoboffers

companies job offers operations

GET /companies/joboffers

Fields

Field	Type	Description	Required
title	string	job offer title	YES
description	string		YES
jobPosition	string		NO
jobOccupation	string		NO
graduation	string		NO
salary	string		NO
thumbnail	binary		NO
video	binary		NO
applicant_characteristics_01	integer	Organisationsfähigkeit	NO
applicant_characteristics_02	integer	Kreativität	NO
applicant_characteristics_03	integer	Geduld	NO
applicant_characteristics_04	integer	Kommunikationsfähigkeit	NO
applicant_characteristics_05	integer	Teamfähigkeit	NO
languages	array	languages in which the job offer should be published	NO
status	enum	[active, inactive]	NO
facilityId	integer	the facilities ID to which the job offer belongs	YES
languageWhish	string	additional language the customer whishes to add to the platform	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

POST /companies/joboffers

Fields

Field	Type	Description	Required
title	string	job offer title	YES
description	string		YES
jobPosition	string		NO
jobOccupation	string		NO
graduation	string		NO
salary	string		NO
thumbnail	binary		NO
video	binary		NO
applicant_characteristics_01	integer	Organisationsfähigkeit	NO
applicant_characteristics_02	integer	Kreativität	NO
applicant_characteristics_03	integer	Geduld	NO
applicant_characteristics_04	integer	Kommunikationsfähigkeit	NO
applicant_characteristics_05	integer	Teamfähigkeit	NO
languages	array	languages in which the job offer should be published	NO
status	enum	[active, inactive]	NO
facilityId	integer	the facilities ID to which the job offer belongs	YES
languageWhish	string	additional language the customer whishes to add to the platform	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Content-Type	application/vnd.application-api.v1+json application/json multipart/form-data
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

{
   "title": "job offer title",
   "description": "",
   "jobPosition": "",
   "jobOccupation": "",
   "graduation": "",
   "salary": "",
   "thumbnail": "",
   "video": "",
   "applicant_characteristics_01": "Organisationsfähigkeit",
   "applicant_characteristics_02": "Kreativität",
   "applicant_characteristics_03": "Geduld",
   "applicant_characteristics_04": "Kommunikationsfähigkeit",
   "applicant_characteristics_05": "Teamfähigkeit",
   "languages": "languages in which the job offer should be published",
   "languageWhish": "additional language the customer whishes to add to the platform"
   "status": "[active, inactive]",
   "facilityId": "the facilities ID to which the job offer belongs"
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /companies/joboffers[/:companies_joboffers_id]

Fields

Field	Type	Description	Required
title	string	job offer title	YES
description	string		YES
jobPosition	string		NO
jobOccupation	string		NO
graduation	string		NO
salary	string		NO
thumbnail	binary		NO
video	binary		NO
applicant_characteristics_01	integer	Organisationsfähigkeit	NO
applicant_characteristics_02	integer	Kreativität	NO
applicant_characteristics_03	integer	Geduld	NO
applicant_characteristics_04	integer	Kommunikationsfähigkeit	NO
applicant_characteristics_05	integer	Teamfähigkeit	NO
languages	array	languages in which the job offer should be published	NO
status	enum	[active, inactive]	NO
facilityId	integer	the facilities ID to which the job offer belongs	YES
languageWhish	string	additional language the customer whishes to add to the platform	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

PUT /companies/joboffers[/:companies_joboffers_id]

Fields

Field	Type	Description	Required
title	string	job offer title	YES
description	string		YES
jobPosition	string		NO
jobOccupation	string		NO
graduation	string		NO
salary	string		NO
thumbnail	binary		NO
video	binary		NO
applicant_characteristics_01	integer	Organisationsfähigkeit	NO
applicant_characteristics_02	integer	Kreativität	NO
applicant_characteristics_03	integer	Geduld	NO
applicant_characteristics_04	integer	Kommunikationsfähigkeit	NO
applicant_characteristics_05	integer	Teamfähigkeit	NO
languages	array	languages in which the job offer should be published	NO
status	enum	[active, inactive]	NO
facilityId	integer	the facilities ID to which the job offer belongs	YES
languageWhish	string	additional language the customer whishes to add to the platform	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Content-Type	application/vnd.application-api.v1+json application/json multipart/form-data
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

companies

companies operations

GET /companies

Fields

Field	Type	Description	Required
accountPackage	enum	this is the payment package [starter_month, professional_month, professional_year]	YES
companyName	string		YES
ownerDepartment	string	department name in which the company owner works	YES
ownerPosition	string	position in wich the company owner works	YES
street	string	address	YES
zipcode	string	address	YES
city	string	address	YES
country	string	address	NO
companyNameBilling	string	company name on billing address	YES
streetBilling	string	address	YES
addressAdditional	string	additional address info for billing address	NO
zipcodeBilling	string	address	YES
cityBilling	string	address	YES
vatId	string	company's VAT ID	NO
amountEmployees	string	amount of employees working for company	NO
amountFacilities	string		NO
telephone	string		NO
moreInfo	string	a short description about the company	NO
domain	string	companies domain	NO
logo	file	companies logo	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

POST /companies

Fields

Field	Type	Description	Required
accountPackage	enum	this is the payment package [starter_month, professional_month, professional_year]	YES
companyName	string		YES
ownerDepartment	string	department name in which the company owner works	YES
ownerPosition	string	position in wich the company owner works	YES
street	string	address	YES
zipcode	string	address	YES
city	string	address	YES
country	string	address	NO
companyNameBilling	string	company name on billing address	YES
streetBilling	string	address	YES
addressAdditional	string	additional address info for billing address	NO
zipcodeBilling	string	address	YES
cityBilling	string	address	YES
vatId	string	company's VAT ID	NO
amountEmployees	string	amount of employees working for company	NO
amountFacilities	string		NO
telephone	string		NO
moreInfo	string	a short description about the company	NO
domain	string	companies domain	NO
logo	file	companies logo	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Content-Type	application/vnd.application-api.v1+json application/json multipart/form-data

Body

{
   "accountPackage": "this is the payment package [starter, professional_month, professional_year]",
   "companyName": "",
   "ownerDepartment": "department name in which the company owner works",
   "ownerPosition": "position in wich the company owner works",
   "employees": "amount of imployees working for company",
   "street": "address",
   "zipcode": "address",
   "city": "address",
   "country": "address",
   "companyNameBillling": "company name on billing address",
   "streetBilling": "address",
   "addressAdditional": "additional address info for billing address",
   "zipcodeBilling": "address",
   "cityBilling": "address",
   "vatId": "company's VAT ID"
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /companies[/:companies_id]

Fields

Field	Type	Description	Required
accountPackage	enum	this is the payment package [starter_month, professional_month, professional_year]	YES
companyName	string		YES
ownerDepartment	string	department name in which the company owner works	YES
ownerPosition	string	position in wich the company owner works	YES
street	string	address	YES
zipcode	string	address	YES
city	string	address	YES
country	string	address	NO
companyNameBilling	string	company name on billing address	YES
streetBilling	string	address	YES
addressAdditional	string	additional address info for billing address	NO
zipcodeBilling	string	address	YES
cityBilling	string	address	YES
vatId	string	company's VAT ID	NO
amountEmployees	string	amount of employees working for company	NO
amountFacilities	string		NO
telephone	string		NO
moreInfo	string	a short description about the company	NO
domain	string	companies domain	NO
logo	file	companies logo	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

PUT /companies[/:companies_id]

Fields

Field	Type	Description	Required
accountPackage	enum	this is the payment package [starter_month, professional_month, professional_year]	YES
companyName	string		YES
ownerDepartment	string	department name in which the company owner works	YES
ownerPosition	string	position in wich the company owner works	YES
street	string	address	YES
zipcode	string	address	YES
city	string	address	YES
country	string	address	NO
companyNameBilling	string	company name on billing address	YES
streetBilling	string	address	YES
addressAdditional	string	additional address info for billing address	NO
zipcodeBilling	string	address	YES
cityBilling	string	address	YES
vatId	string	company's VAT ID	NO
amountEmployees	string	amount of employees working for company	NO
amountFacilities	string		NO
telephone	string		NO
moreInfo	string	a short description about the company	NO
domain	string	companies domain	NO
logo	file	companies logo	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Content-Type	application/vnd.application-api.v1+json application/json multipart/form-data
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

{
   "accountPackage": "this is the payment package [starter, professional_month, professional_year]",
   "companyName": "",
   "ownerDepartment": "department name in which the company owner works",
   "ownerPosition": "position in wich the company owner works",
   "amountEmployees": "amount of employees working for company",
   "street": "address",
   "zipcode": "address",
   "city": "address",
   "country": "address",
   "companyNameBilling": "company name on billing address",
   "streetBilling": "address",
   "addressAdditional": "additional address info for billing address",
   "zipcodeBilling": "address",
   "cityBilling": "address",
   "vatId": "company's VAT ID"
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

DELETE /companies[/:companies_id]

Fields

Field	Type	Description	Required
accountPackage	enum	this is the payment package [starter_month, professional_month, professional_year]	YES
companyName	string		YES
ownerDepartment	string	department name in which the company owner works	YES
ownerPosition	string	position in wich the company owner works	YES
street	string	address	YES
zipcode	string	address	YES
city	string	address	YES
country	string	address	NO
companyNameBilling	string	company name on billing address	YES
streetBilling	string	address	YES
addressAdditional	string	additional address info for billing address	NO
zipcodeBilling	string	address	YES
cityBilling	string	address	YES
vatId	string	company's VAT ID	NO
amountEmployees	string	amount of employees working for company	NO
amountFacilities	string		NO
telephone	string		NO
moreInfo	string	a short description about the company	NO
domain	string	companies domain	NO
logo	file	companies logo	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
204: No Content
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

POST /companies[/:companies_id]

Fields

Field	Type	Description	Required
accountPackage	enum	this is the payment package [starter_month, professional_month, professional_year]	YES
companyName	string		YES
ownerDepartment	string	department name in which the company owner works	YES
ownerPosition	string	position in wich the company owner works	YES
street	string	address	YES
zipcode	string	address	YES
city	string	address	YES
country	string	address	NO
companyNameBilling	string	company name on billing address	YES
streetBilling	string	address	YES
addressAdditional	string	additional address info for billing address	NO
zipcodeBilling	string	address	YES
cityBilling	string	address	YES
vatId	string	company's VAT ID	NO
amountEmployees	string	amount of employees working for company	NO
amountFacilities	string		NO
telephone	string		NO
moreInfo	string	a short description about the company	NO
domain	string	companies domain	NO
logo	file	companies logo	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Content-Type	application/vnd.application-api.v1+json application/json multipart/form-data

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
404: Not Found
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

employees

employees operations

GET /companies/[:companies_id]/employees

Fields

Field	Type	Description	Required
email	string	employees email address	YES
role	enum	(hrAdmin, hrEmployee, employee)	YES
facilityId	Array	facilities ID	YES

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

POST /companies/[:companies_id]/employees

Fields

Field	Type	Description	Required
email	string	employees email address	YES
role	enum	(hrAdmin, hrEmployee, employee)	YES
facilityId	Array	facilities ID	YES

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Content-Type	application/vnd.application-api.v1+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

{
   "email": ARRAY ["email-1", "email-2", "email-3"],
   "role": ENUM (hrAdmin, hrEmployee, employee)",
   "facilityId": ARRAY [id-1, id-2, id-3]
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

DELETE /companies/[:companies_id]/employees

Fields

Field	Type	Description	Required
email	string	employees email address	YES
role	enum	(hrAdmin, hrEmployee, employee)	YES
facilityId	Array	facilities ID	YES

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
204: No Content

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

DELETE /companies/[:companies_id]/employees[/:employees_id]

Fields

Field	Type	Description	Required
email	string	employees email address	YES
role	enum	(hrAdmin, hrEmployee, employee)	YES
facilityId	Array	facilities ID	YES

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
204: No Content
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

GET /companies/[:companies_id]/employees[/:employees_id]

Fields

Field	Type	Description	Required
email	string	employees email address	YES
role	enum	(hrAdmin, hrEmployee, employee)	YES
facilityId	Array	facilities ID	YES

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

facilities

facilities operations

GET /companies[/:companies_id]/facilities

Fields

Field	Type	Description	Required
facilityName	string		YES
type	string	facility type [Kindergarten, Hort, Kita]	NO
street	string	address	YES
zipcode	string	address	YES
city	string	address	YES
country	string	address	NO
amountEmployees		amount of employees working	NO
telephone	string	telephone number	NO
email	string	email address	NO
logo	file	facility logo	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

POST /companies[/:companies_id]/facilities

Fields

Field	Type	Description	Required
facilityName	string		YES
type	string	facility type [Kindergarten, Hort, Kita]	NO
street	string	address	YES
zipcode	string	address	YES
city	string	address	YES
country	string	address	NO
amountEmployees		amount of employees working	NO
telephone	string	telephone number	NO
email	string	email address	NO
logo	file	facility logo	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Content-Type	application/vnd.application-api.v1+json application/json multipart/form-data

Body

{
   "facilityName": "",
   "type": "facility type [Kindergarten, Hort, Kita]",
   "street": "address",
   "zipcode": "address",
   "city": "address",
   "country": "address",
   "amountEmployees": "amount of employees working",
   "telephone": "telephone number",
   "email": "email address",
   "logo": "facility logo"
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /companies[/:companies_id]/facilities[/:facilities_id]

Fields

Field	Type	Description	Required
facilityName	string		YES
type	string	facility type [Kindergarten, Hort, Kita]	NO
street	string	address	YES
zipcode	string	address	YES
city	string	address	YES
country	string	address	NO
amountEmployees		amount of employees working	NO
telephone	string	telephone number	NO
email	string	email address	NO
logo	file	facility logo	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

PUT /companies[/:companies_id]/facilities[/:facilities_id]

Fields

Field	Type	Description	Required
facilityName	string		YES
type	string	facility type [Kindergarten, Hort, Kita]	NO
street	string	address	YES
zipcode	string	address	YES
city	string	address	YES
country	string	address	NO
amountEmployees		amount of employees working	NO
telephone	string	telephone number	NO
email	string	email address	NO
logo	file	facility logo	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Content-Type	application/vnd.application-api.v1+json application/json multipart/form-data

Body

{
   "facilityName": "",
   "type": "facility type [Kindergarten, Hort, Kita]",
   "street": "address",
   "zipcode": "address",
   "city": "address",
   "country": "address",
   "amountEmployees": "amount of employees working",
   "telephone": "telephone number",
   "email": "email address",
   "logo": "facility logo"
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

DELETE /companies[/:companies_id]/facilities[/:facilities_id]

Fields

Field	Type	Description	Required
facilityName	string		YES
type	string	facility type [Kindergarten, Hort, Kita]	NO
street	string	address	YES
zipcode	string	address	YES
city	string	address	YES
country	string	address	NO
amountEmployees		amount of employees working	NO
telephone	string	telephone number	NO
email	string	email address	NO
logo	file	facility logo	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
204: No Content
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

jobFavorite

job favorite operations

GET /job-favorite

Fields

Field	Type	Description	Required
job_id	integer	job offers id	YES

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

POST /job-favorite

Fields

Field	Type	Description	Required
job_id	integer	job offers id	YES

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Content-Type	application/vnd.application-api.v1+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

DELETE /job-favorite[/:job_favorite_id]

Fields

Field	Type	Description	Required
job_id	integer	job offers id	YES

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
204: No Content
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

joboffersFeed

Job offers feed operations for fan-spaces companies

GET /joboffers-feed[/:joboffers_feed_id]

Retrieve job offers from fan-spaces companies with multi-language support

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

[
    {
        "id": 123,
        "name": "Software Developer",
        "link": "https://fan-spaces.best-places-to-work.com",
        "region": "Bavaria, Berlin",
        "description": "We are looking for an experienced software developer...",
        "company": "FanSpaces GmbH",
        "company_logo": "https://api.best-places-to-work.com/upload/companies/logos/FanSpaces+Logo.png",
        "pubdate": "2024-01-15",
        "updated": "2024-01-15",
        "expire": "2025-01-15",
        "jobtype": "Full-time, Part-time",
        "salary": "€45,000 - €55,000 per year"
    }
]

joboffers

job offers operations

GET /joboffers

show all or filter by company_id, facility_id, state=(url_encoded array), work_field(url_encoded array), position(url_encoded array), employment_type(url_encoded array) which job offers to show

Fields

Field	Type	Description	Required
title	string	job offer title	YES
description	string		YES
jobPosition	string		YES
jobOccupation	string		YES
graduation	string		NO
salary	string		NO
thumbnail	binary		NO
video	binary		NO
applicant_characteristics_01	integer	Organisationsfähigkeit	NO
applicant_characteristics_02	integer	Kreativität	NO
applicant_characteristics_03	integer	Geduld	NO
applicant_characteristics_04	integer	Kommunikationsfähigkeit	NO
applicant_characteristics_05	integer	Teamfähigkeit	NO
languages	array	languages in which the job offer should be published	NO
status	enum	[active, inactive]	NO
facility_id	integer	the facilities ID to which the job offer belongs	YES

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/joboffers"
       },
       "first": {
           "href": "/joboffers?page={page}"
       },
       "prev": {
           "href": "/joboffers?page={page}"
       },
       "next": {
           "href": "/joboffers?page={page}"
       },
       "last": {
           "href": "/joboffers?page={page}"
       }
   }
   "_embedded": {
       "joboffers": [
           {
               "_links": {
                   "self": {
                       "href": "/joboffers[/:joboffers_id]"
                   }
               }
              "title": "job offer title",
              "description": "",
              "jobPosition": "",
              "jobOccupation": "",
              "graduation": "",
              "salary": "",
              "thumbnail": "",
              "video": "",
              "whatsAppQrCode": "opens whatsApp conversation -> set code in image src tag",
              "whatsAppLink": "links to whatsApp conversation",
              "applicant_characteristics_01": "Organisationsfähigkeit",
              "applicant_characteristics_02": "Kreativität",
              "applicant_characteristics_03": "Geduld",
              "applicant_characteristics_04": "Kommunikationsfähigkeit",
              "applicant_characteristics_05": "Teamfähigkeit",
              "languages": "languages in which the job offer should be published",
              "status": "[active, inactive]",
              "facility_id": "the facilities ID to which the job offer belongs",
              "locale": "current language",
             "validTo"; "date till the joboffer is  paid",
             "profession": "enum: childcare, hotel, nursing, service",
             "position": "enum: employee, trainee, freelancer, minijobber",
             "employmentType: "enum: full, part",
              "languageLevel": "enum: a1, a2, b1, b2, c1, c2",
              "jobType": "enum: intern, extern",
              "externUrl": "string: url to redirect in case jobType is extern"
           }
       ]
   }
}

GET /joboffers[/:joboffers_id]

Fields

Field	Type	Description	Required
title	string	job offer title	YES
description	string		YES
jobPosition	string		YES
jobOccupation	string		YES
graduation	string		NO
salary	string		NO
thumbnail	binary		NO
video	binary		NO
applicant_characteristics_01	integer	Organisationsfähigkeit	NO
applicant_characteristics_02	integer	Kreativität	NO
applicant_characteristics_03	integer	Geduld	NO
applicant_characteristics_04	integer	Kommunikationsfähigkeit	NO
applicant_characteristics_05	integer	Teamfähigkeit	NO
languages	array	languages in which the job offer should be published	NO
status	enum	[active, inactive]	NO
facility_id	integer	the facilities ID to which the job offer belongs	YES

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

UserOnboardingFiles

Deprecated: preg_replace(): Passing null to parameter #3 ($subject) of type array|string is deprecated in /var/www/vendor/michelf/php-markdown/Michelf/Markdown.php on line 233

GET /users/onboarding/files[/:user_onboarding_files_id]

Fields

Field	Type	Description	Required
userId	int	user id	YES
companyId	int	company id	YES
file	binary	file	YES

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

POST /users/onboarding/files[/:user_onboarding_files_id]

Fields

Field	Type	Description	Required
userId	int	user id	YES
companyId	int	company id	YES
file	binary	file	YES

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Content-Type	application/vnd.application-api.v1+json application/json multipart/form-data

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

DELETE /users/onboarding/files[/:user_onboarding_files_id]

Fields

Field	Type	Description	Required
userId	int	user id	YES
companyId	int	company id	YES
file	binary	file	YES

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
204: No Content

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

usersJobapplicationFiles

users jobapplication files operations

GET /users/jobapplication/files

returns all user files

Fields

Field	Type	Description	Required
file	binary	application file	YES
jobapplication_id	integer	job application id	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/users/jobapplication/files"
       },
       "first": {
           "href": "/users/jobapplication/files?page={page}"
       },
       "prev": {
           "href": "/users/jobapplication/files?page={page}"
       },
       "next": {
           "href": "/users/jobapplication/files?page={page}"
       },
       "last": {
           "href": "/users/jobapplication/files?page={page}"
       }
   }
   "_embedded": {
       "users_jobapplication_files": [
           {
               "id": fiel ID,
                "link": "url link to file",
                "file": {
                    "name": "file name without mime",
                    "mime": "file mime",
                    "nameMime": " file name with mime"
                },
                "createdDateTime": {
                    "date": "2024-08-29 11:39:37.000000",
                    "timezone_type": 3,
                    "timezone": "Europe/Berlin"
                },
               "_links": {
                   "self": {
                       "href": "/users/jobapplication/files[/:users_jobapplication_files_id]"
                   }
               }
           }
       ]
   }
}

POST /users/jobapplication/files

uploads user files. If jobapplication_id is given, files will be attached to the specific job application

Fields

Field	Type	Description	Required
file	binary	application file	YES
jobapplication_id	integer	job application id	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Content-Type	application/vnd.application-api.v1+json application/json multipart/form-data
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

{
   "file": "application file",
   "jobapplication_id": "job application id"
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /users/jobapplication/files[/:users_jobapplication_files_id]

returns a specific file

Fields

Field	Type	Description	Required
file	binary	application file	YES
jobapplication_id	integer	job application id	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

DELETE /users/jobapplication/files[/:users_jobapplication_files_id]

deletes a specific file

Fields

Field	Type	Description	Required
file	binary	application file	YES
jobapplication_id	integer	job application id	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
204: No Content
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

usersJobapplication

users job applications operations

GET /users/jobapplication

Fields

Field	Type	Description	Required
firstname	string	users firstname	NO
lastname		users lastname	NO
email	string	users email	NO
telephone	string	users telephone number	NO
street	string	users street	NO
zipcode	string	users zipcode	NO
country	string	users country	NO
nationality	string	users nationality	NO
image	file	users image	NO
joboffers_id	integer	joboffers id	YES
graduation		users graduation	NO
description	text	text for cover letter	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

POST /users/jobapplication

Fields

Field	Type	Description	Required
firstname	string	users firstname	NO
lastname		users lastname	NO
email	string	users email	NO
telephone	string	users telephone number	NO
street	string	users street	NO
zipcode	string	users zipcode	NO
country	string	users country	NO
nationality	string	users nationality	NO
image	file	users image	NO
joboffers_id	integer	joboffers id	YES
graduation		users graduation	NO
description	text	text for cover letter	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Content-Type	application/vnd.application-api.v1+json application/json multipart/form-data
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

{
   "firstname": "users firstname",
   "lastname": "users lastname",
   "email": "users email",
   "telephone": "users telephone number",
   "street": "users street",
   "zipcode": "users zipcode",
   "country": "users country",
   "nationality": "users nationality",
   "image": "users image",
   "joboffers_id": "joboffers id",
   "graduation": "users graduation",
   "description": "text for cover letter"
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /users/jobapplication[/:users_jobapplication_id]

Fields

Field	Type	Description	Required
firstname	string	users firstname	NO
lastname		users lastname	NO
email	string	users email	NO
telephone	string	users telephone number	NO
street	string	users street	NO
zipcode	string	users zipcode	NO
country	string	users country	NO
nationality	string	users nationality	NO
image	file	users image	NO
joboffers_id	integer	joboffers id	YES
graduation		users graduation	NO
description	text	text for cover letter	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

PUT /users/jobapplication[/:users_jobapplication_id]

Fields

Field	Type	Description	Required
firstname	string	users firstname	NO
lastname		users lastname	NO
email	string	users email	NO
telephone	string	users telephone number	NO
street	string	users street	NO
zipcode	string	users zipcode	NO
country	string	users country	NO
nationality	string	users nationality	NO
image	file	users image	NO
joboffers_id	integer	joboffers id	YES
graduation		users graduation	NO
description	text	text for cover letter	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Content-Type	application/vnd.application-api.v1+json application/json multipart/form-data
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

DELETE /users/jobapplication[/:users_jobapplication_id]

Fields

Field	Type	Description	Required
firstname	string	users firstname	NO
lastname		users lastname	NO
email	string	users email	NO
telephone	string	users telephone number	NO
street	string	users street	NO
zipcode	string	users zipcode	NO
country	string	users country	NO
nationality	string	users nationality	NO
image	file	users image	NO
joboffers_id	integer	joboffers id	YES
graduation		users graduation	NO
description	text	text for cover letter	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
204: No Content
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

videoTranslation

Video Translation API Endpoint

GET /video-translation

Get list of video translations

Fields

Field	Type	Description	Required
video_id	integer	ID of the video to translate	YES
target_language	string	Target language code for translation	YES
status	enum	Translation status [pending, completed, failed]	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
    "_links": {
        "self": {
            "href": "/video-translation"
        }
    },
    "_embedded": {
        "video_translation": [
            {
                "id": 1,
                "video_id": 123,
                "target_language": "es",
                "status": "completed",
                "_links": {
                    "self": {
                        "href": "/video-translation/1"
                    }
                }
            }
        ]
    },
    "total_items": 1,
    "page_count": 1,
    "page_size": 25,
    "page": 1
}

POST /video-translation

Create a new video translation request

Fields

Field	Type	Description	Required
video_id	integer	ID of the video to translate	YES
target_language	string	Target language code for translation	YES
status	enum	Translation status [pending, completed, failed]	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Content-Type	application/vnd.application-api.v1+json application/json multipart/form-data

Body

{
    "video_id": 123,
    "target_language": "es"
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
    "id": 1,
    "video_id": 123,
    "target_language": "es",
    "status": "pending",
    "_links": {
        "self": {
            "href": "/video-translation/1"
        }
    }
}

GET /video-translation[/:video_translation_id]

Get video translation details

Fields

Field	Type	Description	Required
video_id	integer	ID of the video to translate	YES
target_language	string	Target language code for translation	YES
status	enum	Translation status [pending, completed, failed]	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
    "id": 1,
    "video_id": 123,
    "target_language": "es",
    "status": "completed",
    "_links": {
        "self": {
            "href": "/video-translation/1"
        }
    }
}

PUT /video-translation[/:video_translation_id]

Update video translation details

Fields

Field	Type	Description	Required
video_id	integer	ID of the video to translate	YES
target_language	string	Target language code for translation	YES
status	enum	Translation status [pending, completed, failed]	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json
Content-Type	application/vnd.application-api.v1+json application/json multipart/form-data

Body

{
    "status": "completed"
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
    "id": 1,
    "video_id": 123,
    "target_language": "es",
    "status": "completed",
    "_links": {
        "self": {
            "href": "/video-translation/1"
        }
    }
}

DELETE /video-translation[/:video_translation_id]

Delete a video translation

Fields

Field	Type	Description	Required
video_id	integer	ID of the video to translate	YES
target_language	string	Target language code for translation	YES
status	enum	Translation status [pending, completed, failed]	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
204: No Content
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

accounting

accounting operations

GET /companies/accounting[/:id]

Fields

Field	Type	Description	Required
id	integer	accounting id	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/json application/*+json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
    "booked": {
        "starter": {
            "name": "Starter Paket",
            "0": {
                "id": 1,
                "title": "Starter Paket",
                "price": "99,-€/Monat",
                "validTo": "2025-09-12"
            }
        },
        "joboffers": {
            "name": "Stellenanzeigen",
            "0": {
                "id": 4,
                "title": "Stellenanzeige",
                "price": "99,-€/Monat",
                "validTo": "2025-09-12"
            },
            "1": {
                "id": 5,
                "title": "Stellenanzeige",
                "price": "99,-€/Monat",
                "validTo": "2025-09-16"
            },
            "2": {
                "id": 6,
                "title": "Stellenanzeige",
                "price": "99,-€/Monat",
                "validTo": "2025-09-16"
            }
        },
        "jobassistant": {
            "name": "KI - Jobassistant",
            "0": {
                "id": 12,
                "title": "KI - Jobassistant",
                "price": "499,-€/Monat",
                "validTo": "2025-09-16"
            },
            "1": {
                "id": 15,
                "title": "KI - Jobassistant",
                "price": "499,-€/Monat",
                "validTo": "2025-09-16"
            }
        }
    }
}

DELETE /companies/accounting[/:id]

Fields

Field	Type	Description	Required
id	integer	accounting id	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/json application/*+json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
204: No Content
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

activateAssistant

activate assistant operations

POST /companies/activate/assistant

Fields

Field	Type	Description	Required
user	integer	user id	YES

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/json application/*+json
Content-Type	application/vnd.application-api.v1+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

activateJoboffer

activate joboffer operations

POST /companies/activate/joboffer

Fields

Field	Type	Description	Required
joboffer	integer	joboffer id	YES

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/json application/*+json
Content-Type	application/vnd.application-api.v1+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

ChatMode

chat mode operations

GET /employee/[:employee_id]/chat/mode

Fields

Field	Type	Description	Required
mode	boolean [ai, manual]	chat mode	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/json application/*+json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

PUT /employee/[:employee_id]/chat/mode

Fields

Field	Type	Description	Required
mode	boolean [ai, manual]	chat mode	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/json application/*+json
Content-Type	application/vnd.application-api.v1+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

companiesPoll

poll operations

POST /companies/poll

Fields

Field	Type	Description	Required
companyId	integer	companyId	YES
companiesWebsite	string	companies website	NO
linkedin	string	linked in profile name	NO
xing	string	xing profile name	NO
stepstone	string	stepstone profile name	NO
monster	string	monster profile name	NO
eures	string	eures profile name	NO
ihk	boolean	ihk account	NO
ahk	boolean	ahk account	NO
zav		boolean	NO
reprognition	boolean	reprognition account	NO
wbsrecruiting	boolean	wbs recruiting account	NO
scoutment	boolean	scoutment account	NO
kofa	boolean	kofa account	NO
bqportal	boolean	bq portal account	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/json application/*+json
Content-Type	application/vnd.application-api.v1+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

contact

contact operations

POST /contact

Fields

Field	Type	Description	Required
company	string	company name	YES
name	string	sender lastname	YES
firstname	string	senders firstname	YES
email	string	senders email	YES
content	string	message content	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/json application/*+json
Content-Type	application/vnd.application-api.v1+json application/json

Body

{
   "company": "company name",
   "name": "sender lastname",
   "firstname": "senders firstname",
   "email": "senders email",
   "content": "message content"
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
404: Not Found
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

EmployeeOptin

employee optin operations

GET /employee/optin

Fields

Field	Type	Description	Required
id	integer	employee id	YES

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

joboffersCategories

joboffers categories operations

GET /joboffers/categories

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
    "profession": {
        "childcare": "Kinderpflege",
        "hotel": "Hotewl & Gastronomie",
        "nursing": "(Kranken-)Pflege",
        "service": "Hausdienstleistung"
    },
    "position": {
        "employee": "Angestellter",
        "trainee": "Auszubildener",
        "freelancer": "Freelancer",
        "minijobber": "Minijobber"
    },
    "imploymenttype": {
        "full": "Vollzeit",
        "part": "Teilzeit"
    },
    "languagelevel": {
        "a1": "A1 - Anfänger",
        "a2": "A2 - Grundlegende Kenntnisse",
        "b1": "B1 - Fortgeschrittene Sprachverwendung",
        "b2": "B2 - Selbstständinge Sprachkenntnisse",
        "c1": "C1 - Fachkundige Sprachkenntnisse",
        "c2": "C2 - Annähernd muttersprachliche Kenntnisse"
    }
}

pricing

pricing operations

GET /pricing

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

States

states operations

GET /states

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
    "baden_wuertenberg": "Baden Würtenberg",
    "bayern": "Bayern",
    "berlin": "Berlin",
    "brandenburg": "Brandenburg",
    "bremen": "Bremen",
    "hamburg": "Hamburg",
    "hessen": "Hessen",
    "mecklenburg_vorpommern": "Mecklenburg-Vorpommern",
    "niedersachsen": "Niedersachsen",
    "nordrhein_westfalen": "Nordrhein-Westfalen",
    "rheinland_pfalz": "Rheinland-Pfalz",
    "saarland": "Saarland",
    "sachsen_anhalt": "Sachsen-Anhalt",
    "sachsen": "Sachsen",
    "schleswig_holzstein": "Schleswig-Holzstein",
    "thueringen": "Thüringen"
}

usersAccountPasswordCode

users account password reset operations

POST /users/account/password/code

Fields

Field	Type	Description	Required
email	string	users eMail address	YES
redirectUrl	string	redirect url on whci hthe user can set a new password and confirm the confirmation code	YES

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/json application/*+json
Content-Type	application/vnd.application-api.v1+json application/json

Body

{
   "email": "users eMail address",
   "redirectUrl": "redirect url on whci hthe user can set a new password and confirm the confirmation code"
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
404: Not Found
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

usersAccountPassword

users password operations

POST /users/account/password

Fields

Field	Type	Description	Required
password	string	users new password	YES
confirmationCode	string	confirmation code to reset old password	YES

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/json application/*+json
Content-Type	application/vnd.application-api.v1+json application/json

Body

{
   "password": "users new password",
   "confirmationCode": "confirmation code to reset old password"
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
404: Not Found
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

usersAccount

users account operations

GET /users/account

Fields

Field	Type	Description	Required
firstname	string	users firstname	NO
lastname	string	users lastname	NO
email	string	users email	NO
password	string	users password	NO
successRedirectUrl	string	redirect url after successfull opt-in	NO
errorRedirectUrl	string	redirect url after failed op-on	NO
notificationMessages	boolean	does the user allow for notification messages?	NO
telephone	string	users telephone number	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/json application/*+json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "firstname": "users firstname",
   "lastname": "users lastname",
   "email": "users email",
   "telephone": "users telephonenumber",
   "password": "users password",
   "successRedirectUrl": "redirect url after successfull opt-in",
   "errorRedirectUrl": "redirect url after failed op-on",
   "notificationMessages": "does the user allow for notification messages?"
}

PUT /users/account

Fields

Field	Type	Description	Required
firstname	string	users firstname	NO
lastname	string	users lastname	NO
email	string	users email	NO
password	string	users password	NO
successRedirectUrl	string	redirect url after successfull opt-in	NO
errorRedirectUrl	string	redirect url after failed op-on	NO
notificationMessages	boolean	does the user allow for notification messages?	NO
telephone	string	users telephone number	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/json application/*+json
Content-Type	application/vnd.application-api.v1+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

DELETE /users/account

Fields

Field	Type	Description	Required
firstname	string	users firstname	NO
lastname	string	users lastname	NO
email	string	users email	NO
password	string	users password	NO
successRedirectUrl	string	redirect url after successfull opt-in	NO
errorRedirectUrl	string	redirect url after failed op-on	NO
notificationMessages	boolean	does the user allow for notification messages?	NO
telephone	string	users telephone number	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/json application/*+json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
204: No Content
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

POST /users/account

Fields

Field	Type	Description	Required
firstname	string	users firstname	NO
lastname	string	users lastname	NO
email	string	users email	NO
password	string	users password	NO
successRedirectUrl	string	redirect url after successfull opt-in	NO
errorRedirectUrl	string	redirect url after failed op-on	NO
notificationMessages	boolean	does the user allow for notification messages?	NO
telephone	string	users telephone number	NO

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/json application/*+json
Content-Type	application/vnd.application-api.v1+json application/json

Body

{
   "firstname": "users firstname",
   "lastname": "users lastname",
   "email": "users email",
   "password": "users password",
   "successRedirectUrl": "redirect url after successfull opt-in",
   "errorRedirectUrl": "redirect url after failed op-on"
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
404: Not Found
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "firstname": "users firstname",
   "lastname": "users lastname",
   "email": "users email",
   "successRedirectUrl": "redirect url after successfull opt-in",
   "errorRedirectUrl": "redirect url after failed op-on"
}

Webhook

Deprecated: preg_replace(): Passing null to parameter #3 ($subject) of type array|string is deprecated in /var/www/vendor/michelf/php-markdown/Michelf/Markdown.php on line 233

POST /webhook

Request

Headers

Header	Value
Accept	application/vnd.application-api.v1+json application/json application/*+json
Content-Type	application/vnd.application-api.v1+json application/json

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.application-api.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Documentation

ApplicationApi (v1)

billing

GET /companies/billing[/:billing_id]

Fields

Request

Headers

Response

Status Codes

Headers

Body

POST /companies/billing[/:billing_id]

Fields

Request

Headers

Body

Response

Status Codes

Headers

Body

Chat

GET /employee/[:employee_id]/chat[/:chat_id]

Fields

Request

Headers

Response

Status Codes

Headers

Body

POST /employee/[:employee_id]/chat[/:chat_id]

Fields

Request

Headers

Body

Response

Status Codes

Headers

Body

companiesJobapplicationEmployment

POST /companies/jobapplication/[:jobapplication_id]/employment[/:companies_jobapplication_employment_id]

Fields

Request

Headers

Body

Response

Status Codes

Headers

Body

GET /companies/jobapplication/[:jobapplication_id]/employment[/:companies_jobapplication_employment_id]

Fields

Request

Headers

Response

Status Codes

Headers

Body

companiesJobapplication

GET /companies/[:joboffers_id]/jobapplication

Fields

Request

Headers

Response

Status Codes

Headers

Body

GET /companies/[:joboffers_id]/jobapplication[/:companies_jobapplication_id]

Fields

Request

Headers

Response

Status Codes

Headers

Body

PATCH /companies/[:joboffers_id]/jobapplication[/:companies_jobapplication_id]

Fields

Request

Headers

Body

Response

Status Codes