search entities

curl --request POST \
  --url https://api.example.com/api/v1/invite/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "from": 0,
  "size": 10,
  "where": "field1='value' and field2<>'value2'",
  "sort": [
    {
      "field": "timestamp"
    }
  ],
  "trackTotal": false
}
EOF

import requests

url = "https://api.example.com/api/v1/invite/search"

payload = {
    "from": 0,
    "size": 10,
    "where": "field1='value' and field2<>'value2'",
    "sort": [{ "field": "timestamp" }],
    "trackTotal": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    from: 0,
    size: 10,
    where: 'field1=\'value\' and field2<>\'value2\'',
    sort: [{field: 'timestamp'}],
    trackTotal: false
  })
};

fetch('https://api.example.com/api/v1/invite/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/invite/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'from' => 0,
    'size' => 10,
    'where' => 'field1=\'value\' and field2<>\'value2\'',
    'sort' => [
        [
                'field' => 'timestamp'
        ]
    ],
    'trackTotal' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/invite/search"

	payload := strings.NewReader("{\n  \"from\": 0,\n  \"size\": 10,\n  \"where\": \"field1='value' and field2<>'value2'\",\n  \"sort\": [\n    {\n      \"field\": \"timestamp\"\n    }\n  ],\n  \"trackTotal\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/invite/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"from\": 0,\n  \"size\": 10,\n  \"where\": \"field1='value' and field2<>'value2'\",\n  \"sort\": [\n    {\n      \"field\": \"timestamp\"\n    }\n  ],\n  \"trackTotal\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/invite/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"from\": 0,\n  \"size\": 10,\n  \"where\": \"field1='value' and field2<>'value2'\",\n  \"sort\": [\n    {\n      \"field\": \"timestamp\"\n    }\n  ],\n  \"trackTotal\": false\n}"

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "email": "<string>",
      "roles": [
        "<string>"
      ],
      "id": 1,
      "createdAt": 123,
      "updatedAt": 123,
      "tenantId": 123,
      "organisationId": 123,
      "expiredAt": 123
    }
  ],
  "total": 123
}

POST

api

invite

search entities

curl --request POST \
  --url https://api.example.com/api/v1/invite/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "from": 0,
  "size": 10,
  "where": "field1='value' and field2<>'value2'",
  "sort": [
    {
      "field": "timestamp"
    }
  ],
  "trackTotal": false
}
EOF

import requests

url = "https://api.example.com/api/v1/invite/search"

payload = {
    "from": 0,
    "size": 10,
    "where": "field1='value' and field2<>'value2'",
    "sort": [{ "field": "timestamp" }],
    "trackTotal": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    from: 0,
    size: 10,
    where: 'field1=\'value\' and field2<>\'value2\'',
    sort: [{field: 'timestamp'}],
    trackTotal: false
  })
};

fetch('https://api.example.com/api/v1/invite/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/invite/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'from' => 0,
    'size' => 10,
    'where' => 'field1=\'value\' and field2<>\'value2\'',
    'sort' => [
        [
                'field' => 'timestamp'
        ]
    ],
    'trackTotal' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/invite/search"

	payload := strings.NewReader("{\n  \"from\": 0,\n  \"size\": 10,\n  \"where\": \"field1='value' and field2<>'value2'\",\n  \"sort\": [\n    {\n      \"field\": \"timestamp\"\n    }\n  ],\n  \"trackTotal\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/invite/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"from\": 0,\n  \"size\": 10,\n  \"where\": \"field1='value' and field2<>'value2'\",\n  \"sort\": [\n    {\n      \"field\": \"timestamp\"\n    }\n  ],\n  \"trackTotal\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/invite/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"from\": 0,\n  \"size\": 10,\n  \"where\": \"field1='value' and field2<>'value2'\",\n  \"sort\": [\n    {\n      \"field\": \"timestamp\"\n    }\n  ],\n  \"trackTotal\": false\n}"

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "email": "<string>",
      "roles": [
        "<string>"
      ],
      "id": 1,
      "createdAt": 123,
      "updatedAt": 123,
      "tenantId": 123,
      "organisationId": 123,
      "expiredAt": 123
    }
  ],
  "total": 123
}

Authorizations

Authorization

string

header

required

Authentication

Body

application/json

from

integer<int32>

default:0

Starting document offset

Required range: x >= 0

Example:

0

size

integer<int32>

default:10

The number of hits to return

Required range: 0 <= x <= 10000

Example:

10

where

string

Query string to search for data. Represent SQL 'where'

Example:

"field1='value' and field2<>'value2'"

sort

object[]

Sorting for the search

Minimum array length: 1

Show child attributes

trackTotal

boolean

default:false

Return total results field if true

Response

200 - application/json

data

object[]

Response data

Show child attributes

total

integer<int64>

Total amount of document available for this request

Overview

Action Route

Admin Route

Api Key Route

Contract Audit Route

Contract Route

Tenant Destination Route

Detector Route

License Instance Route

License Instance Meta Route

Invite Route

License Route

License Score Group Route

Network Route

Organisation Route

Plan Route

Project Route

Project Documentation Route

Registration Route

Detector Schema Route

Score Route

Score Group Route

Subscription Route

Syslog Route

Tenant Route

Tokenomics Category Route

Tokenomics Schedule Route

Trigger Route

User Route

Wallet Route

Telegram Route

Auth Route

Swagger Specs Route

search entities

Authorizations

Body

Response