Skip to main content
GET
/
v1
/
users
List All Users
curl --request GET \
  --url https://api.example.com/v1/users/

​
Overview

The List all users endpoint retrieves a complete list of users from the Transcrypts API system.

​
Request

​
Endpoint

GET https://prod.transcrypts.com/v1/users/

​
Authentication

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

​
Query Parameters

ParameterTypeDescription
cursorstringPagination cursor value for traversing results
page_sizeintegerNumber of results per page

​
Response

The endpoint returns a paginated list of users in JSON format.

​
Response Format

{
  "next": "Link to next page",
  "previous": "Link to previous page",
  "results": [
    {
      "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