GET v1/clients/{id}/keys

Retrieves all client keys for a client by their id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Client Id for Keys requested.

 globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

The List of client keys, if it exists. Otherwise a 404 error.

Collection of ClientKey
NameDescriptionTypeAdditional information
Key

globally unique identifier

None.
Description

string

None.
LastAccessedUtc

date

None.

Response Codes

  • 200 OK: Requested client keys successfully returned.
  • 401 Unauthorized:
  • 404 NotFound: Requested client does not exist.
  • 500 InternalServerError:

Response Formats

application/json, text/json

Sample: 
[
  {
    "Key": "a1121005-dd2c-4309-8c61-6afd4ce75a66",
    "Description": "sample string 2",
    "LastAccessedUtc": "2025-12-11T11:05:46.6781665-06:00"
  },
  {
    "Key": "a1121005-dd2c-4309-8c61-6afd4ce75a66",
    "Description": "sample string 2",
    "LastAccessedUtc": "2025-12-11T11:05:46.6781665-06:00"
  }
]

text/html

Sample: 
[{"Key":"a1121005-dd2c-4309-8c61-6afd4ce75a66","Description":"sample string 2","LastAccessedUtc":"2025-12-11T11:05:46.6781665-06:00"},{"Key":"a1121005-dd2c-4309-8c61-6afd4ce75a66","Description":"sample string 2","LastAccessedUtc":"2025-12-11T11:05:46.6781665-06:00"}]

application/xml, text/xml

Sample: 
<ArrayOfClientKey xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.Questionnaire.Api.Contracts.v1.Models">
  <ClientKey>
    <Description>sample string 2</Description>
    <Key>a1121005-dd2c-4309-8c61-6afd4ce75a66</Key>
    <LastAccessedUtc>2025-12-11T11:05:46.6781665-06:00</LastAccessedUtc>
  </ClientKey>
  <ClientKey>
    <Description>sample string 2</Description>
    <Key>a1121005-dd2c-4309-8c61-6afd4ce75a66</Key>
    <LastAccessedUtc>2025-12-11T11:05:46.6781665-06:00</LastAccessedUtc>
  </ClientKey>
</ArrayOfClientKey>