Get message

Gets a resource by ID.

get

Returns the resource with the specified ID. Use the select query parameter to specify which fields to include.

Path parameters

idstringRequired

The resource ID.

Query parameters

selectstringOptional

Optional RQL select statement to filter fields.

Responses

200

OK

application/json

Represents an individual notification message sent to a specific contact.

idstringOptional

revisioninteger · int32Optional

bodystring · nullableOptional

Gets or sets the body content of the message.

discardReasonstring · nullableOptionalDeprecated

Gets or sets the reason the message was discarded, if applicable.

statusstringOptional

Gets or sets the current status of the message.

statusReasonstring · nullableOptional

Gets or sets the reason for the current status.

subjectstringOptional

Gets or sets the subject of the message.

400

Bad Request

application/json

404

Not Found

application/json

get/public/v1/notifications/messages/{id}

HTTPcURLJavaScriptPython

GET /public/v1/notifications/messages/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-07-15T18:44:37.389Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-07-15T18:44:37.389Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "queued": {
      "at": "2026-07-15T18:44:37.389Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "discarded": {
      "at": "2026-07-15T18:44:37.389Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "sent": {
      "at": "2026-07-15T18:44:37.389Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "bounced": {
      "at": "2026-07-15T18:44:37.389Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "complained": {
      "at": "2026-07-15T18:44:37.389Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "failed": {
      "at": "2026-07-15T18:44:37.389Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "revision": 1,
  "account": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2026-07-15T18:44:37.389Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "updated": {
        "at": "2026-07-15T18:44:37.389Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active",
    "externalIds": {
      "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "externalId": "text",
    "externalName": "text",
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "technicalSupportEmail": "text",
    "website": "text",
    "description": "text",
    "groups": [
      {
        "id": "text",
        "name": "text",
        "revision": 1,
        "description": "text",
        "logo": "text",
        "isDefault": true
      }
    ],
    "eligibility": {
      "client": true,
      "partner": true
    },
    "defaultLanguageCode": "text"
  },
  "attachments": [
    {
      "id": "text",
      "href": "text",
      "name": "text",
      "fileName": "text",
      "fileSize": 1,
      "contentType": "text"
    }
  ],
  "batch": {
    "id": "text",
    "revision": 1,
    "account": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-07-15T18:44:37.389Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-07-15T18:44:37.389Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text",
      "revision": 1,
      "type": "Client",
      "status": "Active",
      "externalIds": {
        "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "externalId": "text",
      "externalName": "text",
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "technicalSupportEmail": "text",
      "website": "text",
      "description": "text",
      "groups": [
        {
          "id": "text",
          "name": "text",
          "revision": 1,
          "description": "text",
          "logo": "text",
          "isDefault": true
        }
      ],
      "eligibility": {
        "client": true,
        "partner": true
      },
      "defaultLanguageCode": "text"
    },
    "category": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-07-15T18:44:37.389Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-07-15T18:44:37.389Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "published": {
          "at": "2026-07-15T18:44:37.389Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "unpublished": {
          "at": "2026-07-15T18:44:37.389Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "deleted": {
          "at": "2026-07-15T18:44:37.389Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "revision": 1,
      "description": "text",
      "optOutAllowed": true,
      "status": "text",
      "note": "text",
      "deleteAllowed": true,
      "statistics": {
        "month": 1,
        "today": 1,
        "week": 1
      },
      "lastUsed": "2026-07-15T18:44:37.389Z",
      "enabledByDefault": true
    },
    "template": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-07-15T18:44:37.389Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-07-15T18:44:37.389Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "activated": {
          "at": "2026-07-15T18:44:37.389Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "deleted": {
          "at": "2026-07-15T18:44:37.389Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "disabled": {
          "at": "2026-07-15T18:44:37.389Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "revision": 1,
      "category": {
        "id": "text",
        "name": "text",
        "revision": 1,
        "description": "text",
        "lastUsed": "2026-07-15T18:44:37.389Z"
      },
      "criteria": {
        "accountTypes": [
          "text"
        ],
        "filterCondition": "text",
        "objectType": "text",
        "recipients": {
          "selector": "text"
        }
      },
      "defaultVariant": {
        "id": "text",
        "revision": 1,
        "default": true,
        "languageCode": "text",
        "status": "text"
      },
      "description": "text",
      "lastUsed": "2026-07-15T18:44:37.389Z",
      "owner": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1,
        "type": "Client",
        "status": "Active"
      },
      "statistics": {
        "month": 1,
        "today": 1,
        "week": 1
      },
      "status": "text",
      "variants": [
        {
          "id": "text",
          "revision": 1,
          "default": true,
          "languageCode": "text",
          "status": "text"
        }
      ],
      "externalId": "text"
    },
    "status": "text",
    "type": "text"
  },
  "body": "text",
  "category": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2026-07-15T18:44:37.389Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "updated": {
        "at": "2026-07-15T18:44:37.389Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "published": {
        "at": "2026-07-15T18:44:37.389Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "unpublished": {
        "at": "2026-07-15T18:44:37.389Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "deleted": {
        "at": "2026-07-15T18:44:37.389Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "revision": 1,
    "description": "text",
    "optOutAllowed": true,
    "status": "text",
    "note": "text",
    "deleteAllowed": true,
    "statistics": {
      "month": 1,
      "today": 1,
      "week": 1
    },
    "lastUsed": "2026-07-15T18:44:37.389Z",
    "enabledByDefault": true
  },
  "contact": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2026-07-15T18:44:37.389Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "updated": {
        "at": "2026-07-15T18:44:37.389Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "activated": {
        "at": "2026-07-15T18:44:37.389Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "blocked": {
        "at": "2026-07-15T18:44:37.389Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "deleted": {
        "at": "2026-07-15T18:44:37.389Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "revision": 1,
    "name": "text",
    "blockedReason": "text",
    "email": "text",
    "status": "text",
    "identity": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-07-15T18:44:37.389Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-07-15T18:44:37.389Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text",
      "revision": 1
    },
    "directories": [
      {
        "id": "text",
        "audit": {
          "created": {
            "at": "2026-07-15T18:44:37.389Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "updated": {
            "at": "2026-07-15T18:44:37.389Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "revision": 1,
        "account": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2026-07-15T18:44:37.389Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2026-07-15T18:44:37.389Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "icon": "text",
          "revision": 1,
          "type": "Client",
          "status": "Active",
          "externalIds": {
            "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
          },
          "externalId": "text",
          "externalName": "text",
          "address": {
            "addressLine1": "text",
            "addressLine2": "text",
            "postCode": "text",
            "city": "text",
            "state": "text",
            "country": "text"
          },
          "technicalSupportEmail": "text",
          "website": "text",
          "description": "text",
          "groups": [
            {
              "id": "text",
              "name": "text",
              "revision": 1,
              "description": "text",
              "logo": "text",
              "isDefault": true
            }
          ],
          "eligibility": {
            "client": true,
            "partner": true
          },
          "defaultLanguageCode": "text"
        },
        "origin": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2026-07-15T18:44:37.389Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2026-07-15T18:44:37.389Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "icon": "text",
          "revision": 1,
          "type": "Client",
          "status": "Active",
          "externalIds": {
            "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
          },
          "externalId": "text",
          "externalName": "text",
          "address": {
            "addressLine1": "text",
            "addressLine2": "text",
            "postCode": "text",
            "city": "text",
            "state": "text",
            "country": "text"
          },
          "technicalSupportEmail": "text",
          "website": "text",
          "description": "text",
          "groups": [
            {
              "id": "text",
              "name": "text",
              "revision": 1,
              "description": "text",
              "logo": "text",
              "isDefault": true
            }
          ],
          "eligibility": {
            "client": true,
            "partner": true
          },
          "defaultLanguageCode": "text"
        },
        "type": "text",
        "contacts": [
          "[Circular Reference]"
        ]
      }
    ],
    "chat": true,
    "optOuts": [
      {
        "id": "text",
        "audit": {
          "created": {
            "at": "2026-07-15T18:44:37.389Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "updated": {
            "at": "2026-07-15T18:44:37.389Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "published": {
            "at": "2026-07-15T18:44:37.389Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "unpublished": {
            "at": "2026-07-15T18:44:37.389Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "deleted": {
            "at": "2026-07-15T18:44:37.389Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "revision": 1,
        "description": "text",
        "optOutAllowed": true,
        "status": "text",
        "note": "text",
        "deleteAllowed": true,
        "statistics": {
          "month": 1,
          "today": 1,
          "week": 1
        },
        "lastUsed": "2026-07-15T18:44:37.389Z",
        "enabledByDefault": true
      }
    ],
    "user": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-07-15T18:44:37.389Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-07-15T18:44:37.389Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "invitationAcceptedAt": "2026-07-15T18:44:37.389Z"
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text",
      "revision": 1,
      "email": "text",
      "status": "text",
      "phone": {
        "prefix": "text",
        "number": "text"
      },
      "firstName": "text",
      "lastName": "text",
      "lastLoginAt": "2026-07-15T18:44:37.389Z",
      "settings": {
        "cultureCode": "text",
        "dateFormat": "text",
        "languageCode": "text",
        "numberFormat": {
          "decimalSeparator": "text",
          "groupSeparator": "text"
        },
        "timeFormat": "text",
        "timeZone": "text",
        "optOuts": {
          "objectTypes": [
            "text"
          ]
        }
      },
      "accounts": [
        {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1,
          "type": "Client",
          "status": "Active"
        }
      ],
      "currentAccount": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1,
        "type": "Client",
        "status": "Active"
      }
    }
  },
  "template": {
    "id": "text",
    "name": "text",
    "revision": 1,
    "lastUsed": "2026-07-15T18:44:37.389Z",
    "status": "text"
  },
  "status": "text",
  "statusReason": "text",
  "subject": "text"
}