Skip to main content
POST
/
core.v1.InventoryService
/
ListInventoryObjects
cURL
curl -X POST "https://api.joinformal.com/core.v1.InventoryService/ListInventoryObjects" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "example": "value"
  }'
fetch("https://api.joinformal.com/core.v1.InventoryService/ListInventoryObjects", {
method: "POST",
headers: {
"X-API-KEY": "YOUR_API_KEY",
"Content-Type": "application/json"
},
body: JSON.stringify({
example: "value"
})
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error(error));
import requests

url = "https://api.joinformal.com/core.v1.InventoryService/ListInventoryObjects"
headers = {
"X-API-KEY": "YOUR_API_KEY",
"Content-Type": "application/json"
}
data = {
"example": "value"
}

response = requests.post(url, headers=headers, json=data)
print(response.json())
package main

import (
"bytes"
"encoding/json"
"fmt"
"io"
"net/http"
)

func main() {
url := "https://api.joinformal.com/core.v1.InventoryService/ListInventoryObjects"

body := map[string]string{
"example": "value",
}

jsonData, _ := json.Marshal(body)

req, _ := http.NewRequest("POST", url, bytes.NewBuffer(jsonData))
req.Header.Set("X-API-KEY", "YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")

client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()

responseBody, _ := io.ReadAll(resp.Body)
fmt.Println(string(responseBody))
}
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.joinformal.com/core.v1.InventoryService/ListInventoryObjects",
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([
'limit' => 123,
'cursor' => '<string>',
'order' => '<string>',
'path' => '<string>',
'excludedPaths' => [
'<string>'
],
'includedObjects' => [
'<string>'
],
'search' => '<string>',
'searchFields' => [

],
'filter' => [
'field' => [
'key' => '<string>',
'value' => [
'type' => '<string>',
'value' => '<string>'
]
],
'group' => [
'filters' => '<array>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);

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

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
HttpResponse<String> response = Unirest.post("https://api.joinformal.com/core.v1.InventoryService/ListInventoryObjects")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"limit\": 123,\n \"cursor\": \"<string>\",\n \"order\": \"<string>\",\n \"path\": \"<string>\",\n \"excludedPaths\": [\n \"<string>\"\n ],\n \"includedObjects\": [\n \"<string>\"\n ],\n \"search\": \"<string>\",\n \"searchFields\": [],\n \"filter\": {\n \"field\": {\n \"key\": \"<string>\",\n \"value\": {\n \"type\": \"<string>\",\n \"value\": \"<string>\"\n }\n },\n \"group\": {\n \"filters\": \"<array>\"\n }\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.joinformal.com/core.v1.InventoryService/ListInventoryObjects")

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"limit\": 123,\n \"cursor\": \"<string>\",\n \"order\": \"<string>\",\n \"path\": \"<string>\",\n \"excludedPaths\": [\n \"<string>\"\n ],\n \"includedObjects\": [\n \"<string>\"\n ],\n \"search\": \"<string>\",\n \"searchFields\": [],\n \"filter\": {\n \"field\": {\n \"key\": \"<string>\",\n \"value\": {\n \"type\": \"<string>\",\n \"value\": \"<string>\"\n }\n },\n \"group\": {\n \"filters\": \"<array>\"\n }\n }\n}"

response = http.request(request)
puts response.read_body
{
  "inventory": [
    {
      "column": {
        "id": "<string>",
        "resourceId": "<string>",
        "name": "<string>",
        "path": "<string>",
        "dataLabel": "<string>",
        "dataLabelV2": "<string>",
        "dataType": "<string>",
        "dataTypeOid": 123,
        "dataLabelLockedForSidecar": true,
        "tags": [
          "<string>"
        ],
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "resourceName": "<string>",
        "markedForDeletionAt": "2023-11-07T05:31:56Z"
      },
      "datastore": {
        "id": "<string>",
        "name": "<string>",
        "technology": "<string>",
        "dbs": [
          {
            "id": "<string>",
            "resourceId": "<string>",
            "name": "<string>",
            "path": "<string>",
            "schemas": [
              {
                "id": "<string>",
                "resourceId": "<string>",
                "name": "<string>",
                "path": "<string>",
                "tables": [
                  {
                    "id": "<string>",
                    "resourceId": "<string>",
                    "name": "<string>",
                    "path": "<string>",
                    "columns": [
                      {
                        "id": "<string>",
                        "resourceId": "<string>",
                        "name": "<string>",
                        "path": "<string>",
                        "dataLabel": "<string>",
                        "dataLabelV2": "<string>",
                        "dataType": "<string>",
                        "dataTypeOid": 123,
                        "dataLabelLockedForSidecar": true,
                        "tags": [
                          "<string>"
                        ],
                        "createdAt": "2023-11-07T05:31:56Z",
                        "updatedAt": "2023-11-07T05:31:56Z",
                        "resourceName": "<string>",
                        "markedForDeletionAt": "2023-11-07T05:31:56Z"
                      }
                    ],
                    "createdAt": "2023-11-07T05:31:56Z",
                    "updatedAt": "2023-11-07T05:31:56Z",
                    "resourceName": "<string>",
                    "markedForDeletionAt": "2023-11-07T05:31:56Z"
                  }
                ],
                "createdAt": "2023-11-07T05:31:56Z",
                "updatedAt": "2023-11-07T05:31:56Z",
                "resourceName": "<string>",
                "markedForDeletionAt": "2023-11-07T05:31:56Z"
              }
            ],
            "tables": [
              {
                "id": "<string>",
                "resourceId": "<string>",
                "name": "<string>",
                "path": "<string>",
                "columns": [
                  {
                    "id": "<string>",
                    "resourceId": "<string>",
                    "name": "<string>",
                    "path": "<string>",
                    "dataLabel": "<string>",
                    "dataLabelV2": "<string>",
                    "dataType": "<string>",
                    "dataTypeOid": 123,
                    "dataLabelLockedForSidecar": true,
                    "tags": [
                      "<string>"
                    ],
                    "createdAt": "2023-11-07T05:31:56Z",
                    "updatedAt": "2023-11-07T05:31:56Z",
                    "resourceName": "<string>",
                    "markedForDeletionAt": "2023-11-07T05:31:56Z"
                  }
                ],
                "createdAt": "2023-11-07T05:31:56Z",
                "updatedAt": "2023-11-07T05:31:56Z",
                "resourceName": "<string>",
                "markedForDeletionAt": "2023-11-07T05:31:56Z"
              }
            ],
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "resourceName": "<string>",
            "markedForDeletionAt": "2023-11-07T05:31:56Z"
          }
        ],
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "db": {
        "id": "<string>",
        "resourceId": "<string>",
        "name": "<string>",
        "path": "<string>",
        "schemas": [
          {
            "id": "<string>",
            "resourceId": "<string>",
            "name": "<string>",
            "path": "<string>",
            "tables": [
              {
                "id": "<string>",
                "resourceId": "<string>",
                "name": "<string>",
                "path": "<string>",
                "columns": [
                  {
                    "id": "<string>",
                    "resourceId": "<string>",
                    "name": "<string>",
                    "path": "<string>",
                    "dataLabel": "<string>",
                    "dataLabelV2": "<string>",
                    "dataType": "<string>",
                    "dataTypeOid": 123,
                    "dataLabelLockedForSidecar": true,
                    "tags": [
                      "<string>"
                    ],
                    "createdAt": "2023-11-07T05:31:56Z",
                    "updatedAt": "2023-11-07T05:31:56Z",
                    "resourceName": "<string>",
                    "markedForDeletionAt": "2023-11-07T05:31:56Z"
                  }
                ],
                "createdAt": "2023-11-07T05:31:56Z",
                "updatedAt": "2023-11-07T05:31:56Z",
                "resourceName": "<string>",
                "markedForDeletionAt": "2023-11-07T05:31:56Z"
              }
            ],
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "resourceName": "<string>",
            "markedForDeletionAt": "2023-11-07T05:31:56Z"
          }
        ],
        "tables": [
          {
            "id": "<string>",
            "resourceId": "<string>",
            "name": "<string>",
            "path": "<string>",
            "columns": [
              {
                "id": "<string>",
                "resourceId": "<string>",
                "name": "<string>",
                "path": "<string>",
                "dataLabel": "<string>",
                "dataLabelV2": "<string>",
                "dataType": "<string>",
                "dataTypeOid": 123,
                "dataLabelLockedForSidecar": true,
                "tags": [
                  "<string>"
                ],
                "createdAt": "2023-11-07T05:31:56Z",
                "updatedAt": "2023-11-07T05:31:56Z",
                "resourceName": "<string>",
                "markedForDeletionAt": "2023-11-07T05:31:56Z"
              }
            ],
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "resourceName": "<string>",
            "markedForDeletionAt": "2023-11-07T05:31:56Z"
          }
        ],
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "resourceName": "<string>",
        "markedForDeletionAt": "2023-11-07T05:31:56Z"
      },
      "schema": {
        "id": "<string>",
        "resourceId": "<string>",
        "name": "<string>",
        "path": "<string>",
        "tables": [
          {
            "id": "<string>",
            "resourceId": "<string>",
            "name": "<string>",
            "path": "<string>",
            "columns": [
              {
                "id": "<string>",
                "resourceId": "<string>",
                "name": "<string>",
                "path": "<string>",
                "dataLabel": "<string>",
                "dataLabelV2": "<string>",
                "dataType": "<string>",
                "dataTypeOid": 123,
                "dataLabelLockedForSidecar": true,
                "tags": [
                  "<string>"
                ],
                "createdAt": "2023-11-07T05:31:56Z",
                "updatedAt": "2023-11-07T05:31:56Z",
                "resourceName": "<string>",
                "markedForDeletionAt": "2023-11-07T05:31:56Z"
              }
            ],
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "resourceName": "<string>",
            "markedForDeletionAt": "2023-11-07T05:31:56Z"
          }
        ],
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "resourceName": "<string>",
        "markedForDeletionAt": "2023-11-07T05:31:56Z"
      },
      "subColumn": {
        "id": "<string>",
        "resourceId": "<string>",
        "name": "<string>",
        "path": "<string>",
        "dataLabel": "<string>",
        "dataLabelV2": "<string>",
        "dataType": "<string>",
        "dataTypeOid": 123,
        "dataLabelLockedForSidecar": true,
        "tags": [
          "<string>"
        ],
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "resourceName": "<string>",
        "markedForDeletionAt": "2023-11-07T05:31:56Z"
      },
      "table": {
        "id": "<string>",
        "resourceId": "<string>",
        "name": "<string>",
        "path": "<string>",
        "columns": [
          {
            "id": "<string>",
            "resourceId": "<string>",
            "name": "<string>",
            "path": "<string>",
            "dataLabel": "<string>",
            "dataLabelV2": "<string>",
            "dataType": "<string>",
            "dataTypeOid": 123,
            "dataLabelLockedForSidecar": true,
            "tags": [
              "<string>"
            ],
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "resourceName": "<string>",
            "markedForDeletionAt": "2023-11-07T05:31:56Z"
          }
        ],
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "resourceName": "<string>",
        "markedForDeletionAt": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "listMetadata": {
    "after": "<string>",
    "before": "<string>",
    "count": 123,
    "nextCursor": "<string>"
  }
}
{
"code": "invalid_request",
"message": "Invalid request parameters",
"details": {}
}
{
"code": "unauthorized",
"message": "Authentication required"
}
{
"code": "forbidden",
"message": "Insufficient permissions to perform this action"
}
{
"code": "not_found",
"message": "Resource not found"
}
{
"code": "internal_error",
"message": "An internal error occurred"
}

Authorizations

X-API-KEY
string
header
required

API key authentication. Get your API key from the Formal console.

Body

application/json
limit
integer<int32>
Required range: x <= 500
cursor
string
order
string
path
string
excludedPaths
string[]
includedObjects
string[]
searchFields
enum<string>[]
Available options:
id,
name,
resource_name,
data_label,
path
filter
filter · object | null

Response

Success

inventory
InventoryObject · object[]
listMetadata
list_metadata · object