Quote Request
Quote requests submitted by partners.
GET/api/quote_requests
Retrieves the collection of QuoteRequest resources.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | integer | no | The collection page number |
Code samples
curl -X GET 'https://sandbox.partner.miete24.com/api/quote_requests' \
-H 'X-Api-Key: YOUR_API_KEY'
const response = await fetch('https://sandbox.partner.miete24.com/api/quote_requests', {
method: 'GET',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
},
});
const data = await response.json();
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | QuoteRequest collection | array<QuoteRequest-quote_request.read> |
POST/api/quote_requests
Creates a QuoteRequest resource.
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| string | yes | Contact email address of the applicant. | |
| name | string|null | no | Contact person full name (optional). |
| phone | string|null | no | Contact phone number (optional). |
| company | string|null | no | Company or organization name (optional). |
| message | string|null | no | Free-text note for the quote request (optional). |
| acknowledgedPrivacy | boolean | no | Confirms the applicant accepts the privacy policy; must be true. |
| firstName | string | yes | Contact person given name. |
| lastName | string | yes | Contact person family name. |
| customerType | string | yes | Customer classification: company, sole proprietor, or private person. |
| street | string | yes | Street name of the contact address. |
| houseNumber | string|null | no | House or building number (optional). |
| postalCode | string | yes | Postal / ZIP code of the address. |
| city | string | yes | City or town of the address. |
| country | string | yes | Country of the address. |
| crefoNo | string|null | no | Optional Crefo credit-rating number for solvency checks. |
| category | mixed | no | Product category the request relates to (optional). |
| calculation | string|null | yes | Rental price calculation the request is based on (required). |
Example request
Example body
{
"customerType": "company",
"calculation": "https://example.com/"
}
Code samples
curl -X POST 'https://sandbox.partner.miete24.com/api/quote_requests' \
-H 'X-Api-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"customerType":"company","calculation":"https://example.com/"}'
const response = await fetch('https://sandbox.partner.miete24.com/api/quote_requests', {
method: 'POST',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({"customerType":"company","calculation":"https://example.com/"}),
});
const data = await response.json();
Responses
| Status | Description | Schema |
|---|---|---|
| 201 | QuoteRequest resource created | QuoteRequest-quote_request.read |
| 400 | Invalid input | — |
| 422 | Unprocessable entity | — |
GET/api/quote_requests/{id}
Retrieves a QuoteRequest resource.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | yes | QuoteRequest identifier |
Code samples
curl -X GET 'https://sandbox.partner.miete24.com/api/quote_requests/{id}' \
-H 'X-Api-Key: YOUR_API_KEY'
const response = await fetch('https://sandbox.partner.miete24.com/api/quote_requests/{id}', {
method: 'GET',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
},
});
const data = await response.json();
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | QuoteRequest resource | QuoteRequest-quote_request.read |
| 404 | Resource not found | — |