Skip to main content
GET
/
v1
/
api
/
announcements
List all announcements (paginated)
curl --request GET \
  --url http://localhost:3091/v1/api/announcements \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 123,
      "departureCity": "<string>",
      "departureDate": "2023-12-25",
      "arrivalCity": "<string>",
      "arrivalDate": "2023-12-25",
      "pickupPoint": "<string>",
      "availableWeight": 123,
      "reservedWeight": 123,
      "additionalInfo": "<string>",
      "status": "<string>",
      "bookingDeadline": "2023-12-25",
      "user": {
        "id": 123,
        "pseudo": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "avatarUrl": "<string>",
        "rating": 123,
        "tripCount": 123,
        "isAgency": true
      },
      "deliveryPoint": "<string>",
      "isActive": true,
      "pricePerKg": 123,
      "visibilityStatus": "<string>",
      "visibilityReason": "<string>",
      "lastVisibilityChange": "2023-11-07T05:31:56Z",
      "authorIsMe": true,
      "categories": [
        {
          "code": "<string>",
          "name": "<string>"
        }
      ],
      "agencyId": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "page": 123,
  "limit": 123,
  "total": 123,
  "totalPages": 123
}

Authorizations

Authorization
string
header
required

JWT access token from POST /v1/api/auth/login

Query Parameters

page
integer<int32>
default:0
size
integer<int32>
default:10
sort
string[]

Response

Page of announcements returned successfully

data
object[]
page
integer<int32>
limit
integer<int32>
total
integer<int64>
totalPages
integer<int32>