GET /api/v3/apiKey/{apiKeyId}

Retrieves a single API key by its unique identifier

GetApiKeyV3 Permissions: ApplicationSettings (View)
Use this endpoint to get metadata for a specific API key. The actual key value is not returned. Requires Application Settings View permission.

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type.

Path Parameters

Name Description Type Required
apiKeyId Unique numeric identifier of the API key integer (int32) Required

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

ApiKeyResponse
Property Description Type
apiKeyDescription A description of the API key string
apiKeyId The identifier of the API key integer (int32)
apiKeyName The name of the API key string
createdBy UserChild
UserChild properties
Property Description Type
fullName The user’s full name string
userCode The user code string
userId The user identifier integer (int32)
createdDate The API key creation date string (date-time)
Example Response application/json 
{  "apiKeyDescription": "string",  "apiKeyId": 1,  "apiKeyName": "string",  "createdBy": {    "fullName": "string",    "userCode": "string",    "userId": 1
  },  "createdDate": "2026-06-29"
}
404 Not Found The requested resource was not found. Verify the ID or path is correct.