GET api/CommunicationKeys

Returns all communication keys. Only 100 communication keys can be returned at a time. The following OData query options are allowed: $filter, $orderby, $select, $skip, $top.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of CommunicationKey

Name	Description	Type	Additional information
Id	The ID of the communication key.	globally unique identifier	Required
Name	The name of the communication key.	string	Max length: 256 Min length: 1
Data	The communication key.	Collection of byte	Required Max length: 32 Min length: 32
Created	The date when the communication key was created (in the ISO 8601 format).	date	Required
Updated	The date when the communication key was updated last time (in the ISO 8601 format).	date	None.

Status Codes

All HTTP status codes must be expected, but the following status codes are the most probable:

OK (200) - All found communication keys are successfully returned.
BadRequest (400) - The OData query is invalid.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "ec29f732-85fb-4b38-85ed-736027411c63",
    "Name": "sample string 2",
    "Data": "QEA=",
    "Created": "2024-10-09T01:31:14.8296229+00:00",
    "Updated": "2024-10-09T01:31:14.8296229+00:00"
  },
  {
    "Id": "ec29f732-85fb-4b38-85ed-736027411c63",
    "Name": "sample string 2",
    "Data": "QEA=",
    "Created": "2024-10-09T01:31:14.8296229+00:00",
    "Updated": "2024-10-09T01:31:14.8296229+00:00"
  }
]