Skip to main content
GET
/
v1
/
users
/
{user_id}
Retrieve a User
curl --request GET \
  --url https://api.example.com/v1/users/{user_id}/

Overview

This endpoint retrieves user information from the Transcrypts API system.

Request

Endpoint

GET https://prod.transcrypts.com/v1/users/{user_id}/

Authentication

API authentication requires the following headers:
HeaderDescription
X-Access-Client-IdYour Client ID
X-Access-SecretYour Access Key

Path Parameters

ParameterTypeRequiredDescription
user_idstringYesThe unique identifier for the user to retrieve

Response

Success Response (HTTP 200)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "external_user_id": "12345",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  "phone": "+14155554193",
  "ssn": "222233333",
  "created_at": "2022-05-04T11:30:00Z",
  "updated_at": "2022-05-04T12:00:00Z"
}

Error Responses

Status CodeDescription
401Unauthorized - Missing or invalid authentication credentials
403Forbidden - Insufficient permissions
404Not Found - User does not exist