Skip to main content
GET
/
api
/
v2
/
search
Search for objects
curl --request GET \
  --url {protocol}://{ApiServer}/api/v2/search \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "objectid": "<string>",
      "type": "<string>",
      "name": "<string>",
      "distinguishedname": "<string>",
      "system_tags": "<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

​
q
string
required

Search parameter for the name or object ID of a node.

​
type
string

Node type. Some AD examples: Base, User, Computer, Group, Container. Some Azure examples: AZBase, AZApp, AZDevice.

​
skip
integer

This query parameter is used for determining the number of objects to skip in pagination.

Required range: x >= 0
​
limit
integer

This query parameter is used for setting an upper limit of objects returned in paginated responses.

Required range: x >= 0

Response

OK

​
data
object[]