Skip to main content
GET
/
api
/
v2
/
bloodhound-users-minimal
List Users Minimal
curl --request GET \
  --url https://your-tenant.bloodhoundenterprise.io/api/v2/bloodhound-users-minimal \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "users": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "first_name": {
          "string": "<string>",
          "valid": true
        },
        "last_name": {
          "string": "<string>",
          "valid": true
        },
        "email": "<string>"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://specterops-bp-2510-sharphound-collection.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Applies to BloodHound Enterprise and CE

Authorizations

​
Authorization
string
header
required

Authorization: Bearer $JWT_TOKEN

Headers

​
Prefer
string
default:wait=30

Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. Passing in wait=-1 bypasses all timeout limits when the feature is enabled.

Pattern: ^wait=(-1|[0-9]+)$

Query Parameters

​
sort_by
string

Sortable columns are id, first_name, last_name and email_address. Sort by column. Can be used multiple times; prepend a hyphen for descending order. See parameter description for details about which columns are sortable.

​
first_name
string

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

Pattern: ^((eq|~eq|neq):)?[^:]+$
​
last_name
string

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

Pattern: ^((eq|~eq|neq):)?[^:]+$
​
email_address
string

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

Pattern: ^((eq|~eq|neq):)?[^:]+$
​
id
string

Filter results by column string-formatted uuid value. Valid filter predicates are eq, neq.

Pattern: ^((eq|neq):)?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

Response

OK

​
data
object