Cyan Web API

Cyan Web API - Version 1

GET api/messages

            Gets messages.
            
             If no query string parameters are specified, this will return all messages for the request tenant (not recommended).
             
             If query string parameters are passed, they will be used to filter the messages in the result.  The result will always
             be an array, even if there is no results or a single result.
             
             Query string parameters can be any of the following, and can be combined to create more complex filters:
             MessageMessageId (GUID): search by MessageId x
             MessageCreatedAfterUtc (ISO8601 datetime string): search for messages that were created at or after the given datetime
             MessageCreatedBeforeUtc (ISO8601 datetime string): search for messages that were created before the given datetime
             MessageUpdatedAfterUtc (ISO8601 datetime string): search for messages that were last updated at or after the given datetime
             MessageUpdatedBeforeUtc (ISO8601 datetime string): search for messages that were last updated before the given datetime
             MessageApplicationId (GUID): search for messages for the given ApplicationId x
             MessageApplicationVersionId (GUID): search for messages for the given ApplicationVersionId x
             MessageDeviceId (GUID): search for messages for the given DeviceId x
             MessageDeviceGroupId (GUID): search for messages for the given DeviceGroupId x
             MessageUserId (GUID): search for messages for the given UserId x
             MessageUserGroupId (GUID): search for messages for the given UserGroupId x
             MessageUserName (string): search for messages for the given username (exact match) x
             MessageAuditTypeLookupKey (string): search for messages which have a latest audit with the given lookup key (partial match) x
             MessageSkip (integer): number of records to skip (for paging) x
             MessageTake (integer): number of records to take (for paging) x
             IncludeFullDocument (bool): true return audits and body with the messages - defaults to false x
             MessageTypeLookupKey (string): search for messages by the given MessageTypeLookupKey

Response Information

Response body formats

application/json, text/json

Sample: 
[
  {
    "messageId": "fca96f66-0302-46ef-85ee-4ada5486a823",
    "tenantId": "b2a76d85-4f00-4803-abdd-23d84aa8485d",
    "messageTypeId": "ec98a716-d709-4adf-a697-2e8b647b5827",
    "messageTypeLookupKey": "sample string 4",
    "userId": "4ff5f77d-473f-4824-b284-e54bb7b7bb71",
    "userGroupId": "fc84a96c-cb04-4f16-bd1b-d6889cf4c826",
    "deviceId": "17b50d07-ea2e-41fe-ad91-5a2eb280211d",
    "deviceGroupId": "1647f147-4137-4a95-a42a-cde09eeb4535",
    "applicationId": "b0aea546-ca2b-4e81-91d9-61b4daf2c164",
    "applicationVersionId": "5b7b4900-d75d-453e-9b23-b30d9ecb0756",
    "senderSessionId": "sample string 5",
    "senderSessionSequence": 1,
    "senderCorrelationId": "sample string 6",
    "senderGroup": "sample string 7",
    "senderNote": "sample string 8",
    "body": "sample string 9",
    "storeEncryptedPassword": true,
    "storeHashedPassword": true,
    "messageAuditId": "7624ebdb-bb47-4bf2-ae3b-cc4d9c4a2030",
    "messageAuditMessageAuditTypeId": "de9cf0be-26f8-493c-854d-2a787e922dee",
    "messageAuditMessageAuditTypeName": "sample string 14",
    "messageAuditMessageAuditTypeLookupKey": "sample string 15",
    "messageAuditText": "sample string 16",
    "messageAuditCreatedDateUtc": "2026-03-14T07:25:04.8689488+00:00",
    "messageAuditUpdatedDateUtc": "2026-03-14T07:25:04.8689488+00:00",
    "cyanId": 18,
    "messageAuditCyanId": 1,
    "resubmitCount": 19,
    "createdDateUtc": "2026-03-14T07:25:04.8689488+00:00",
    "updatedDateUtc": "2026-03-14T07:25:04.8689488+00:00"
  },
  {
    "messageId": "fca96f66-0302-46ef-85ee-4ada5486a823",
    "tenantId": "b2a76d85-4f00-4803-abdd-23d84aa8485d",
    "messageTypeId": "ec98a716-d709-4adf-a697-2e8b647b5827",
    "messageTypeLookupKey": "sample string 4",
    "userId": "4ff5f77d-473f-4824-b284-e54bb7b7bb71",
    "userGroupId": "fc84a96c-cb04-4f16-bd1b-d6889cf4c826",
    "deviceId": "17b50d07-ea2e-41fe-ad91-5a2eb280211d",
    "deviceGroupId": "1647f147-4137-4a95-a42a-cde09eeb4535",
    "applicationId": "b0aea546-ca2b-4e81-91d9-61b4daf2c164",
    "applicationVersionId": "5b7b4900-d75d-453e-9b23-b30d9ecb0756",
    "senderSessionId": "sample string 5",
    "senderSessionSequence": 1,
    "senderCorrelationId": "sample string 6",
    "senderGroup": "sample string 7",
    "senderNote": "sample string 8",
    "body": "sample string 9",
    "storeEncryptedPassword": true,
    "storeHashedPassword": true,
    "messageAuditId": "7624ebdb-bb47-4bf2-ae3b-cc4d9c4a2030",
    "messageAuditMessageAuditTypeId": "de9cf0be-26f8-493c-854d-2a787e922dee",
    "messageAuditMessageAuditTypeName": "sample string 14",
    "messageAuditMessageAuditTypeLookupKey": "sample string 15",
    "messageAuditText": "sample string 16",
    "messageAuditCreatedDateUtc": "2026-03-14T07:25:04.8689488+00:00",
    "messageAuditUpdatedDateUtc": "2026-03-14T07:25:04.8689488+00:00",
    "cyanId": 18,
    "messageAuditCyanId": 1,
    "resubmitCount": 19,
    "createdDateUtc": "2026-03-14T07:25:04.8689488+00:00",
    "updatedDateUtc": "2026-03-14T07:25:04.8689488+00:00"
  },
  {
    "messageId": "fca96f66-0302-46ef-85ee-4ada5486a823",
    "tenantId": "b2a76d85-4f00-4803-abdd-23d84aa8485d",
    "messageTypeId": "ec98a716-d709-4adf-a697-2e8b647b5827",
    "messageTypeLookupKey": "sample string 4",
    "userId": "4ff5f77d-473f-4824-b284-e54bb7b7bb71",
    "userGroupId": "fc84a96c-cb04-4f16-bd1b-d6889cf4c826",
    "deviceId": "17b50d07-ea2e-41fe-ad91-5a2eb280211d",
    "deviceGroupId": "1647f147-4137-4a95-a42a-cde09eeb4535",
    "applicationId": "b0aea546-ca2b-4e81-91d9-61b4daf2c164",
    "applicationVersionId": "5b7b4900-d75d-453e-9b23-b30d9ecb0756",
    "senderSessionId": "sample string 5",
    "senderSessionSequence": 1,
    "senderCorrelationId": "sample string 6",
    "senderGroup": "sample string 7",
    "senderNote": "sample string 8",
    "body": "sample string 9",
    "storeEncryptedPassword": true,
    "storeHashedPassword": true,
    "messageAuditId": "7624ebdb-bb47-4bf2-ae3b-cc4d9c4a2030",
    "messageAuditMessageAuditTypeId": "de9cf0be-26f8-493c-854d-2a787e922dee",
    "messageAuditMessageAuditTypeName": "sample string 14",
    "messageAuditMessageAuditTypeLookupKey": "sample string 15",
    "messageAuditText": "sample string 16",
    "messageAuditCreatedDateUtc": "2026-03-14T07:25:04.8689488+00:00",
    "messageAuditUpdatedDateUtc": "2026-03-14T07:25:04.8689488+00:00",
    "cyanId": 18,
    "messageAuditCyanId": 1,
    "resubmitCount": 19,
    "createdDateUtc": "2026-03-14T07:25:04.8689488+00:00",
    "updatedDateUtc": "2026-03-14T07:25:04.8689488+00:00"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfMessageRepresentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Rest.Version1">
  <MessageRepresentation>
    <CreatedDateUtc>2026-03-14T07:25:04.8689488+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-03-14T07:25:04.8689488+00:00</UpdatedDateUtc>
    <ApplicationId>b0aea546-ca2b-4e81-91d9-61b4daf2c164</ApplicationId>
    <ApplicationVersionId>5b7b4900-d75d-453e-9b23-b30d9ecb0756</ApplicationVersionId>
    <Body>sample string 9</Body>
    <CyanId>18</CyanId>
    <DeviceGroupId>1647f147-4137-4a95-a42a-cde09eeb4535</DeviceGroupId>
    <DeviceId>17b50d07-ea2e-41fe-ad91-5a2eb280211d</DeviceId>
    <MessageAuditCreatedDateUtc>2026-03-14T07:25:04.8689488+00:00</MessageAuditCreatedDateUtc>
    <MessageAuditCyanId>1</MessageAuditCyanId>
    <MessageAuditId>7624ebdb-bb47-4bf2-ae3b-cc4d9c4a2030</MessageAuditId>
    <MessageAuditMessageAuditTypeId>de9cf0be-26f8-493c-854d-2a787e922dee</MessageAuditMessageAuditTypeId>
    <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
    <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
    <MessageAuditText>sample string 16</MessageAuditText>
    <MessageAuditUpdatedDateUtc>2026-03-14T07:25:04.8689488+00:00</MessageAuditUpdatedDateUtc>
    <MessageId>fca96f66-0302-46ef-85ee-4ada5486a823</MessageId>
    <MessageTypeId>ec98a716-d709-4adf-a697-2e8b647b5827</MessageTypeId>
    <MessageTypeLookupKey>sample string 4</MessageTypeLookupKey>
    <ResubmitCount>19</ResubmitCount>
    <SenderCorrelationId>sample string 6</SenderCorrelationId>
    <SenderGroup>sample string 7</SenderGroup>
    <SenderNote>sample string 8</SenderNote>
    <SenderSessionId>sample string 5</SenderSessionId>
    <SenderSessionSequence>1</SenderSessionSequence>
    <StoreEncryptedPassword>true</StoreEncryptedPassword>
    <StoreHashedPassword>true</StoreHashedPassword>
    <TenantId>b2a76d85-4f00-4803-abdd-23d84aa8485d</TenantId>
    <UserGroupId>fc84a96c-cb04-4f16-bd1b-d6889cf4c826</UserGroupId>
    <UserId>4ff5f77d-473f-4824-b284-e54bb7b7bb71</UserId>
  </MessageRepresentation>
  <MessageRepresentation>
    <CreatedDateUtc>2026-03-14T07:25:04.8689488+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-03-14T07:25:04.8689488+00:00</UpdatedDateUtc>
    <ApplicationId>b0aea546-ca2b-4e81-91d9-61b4daf2c164</ApplicationId>
    <ApplicationVersionId>5b7b4900-d75d-453e-9b23-b30d9ecb0756</ApplicationVersionId>
    <Body>sample string 9</Body>
    <CyanId>18</CyanId>
    <DeviceGroupId>1647f147-4137-4a95-a42a-cde09eeb4535</DeviceGroupId>
    <DeviceId>17b50d07-ea2e-41fe-ad91-5a2eb280211d</DeviceId>
    <MessageAuditCreatedDateUtc>2026-03-14T07:25:04.8689488+00:00</MessageAuditCreatedDateUtc>
    <MessageAuditCyanId>1</MessageAuditCyanId>
    <MessageAuditId>7624ebdb-bb47-4bf2-ae3b-cc4d9c4a2030</MessageAuditId>
    <MessageAuditMessageAuditTypeId>de9cf0be-26f8-493c-854d-2a787e922dee</MessageAuditMessageAuditTypeId>
    <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
    <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
    <MessageAuditText>sample string 16</MessageAuditText>
    <MessageAuditUpdatedDateUtc>2026-03-14T07:25:04.8689488+00:00</MessageAuditUpdatedDateUtc>
    <MessageId>fca96f66-0302-46ef-85ee-4ada5486a823</MessageId>
    <MessageTypeId>ec98a716-d709-4adf-a697-2e8b647b5827</MessageTypeId>
    <MessageTypeLookupKey>sample string 4</MessageTypeLookupKey>
    <ResubmitCount>19</ResubmitCount>
    <SenderCorrelationId>sample string 6</SenderCorrelationId>
    <SenderGroup>sample string 7</SenderGroup>
    <SenderNote>sample string 8</SenderNote>
    <SenderSessionId>sample string 5</SenderSessionId>
    <SenderSessionSequence>1</SenderSessionSequence>
    <StoreEncryptedPassword>true</StoreEncryptedPassword>
    <StoreHashedPassword>true</StoreHashedPassword>
    <TenantId>b2a76d85-4f00-4803-abdd-23d84aa8485d</TenantId>
    <UserGroupId>fc84a96c-cb04-4f16-bd1b-d6889cf4c826</UserGroupId>
    <UserId>4ff5f77d-473f-4824-b284-e54bb7b7bb71</UserId>
  </MessageRepresentation>
  <MessageRepresentation>
    <CreatedDateUtc>2026-03-14T07:25:04.8689488+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-03-14T07:25:04.8689488+00:00</UpdatedDateUtc>
    <ApplicationId>b0aea546-ca2b-4e81-91d9-61b4daf2c164</ApplicationId>
    <ApplicationVersionId>5b7b4900-d75d-453e-9b23-b30d9ecb0756</ApplicationVersionId>
    <Body>sample string 9</Body>
    <CyanId>18</CyanId>
    <DeviceGroupId>1647f147-4137-4a95-a42a-cde09eeb4535</DeviceGroupId>
    <DeviceId>17b50d07-ea2e-41fe-ad91-5a2eb280211d</DeviceId>
    <MessageAuditCreatedDateUtc>2026-03-14T07:25:04.8689488+00:00</MessageAuditCreatedDateUtc>
    <MessageAuditCyanId>1</MessageAuditCyanId>
    <MessageAuditId>7624ebdb-bb47-4bf2-ae3b-cc4d9c4a2030</MessageAuditId>
    <MessageAuditMessageAuditTypeId>de9cf0be-26f8-493c-854d-2a787e922dee</MessageAuditMessageAuditTypeId>
    <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
    <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
    <MessageAuditText>sample string 16</MessageAuditText>
    <MessageAuditUpdatedDateUtc>2026-03-14T07:25:04.8689488+00:00</MessageAuditUpdatedDateUtc>
    <MessageId>fca96f66-0302-46ef-85ee-4ada5486a823</MessageId>
    <MessageTypeId>ec98a716-d709-4adf-a697-2e8b647b5827</MessageTypeId>
    <MessageTypeLookupKey>sample string 4</MessageTypeLookupKey>
    <ResubmitCount>19</ResubmitCount>
    <SenderCorrelationId>sample string 6</SenderCorrelationId>
    <SenderGroup>sample string 7</SenderGroup>
    <SenderNote>sample string 8</SenderNote>
    <SenderSessionId>sample string 5</SenderSessionId>
    <SenderSessionSequence>1</SenderSessionSequence>
    <StoreEncryptedPassword>true</StoreEncryptedPassword>
    <StoreHashedPassword>true</StoreHashedPassword>
    <TenantId>b2a76d85-4f00-4803-abdd-23d84aa8485d</TenantId>
    <UserGroupId>fc84a96c-cb04-4f16-bd1b-d6889cf4c826</UserGroupId>
    <UserId>4ff5f77d-473f-4824-b284-e54bb7b7bb71</UserId>
  </MessageRepresentation>
</ArrayOfMessageRepresentation>