Skip to main content
GET
/
api
/
v2
/
bloodhound-users-minimal
Error
A valid request URL is required to generate request examples
{
  "data": {
    "users": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "first_name": {
          "string": "<string>",
          "valid": true
        },
        "last_name": {
          "string": "<string>",
          "valid": true
        },
        "email": "<string>"
      }
    ]
  }
}
Applies to BloodHound Enterprise and CE

Authorizations

​
Authorization
string
header
required

Authorization: Bearer $JWT_TOKEN

Headers

​
Prefer
integer
default:0

Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240.

Required range: x >= 0

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.

​
last_name
string

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

​
email_address
string

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

​
id
string<uuid>

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

Response

OK

​
data
object