List delivery boxes belonging to a Project

GET/projects/{projectId}/delivery-boxes/

API version

v2

Request method

GET

Operation ID

mail-list-delivery-boxes

---

Request

• projectIdstring

  required

  ID of the Project to list DeliveryBoxes for.

Responses

Response headers

• X-Pagination-Limitnumber

  The limit used to select the resources for the response

• X-Pagination-Skipnumber

  The number of skipped items

• X-Pagination-Pagenumber

  The calculate page of the list response. Refer to parameters to learn more.

• X-Pagination-TotalCountnumber

  The total amount of items available in the remote ressource. Use this value in combination with the limit to calculate the available pages.

Format

application/json

Description

OK

Schema documentation

• Array[
• *object
  • authenticationEnabledboolean

    required
  • descriptionstring

    required
  • idstring (uuid)

    required
  • namestring

    required
  • passwordUpdatedAtstring (date-time)

    required
  • projectIdstring

    required
  • sendingEnabledboolean

    required
  • updatedAtstring (date-time)

    required
]

Example

[
  {
    "authenticationEnabled": true,
    "description": "string",
    "id": "f0f86186-0a5a-45b2-aa33-502777496347",
    "name": "string",
    "passwordUpdatedAt": "2024-11-08T18:07:39.863Z",
    "projectId": "string",
    "sendingEnabled": true,
    "updatedAt": "2024-11-08T18:07:39.863Z"
  }
]

JSON Schema

{
  "items": {
    "properties": {
      "authenticationEnabled": {
        "type": "boolean"
      },
      "description": {
        "type": "string"
      },
      "id": {
        "format": "uuid",
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "passwordUpdatedAt": {
        "format": "date-time",
        "type": "string"
      },
      "projectId": {
        "type": "string"
      },
      "sendingEnabled": {
        "type": "boolean"
      },
      "updatedAt": {
        "format": "date-time",
        "type": "string"
      }
    },
    "required": [
      "id",
      "name",
      "projectId",
      "description",
      "authenticationEnabled",
      "sendingEnabled",
      "passwordUpdatedAt",
      "updatedAt"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/projects/string/delivery-boxes?search=string&limit=50&page=1

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.mail.listDeliveryBoxes({
  "projectId": "string",
  "queryParameters": {
    "search": "string",
    "limit": 50,
    "page": 1
  }
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Mail\ListDeliveryBoxes\ListDeliveryBoxesRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new ListDeliveryBoxesRequest(
  projectId: "string"
))
  ->withSearch("string")
  ->withLimit(50)
  ->withPage(1);
$response = $client->mail()->listDeliveryBoxes($request);

var_dump($response->getBody();