| Field | Type | Required | Description | Example |
|---|---|---|---|---|
settlementId |
String | ✔️ | Provide the ID of the related settlement. | stl_5B8cwPMGnU |
from |
Optional<String> | ➖ | Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set. |
cpt_vytxeTZskVKR7C7WgdSP3d |
limit |
JsonNullable<Long> | ➖ | The maximum number of items to return. Defaults to 50 items. | 50 |
embed |
JsonNullable<String> | ➖ | This endpoint allows you to embed additional resources via theembed query string parameter. |
|
idempotencyKey |
Optional<String> | ➖ | A unique key to ensure idempotent requests. This key should be a UUID v4 string. | 123e4567-e89b-12d3-a456-426 |