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"
  }'
{
  "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"
      }
    }
  ],
  "listMetadata": {
    "after": "<string>",
    "before": "<string>",
    "count": 123,
    "nextCursor": "<string>"
  }
}

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,
data_store_name,
data_label,
path
filter
filter · object

Response

Success

inventory
InventoryObject · object[]
listMetadata
list_metadata · object