List Clients

This request retrieves a list of all clients within a tenant.

External Documentation

To learn more, visit the PlexTrac documentation.

Parameters

Parameter	Description
Filter By	Choose to filter results by the following fields.
Filter Value	The Value to filter the results by.
Limit	The maximal number of returned results.
Offset	Number of the results to initially skip.

Example Output

{
    "status": "success",
    "data": [
        {
            "client_id": 1963,
            "name": "Evidence Test",
            "tags": [
                "test"
            ]
        },
        {
            "client_id": 4155,
            "name": "Test Client",
            "poc": "poc name",
            "tags": [
                "test"
            ]
        }
    ],
    "meta": {
        "pagination": {
            "offset": 0,
            "limit": 25,
            "total": 2
        },
        "sort": [
            {
                "by": "name",
                "order": "ASC"
            }
        ],
        "filters": [
            {
                "by": "name",
                "value": "test"
            },
            {
                "by": "tags",
                "value": [
                    "test"
                ]
            },
            {
                "by": "clients",
                "value": [
                    1963,
                    4155,
                    4699
                ]
            }
        ]
    }
}

Workflow Library Example

List Clients with Plextrac and Send Results Via Email

Preview this Workflow on desktop