> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tktchurch.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Users

> List all users in the system

<Note>
  This endpoint requires authentication.
</Note>

### Response

Returns an array of users.

<ResponseField name="id" type="string">
  User's unique identifier (UUID)
</ResponseField>

<ResponseField name="email" type="string">
  User's email address
</ResponseField>

<ResponseField name="firstName" type="string" required={false}>
  User's first name
</ResponseField>

<ResponseField name="lastName" type="string" required={false}>
  User's last name
</ResponseField>

<ResponseField name="status" type="string">
  User's account status. One of:

  * `active`: User is active and can access the system
  * `inactive`: User is inactive (unverified email or deactivated account)
  * `suspended`: User is temporarily suspended
</ResponseField>

<ResponseField name="provider" type="string">
  Primary authentication provider. One of:

  * `local`: Local authentication using email and password
  * `google`: Google OAuth authentication
  * `facebook`: Facebook OAuth authentication
  * `apple`: Apple Sign In authentication
</ResponseField>

<ResponseField name="providerInfo" type="object" required={false}>
  Provider-specific user information

  <Expandable title="Provider Info">
    <ResponseField name="providerId" type="string" required={false}>
      The provider's unique identifier for the user
    </ResponseField>

    <ResponseField name="displayName" type="string" required={false}>
      The user's display name from the provider
    </ResponseField>

    <ResponseField name="photoUrl" type="string" required={false}>
      URL to the user's profile photo
    </ResponseField>

    <ResponseField name="email" type="string" required={false}>
      The user's email from the provider
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="lastLoginAt" type="string" required={false}>
  Timestamp of last login
</ResponseField>

<ResponseField name="createdAt" type="string">
  Account creation timestamp
</ResponseField>

### Error Responses

<ResponseField name="error" type="object">
  Error details when the request fails

  <Expandable title="Error Object">
    <ResponseField name="status" type="integer">
      HTTP status code
    </ResponseField>

    <ResponseField name="reason" type="string">
      Error message explaining why the request failed
    </ResponseField>
  </Expandable>
</ResponseField>

<Note>
  Common error cases:

  * 401 Unauthorized: Missing or invalid access token
</Note>

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET "https://api.tktchurch.com/v1/auth/users" \
    -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."
  ```

  ```javascript JavaScript theme={null}
  const listUsers = async (accessToken) => {
    const response = await fetch('https://api.tktchurch.com/v1/auth/users', {
      method: 'GET',
      headers: {
        'Authorization': `Bearer ${accessToken}`
      }
    });

    if (!response.ok) {
      const error = await response.json();
      throw new Error(error.error.reason);
    }

    return response.json();
  };

  // Usage
  try {
    const users = await listUsers('eyJhbGciOiJIUzI1NiIs...');
    console.log('Users:', users);
  } catch (error) {
    console.error('Failed to list users:', error.message);
  }
  ```

  ```swift Swift theme={null}
  func listUsers(accessToken: String) async throws -> [User] {
      var urlRequest = URLRequest(url: URL(string: "https://api.tktchurch.com/v1/auth/users")!)
      urlRequest.httpMethod = "GET"
      urlRequest.setValue("Bearer \(accessToken)", forHTTPHeaderField: "Authorization")
      
      let (data, response) = try await URLSession.shared.data(for: urlRequest)
      guard let httpResponse = response as? HTTPURLResponse else {
          throw URLError(.badServerResponse)
      }
      
      if httpResponse.statusCode != 200 {
          let error = try JSONDecoder().decode(ErrorResponse.self, from: data)
          throw error
      }
      
      return try JSONDecoder().decode([User].self, from: data)
  }

  // Usage
  do {
      let users = try await listUsers(accessToken: "eyJhbGciOiJIUzI1NiIs...")
      print("Users:", users)
  } catch {
      print("Failed to list users: \(error.localizedDescription)")
  }
  ```

  ```kotlin Kotlin theme={null}
  class UserService(private val client: OkHttpClient) {
      suspend fun listUsers(accessToken: String): List<User> {
          val request = Request.Builder()
              .url("https://api.tktchurch.com/v1/auth/users")
              .get()
              .header("Authorization", "Bearer $accessToken")
              .build()

          client.newCall(request).execute().use { response ->
              if (!response.isSuccessful) {
                  val error = response.body?.string()?.fromJson<ErrorResponse>()
                  throw Exception(error?.reason ?: "Failed to list users")
              }
              
              return response.body?.string()?.fromJson<List<User>>()
                  ?: throw Exception("Empty response")
          }
      }
  }

  // Usage
  try {
      val users = userService.listUsers("eyJhbGciOiJIUzI1NiIs...")
      println("Users: $users")
  } catch (e: Exception) {
      println("Failed to list users: ${e.message}")
  }
  ```

  ```typescript React Native theme={null}
  import axios from 'axios';

  interface User {
    id: string;
    email: string;
    firstName?: string;
    lastName?: string;
    status: 'active' | 'inactive' | 'suspended';
    provider: 'local' | 'google' | 'facebook' | 'apple';
    providerInfo?: {
      providerId?: string;
      displayName?: string;
      photoUrl?: string;
      email?: string;
    };
    lastLoginAt?: string;
    createdAt: string;
  }

  const listUsers = async (accessToken: string): Promise<User[]> => {
    try {
      const response = await axios.get(
        'https://api.tktchurch.com/v1/auth/users',
        {
          headers: {
            'Authorization': `Bearer ${accessToken}`
          },
        }
      );
      
      return response.data;
    } catch (error) {
      if (axios.isAxiosError(error)) {
        throw new Error(error.response?.data?.error?.reason || 'Failed to list users');
      }
      throw error;
    }
  };

  // Usage
  try {
    const users = await listUsers('eyJhbGciOiJIUzI1NiIs...');
    console.log('Users:', users);
  } catch (error) {
    console.error('Failed to list users:', error.message);
  }
  ```
</RequestExample>

<ResponseExample>
  ```json 200 Success theme={null}
  [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "email": "user@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "status": "active",
      "provider": "google",
      "providerInfo": {
        "providerId": "12345",
        "displayName": "John Doe",
        "photoUrl": "https://example.com/photo.jpg",
        "email": "user@example.com"
      },
      "lastLoginAt": "2024-01-20T08:30:00Z",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ]
  ```

  ```json 401 Unauthorized theme={null}
  {
    "error": {
      "status": 401,
      "reason": "Invalid or expired access token"
    }
  }
  ```
</ResponseExample>