Skip to content
Livstick Developers
v3 Request access

Get a message by mrid

Method GET https://<client-api-host>/api/v3.1/containers/{crid}/messages/{mrid}

Return one message by your own reference. 404 MESSAGE_NOT_FOUND when no message of this container carries the mrid.

Authorization

Required scope messages:read

Use Authorization: Bearer liv_<prefix>_<secret>. The key must belong to a platform served by the V3 pipeline; otherwise every route answers 403 PLATFORM_NOT_V3.

Parameters

Name In Type Required Constraints Description
crid Path string Required Your business reference of the container.
mrid Path string Required pattern ^[A-Za-z0-9:_-]{1,64}$ Your own reference of the message.

Responses

200 application/json Schema V31Message

Message found.

401 application/json Schema V31ErrorEnvelope

Authentication failed or missing bearer token.

json 401 
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing API key"
  }
}

403 application/json Schema V31ErrorEnvelope

Authenticated but not allowed: missing scope (FORBIDDEN), invalid platform constraints (INVALID_PLATFORM_CONSTRAINTS) or a platform not served by API v3.1 (PLATFORM_NOT_V3).

json 403 
{
  "error": {
    "code": "PLATFORM_NOT_V3",
    "message": "Platform is not served by API v3.1"
  }
}

404 application/json Schema V31ErrorEnvelope

Container or message not found (NOT_FOUND, MESSAGE_NOT_FOUND).

json 404 
{
  "error": {
    "code": "MESSAGE_NOT_FOUND",
    "message": "Message not found"
  }
}

429 application/json Schema V31ErrorEnvelope

Rate limit exceeded.

json 429 
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Too many requests"
  }
}

500 application/json Schema V31ErrorEnvelope

Unexpected server error.

json 500 
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal error"
  }
}