Messages
GET endpoint for /brand/messaging/messages in brand category
Overview
- Method: GET
- Path:
/brand/messaging/messages - Tags: brand
Parameters
limit (query)
- Type:
string - Required: No
- Description: limit query parameter
offset (query)
- Type:
string - Required: No
- Description: offset query parameter
search (query)
- Type:
string - Required: No
- Description: search query parameter
Request Body
No request body required.
Responses
200
Successful response
Content Type: application/json
{
"type": "object",
"properties": {
"messages": {
"type": "string"
},
"body": {
"type": "string"
},
"sentByID": {
"type": "string"
},
"sentByType": {
"type": "string"
},
"sendToID": {
"type": "string"
},
"sendToType": {
"type": "string"
},
"orderID": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
},
"required": [
"messages",
"body",
"sentByID",
"sentByType",
"sendToID",
"sendToType",
"orderID",
"created_at",
"updated_at"
]
}400
Bad Request
Content Type: application/json
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"details": {
"type": "array",
"items": {
"type": "object"
}
}
},
"required": [
"error",
"details"
]
}401
Unauthorized
404
Not Found
500
Internal Server Error
Example Usage
curl -X GET \
http://localhost:9000/brand/messaging/messages \
-H "Content-Type: application/json" \
Interactive Testing
You can test this endpoint interactively in the Swagger UI (opens in a new tab).