Get Users By Tenant App

Retrieves all users associated with the current tenant application. This tool allows you to get information about all users that belong to your tenant app, using the API key for authentication and tenant identification.

This tool is part of the User Tools category.

Parameters

This tool doesn’t require any parameters. It uses the API key in the request to identify the tenant application.

Example Request

{}

Example Response

[
  {
    "id": "user_12345678",
    "email": "[e-mail]",
    "first_name": "John",
    "last_name": "Doe",
    "tenant_app_id": "tenant_app_87654321",
    "external_id": "ext_12345",
    "created_at": "2023-05-20T15:30:00.000Z",
    "updated_at": "2023-06-10T09:45:00.000Z"
  },
  {
    "id": "user_87654321",
    "email": "[e-mail]",
    "first_name": "Jane",
    "last_name": "Smith",
    "tenant_app_id": "tenant_app_87654321",
    "external_id": "ext_67890",
    "created_at": "2023-05-21T10:15:00.000Z",
    "updated_at": "2023-06-11T14:30:00.000Z"
  }
]

Usage Notes

• This method returns all users associated with the tenant application identified by the API key used in the request.
• No parameters are required as the tenant app is identified through the API key.
• The response is an array of user objects, each containing basic user information.
• If no users are associated with the tenant app, an empty array will be returned.
• This tool is useful for listing all users in your application that have accounts in the MCP system.
• To get detailed information about a specific user, use Get User By ID with the user’s ID.
• To get account information for a user, use Get User Accounts with the user’s ID.

Security Considerations

• You can only retrieve users that belong to your tenant application.
• The API key used to make the request must have permission to access user data.
• User data is filtered by tenant app ID for security, ensuring you only see users in your application.

Error Response Codes

Status Code	Description
401	Unauthorized - invalid or missing API key
403	Forbidden - the API key doesn’t have sufficient permissions
404	Tenant app not found
500	Internal server error

Related Tools

• Get User By ID - Get detailed information about a specific user
• Get User Accounts - Get all accounts for a specific user
• Get User Accounts By IDs - Retrieve user accounts by their IDs