Search

Core Search (POST)

Searches for records based on a given query.

POST
/search.core

Authorization

AuthorizationBearer <token>

All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request. How do I find my token?

In: header

Request Body

cursor?string

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

Formattext
limit?integer

The maximum number of items to return in a page. The default is '10'.

Formatint32
mode?list-mode

The iteration mode to use. If "after", then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If "before", then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.

Value in"after" | "before"
namespaces?array<search-namespace>

The namespaces to search in.

querystring

The query string. Search query language: https://docs.devrev.ai/product/search#fields

Formattext
sort_by?search-sort-by-param

Search sort by parameters.

Value in"created_date" | "modified_date" | "relevance"
sort_order?search-sort-order-param

Search sort order parameters.

Value in"asc" | "desc"

Response Body

curl -X POST "https://api.devrev.ai/search.core" \  -H "Content-Type: application/json" \  -d '{    "query": "string"  }'
{
  "cursor": "string",
  "next_cursor": "string",
  "prev_cursor": "string",
  "results": [
    {
      "type": "account",
      "modified_date": "2023-01-01T12:00:00.000Z",
      "snippet": "string",
      "account": {
        "display_id": "string",
        "id": "string",
        "display_name": "string"
      },
      "comments": [
        {
          "comment": {
            "display_id": "string",
            "id": "string",
            "sync_metadata": {
              "external_reference": "string",
              "origin_system": "string"
            }
          },
          "created_by": {
            "type": "dev_user",
            "display_id": "string",
            "id": "string",
            "display_name": "string",
            "display_picture": {
              "display_id": "string",
              "id": "string",
              "file": {
                "type": "string",
                "name": "string",
                "size": 0
              }
            },
            "email": "string",
            "full_name": "string",
            "state": "active"
          },
          "created_date": "2023-01-01T12:00:00.000Z",
          "object": "string",
          "panels": [
            "alerts"
          ],
          "references": [
            {
              "type": "account",
              "display_id": "string",
              "id": "string",
              "display_name": "string"
            }
          ],
          "snippet": "string"
        }
      ]
    }
  ]
}
{
  "detail": "string",
  "message": "string",
  "type": "artifact_already_attached_to_a_parent",
  "existing_parent": "string",
  "is_same": true
}
{
  "detail": "string",
  "message": "string",
  "type": "unauthenticated"
}
{
  "detail": "string",
  "message": "string",
  "type": "forbidden"
}
{
  "detail": "string",
  "message": "string",
  "type": "too_many_requests",
  "retry_after": 0
}
{
  "detail": "string",
  "message": "string",
  "type": "internal_error",
  "reference_id": "string"
}
{
  "detail": "string",
  "message": "string",
  "type": "service_unavailable"
}