Query Account Group - MindBridge Documentation

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

POST

/ v1

/account-groups

/query

Query Account Group

cURL

curl --request POST \
  --url https://{tenant}.mindbridge.ai/api/v1/account-groups/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}' 

import requests

url = "https://{tenant}.mindbridge.ai/api/v1/account-groups/query"

payload = {}
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({})
};

fetch('https://{tenant}.mindbridge.ai/api/v1/account-groups/query', 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://{tenant}.mindbridge.ai/api/v1/account-groups/query",
  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([

]),
  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://{tenant}.mindbridge.ai/api/v1/account-groups/query"

payload := strings.NewReader("{}")

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://{tenant}.mindbridge.ai/api/v1/account-groups/query")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenant}.mindbridge.ai/api/v1/account-groups/query")

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 = "{}"

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

Response

200

{
  "pageNumber": 123,
  "totalPages": 123,
  "content": [
    {
      "id": "<string>",
      "accountGroupingId": "<string>",
      "code": "<string>",
      "description": {},
      "lowestLevel": true,
      "hierarchy": [
        "<string>"
      ],
      "parentCode": "<string>",
      "macCode": "<string>",
      "accountTags": [
        "<string>"
      ],
      "publishedDate": "2023-11-07T05:31:56Z",
      "orderIndex": 123,
      "errors": [
        {
          "arguments": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "numberOfElements": 123,
  "totalElements": 123,
  "pageable": {
    "pageNumber": 123,
    "pageSize": 123,
    "offset": 123,
    "sort": {
      "sorted": true,
      "unsorted": true,
      "empty": true
    }
  },
  "pageSize": 123,
  "sort": {
    "sorted": true,
    "unsorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "size": 123,
  "number": 123
}

Authorizations

Authorization

Type: string

Location: header

Required: Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

• page: integer (default:0) - Zero-based page index (0..N) Required range: x >= 0
• size: integer (default:20) - The size of the page to be returned Required range: x >= 1
• sort: string[] - Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Body

{
  "operator": {"type": "enum<string>", "required": true},
  "{key}": {"type": "integernumberbooleanstring"}
}

Response

200 - application/json

{
  "pageNumber": <integer>,
  "totalPages": <integer>,
  "content": [
    {
      "id": <string>,
      "accountGroupingId": <string>,
      "code": <string>,
      "description": <object>,
      "lowestLevel": <boolean>,
      "hierarchy": [<string>],
      "parentCode": <string>,
      "macCode": <string>,
      "accountTags": [<string>],
      "publishedDate": <string>,
      "orderIndex": <integer>,
      "errors": [{"arguments": [<string>]}]
    }
  ],
  "numberOfElements": <integer>,
  "totalElements": <integer>,
  "pageable": {
    "pageNumber": <integer>,
    "pageSize": <integer>,
    "offset": <integer>,
    "sort": {"sorted": <boolean>, "unsorted": <boolean>, "empty": <boolean>}
  },
  "pageSize": <integer>,
  "sort": {"sorted": <boolean>, "unsorted": <boolean>, "empty": <boolean>},
  "first": <boolean>,
  "last": <boolean>,
  "size": <integer>,
  "number": <integer>
}