List users
Get Users
This endpoint retrieves a list of users from the admin panel. It is primarily used by administrators to access user information stored in the system.
Request
-
Method: GET
-
Endpoint: {{url}}/v1/admin/users
Response
The response will contain a JSON object with the following structure:
-
users: An array of user objects, where each user object includes:
-
id: Unique identifier for the user.
-
name: The name of the user.
-
email: The email address of the user.
-
role: The role assigned to the user (e.g., admin, user).
-
status: The current status of the user (e.g., active, inactive).
Example Response
{
"users": [
{
"id": "123",
"name": "John Doe",
"email": "john.doe@example.com",
"role": "admin",
"status": "active"
},
{
"id": "124",
"name": "Jane Smith",
"email": "jane.smith@example.com",
"role": "user",
"status": "inactive"
}
]
}
Notes
-
Ensure that appropriate authentication and authorization headers are included in the request to access this endpoint.
-
The response may vary based on the user's permissions and the number of users in the system.
Request
- Base URL: https://api.speakai.co/v1
- URL: https://api.speakai.co/v1/admin/users
- Auth: API key in header x-speakai-key and API key in header x-access-token
Response
Success
Changes
No recorded changes to this operation across all 2 revisions of this API.