Get all Users in an Organization

GET

/api/v2/organizations/{organization_id}/users

Fetches all users associated with a specific organization, identified by the provided organization_id.
This endpoint is useful for administrators or system managers who need to manage or review the members of a particular organization.

Path Parameters:

organization_id (int): The ID of the organization to retrieve users from.

Returns:

A response containing the list of users in the organization.

Changelog:

2.1: Added pagination support. Added fields items, meta to the response. Deprecated users from the response.

2.0: Initial version

Request

Path Params

Query Params

Header Params

Responses

🟢200OK

application/json

Body

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https:///api/v2/organizations//users?email&items_per_page&name&page&paginated&query&sort_by' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "items": [
            {
                "id": 0,
                "email": "[email protected]",
                "is_staff": true,
                "is_superuser": true,
                "is_active": true,
                "date_joined": "2019-08-24T14:15:22.123Z",
                "first_name": "string",
                "last_name": "string",
                "organization": {
                    "id": 0,
                    "created_by": "string",
                    "modified_by": "string",
                    "created_on": "2019-08-24T14:15:22.123Z",
                    "modified_on": "2019-08-24T14:15:22.123Z",
                    "org_name": "string",
                    "domain": "string",
                    "description": "string",
                    "org_logo_url": "string",
                    "org_icon_url": "string",
                    "is_deleted": true
                }
            }
        ],
        "meta": {
            "count": 0,
            "num_pages": 0,
            "current_page": 0
        },
        "users": [
            {
                "id": 0,
                "email": "[email protected]",
                "is_staff": true,
                "is_superuser": true,
                "is_active": true,
                "date_joined": "2019-08-24T14:15:22.123Z",
                "first_name": "string",
                "last_name": "string",
                "organization": {
                    "id": 0,
                    "created_by": "string",
                    "modified_by": "string",
                    "created_on": "2019-08-24T14:15:22.123Z",
                    "modified_on": "2019-08-24T14:15:22.123Z",
                    "org_name": "string",
                    "domain": "string",
                    "description": "string",
                    "org_logo_url": "string",
                    "org_icon_url": "string",
                    "is_deleted": true
                }
            }
        ]
    }
}

Create a Web Search Tool in an Organization

Create a User in an Organization