Common
Get a user contact
Retrieves a single user contact by id.
AuthorizationBearer <token>
JWT token to authenticate the request.
In: header
X-Api-Key<token>
API key, sent as a request header.
In: header
Path Parameters
userContactId*string
GUID of the user contact. A non-GUID value returns a 400 with a different response shape than the standard error envelope.
Format
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/common/user/contact/497f6eca-6276-4993-bfeb-53cbbbba6f08/get"{ "result": { "data": { "userContact": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "Jane Doe", "email": "jane.doe@example.com", "sharedWithAccount": true, "subscriptionUserGuid": "7c9e6679-7425-40de-944b-e07fc1f90ae7" } }, "statusCode": 200, "message": "OK" }, "origin": "string", "dateTime": "string", "operationId": "string"}{}{ "error": { "innerErrors": [ { "code": "VALIDATION_ERROR", "message": "Name is required.", "userMessage": "Name is required." } ], "message": "One or more validation errors occurred.", "statusCode": 400 }, "dateTime": "2026-01-01T12:00:00.0000000+00:00", "operationId": "00-abc123-00", "origin": "self-service-portal"}{ "error": { "innerErrors": [ { "code": "VALIDATION_ERROR", "message": "Name is required.", "userMessage": "Name is required." } ], "message": "One or more validation errors occurred.", "statusCode": 400 }, "dateTime": "2026-01-01T12:00:00.0000000+00:00", "operationId": "00-abc123-00", "origin": "self-service-portal"}{ "error": { "innerErrors": [ { "code": "FUNCTION_EXECUTION_ERROR", "message": "An unexpected error occurred while processing the request.", "userMessage": "Something went wrong. Please contact support." } ], "message": "An unexpected error occurred while processing the request.", "statusCode": 500 }, "dateTime": "2026-01-01T12:00:00.0000000+00:00", "operationId": "common-user-contact-get", "origin": ""}