Search Accounts with Keywords API

Use this endpoint to perform a full-text search across accounts using a flexible query string. It supports filtering, sorting, and pagination for advanced account discovery and UI listing features.

get

Search accounts

Query parameters

searchstringRequired

page[size]stringOptional

page[number]stringOptional

sortstringOptional

Responses

200

Response to /api/v2.0/account/search

application/json

record_countintegerOptional

The total number of records in the dataset. The record count may return zero if there are no records in the dataset.

page_numberintegerRequired

The number of the page within the complete dataset. This is indexed from 1.

continuationstringOptional

page_countintegerOptional

The largest page number that yield an empty page. The page count may return zero if there are no records in the dataset.

page_sizeintegerRequired

The size of page that was requested (or defaulted). This is the maximum number of records that will be returned in the page.

get/api/v2.0/account/search

GET /api/v2.0/account/search?search=text HTTP/1.1
Accept: */*

200

Response to /api/v2.0/account/search

{
  "record_count": 1,
  "page_number": 1,
  "page": [
    {
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "created_at": "2026-01-01T00:00:00.000Z",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "product_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "product_version": "text",
      "reference": "text",
      "status": "PENDING",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "continuation": "text",
  "page_count": 1,
  "page_size": 1
}