# Catalog Inventory API

> Catalog Inventory API on Apizie: 38 endpoints (Perform a GraphQL Query, Return this API document in JSON format, List ServiceCredentialTypes, Show an existing ServiceCredentialType, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `dev-tools:redhat-catalog-inventory`
- Category: Dev Tools
- Status: byok
- Source: https://redhat.com
- Page: https://apizie.tech/api/dev-tools/redhat-catalog-inventory
- OpenAPI: https://apizie.tech/api/dev-tools/redhat-catalog-inventory/openapi.json

Catalog Inventory

## Endpoints

### Perform a GraphQL Query
`POST https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/post-graph-ql` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Return this API document in JSON format
`GET https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/get-documentation` (byok)

### List ServiceCredentialTypes
`GET https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/list-service-credential-types` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | The numbers of items to return per page. |
| offset | integer | no | The number of items to skip before starting to collect the result set. |
| filter | object | no | Filter for querying collections. |
| sort_by | object | no | The list of attribute and order to sort the result set by. |

### Show an existing ServiceCredentialType
`GET https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/show-service-credential-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID of the resource |

### List ServiceCredentials
`GET https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/list-service-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | The numbers of items to return per page. |
| offset | integer | no | The number of items to skip before starting to collect the result set. |
| filter | object | no | Filter for querying collections. |
| sort_by | object | no | The list of attribute and order to sort the result set by. |

### Show an existing ServiceCredential
`GET https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/show-service-credential` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID of the resource |

### List ServiceInstances
`GET https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/list-service-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | The numbers of items to return per page. |
| offset | integer | no | The number of items to skip before starting to collect the result set. |
| filter | object | no | Filter for querying collections. |
| sort_by | object | no | The list of attribute and order to sort the result set by. |

### Show an existing ServiceInstance
`GET https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/show-service-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID of the resource |

### List ServiceInventories
`GET https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/list-service-inventories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | The numbers of items to return per page. |
| offset | integer | no | The number of items to skip before starting to collect the result set. |
| filter | object | no | Filter for querying collections. |
| sort_by | object | no | The list of attribute and order to sort the result set by. |

### Show an existing ServiceInventory
`GET https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/show-service-inventory` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID of the resource |

### Tag a ServiceInventory
`POST https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/tag-service-inventory` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID of the resource |
| body | object | yes | JSON request body |

### List Tags for ServiceInventory
`GET https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/list-service-inventory-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | The numbers of items to return per page. |
| offset | integer | no | The number of items to skip before starting to collect the result set. |
| filter | object | no | Filter for querying collections. |
| sort_by | object | no | The list of attribute and order to sort the result set by. |
| id | string | yes | ID of the resource |

### Untag a ServiceInventory
`POST https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/untag-service-inventory` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID of the resource |
| body | object | yes | JSON request body |

### List ServiceOfferingNodes
`GET https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/list-service-offering-nodes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | The numbers of items to return per page. |
| offset | integer | no | The number of items to skip before starting to collect the result set. |
| filter | object | no | Filter for querying collections. |
| sort_by | object | no | The list of attribute and order to sort the result set by. |

### Show an existing ServiceOfferingNode
`GET https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/show-service-offering-node` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID of the resource |

### List ServiceOfferings
`GET https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/list-service-offerings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | The numbers of items to return per page. |
| offset | integer | no | The number of items to skip before starting to collect the result set. |
| filter | object | no | Filter for querying collections. |
| sort_by | object | no | The list of attribute and order to sort the result set by. |

### Show an existing ServiceOffering
`GET https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/show-service-offering` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID of the resource |

### Invokes computing of ServiceInventories tags for given ServiceOffering
`POST https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/applied-inventories-tags-for-service-offering` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID of the resource |
| body | object | yes | JSON request body |

### Order an existing ServiceOffering
`POST https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/order-service-offering` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID of the resource |
| body | object | yes | JSON request body |

### List ServiceInstances for ServiceOffering
`GET https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/list-service-offering-service-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | The numbers of items to return per page. |
| offset | integer | no | The number of items to skip before starting to collect the result set. |
| filter | object | no | Filter for querying collections. |
| sort_by | object | no | The list of attribute and order to sort the result set by. |
| id | string | yes | ID of the resource |

### List ServiceOfferingNodes for ServiceOffering
`GET https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/list-service-offering-service-offering-nodes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | The numbers of items to return per page. |
| offset | integer | no | The number of items to skip before starting to collect the result set. |
| filter | object | no | Filter for querying collections. |
| sort_by | object | no | The list of attribute and order to sort the result set by. |
| id | string | yes | ID of the resource |

### List ServicePlans for ServiceOffering
`GET https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/list-service-offering-service-plans` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | The numbers of items to return per page. |
| offset | integer | no | The number of items to skip before starting to collect the result set. |
| filter | object | no | Filter for querying collections. |
| sort_by | object | no | The list of attribute and order to sort the result set by. |
| id | string | yes | ID of the resource |

### List ServicePlans
`GET https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/list-service-plans` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | The numbers of items to return per page. |
| offset | integer | no | The number of items to skip before starting to collect the result set. |
| filter | object | no | Filter for querying collections. |
| sort_by | object | no | The list of attribute and order to sort the result set by. |

### Show an existing ServicePlan
`GET https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/show-service-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID of the resource |

### List Sources
`GET https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/list-sources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | The numbers of items to return per page. |
| offset | integer | no | The number of items to skip before starting to collect the result set. |
| filter | object | no | Filter for querying collections. |
| sort_by | object | no | The list of attribute and order to sort the result set by. |

### Show an existing Source
`GET https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/show-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID of the resource |

### Incremental Refresh an existing Source
`POST https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/incremental-refresh-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID of the resource |

### Refresh an existing Source
`POST https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/refresh-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID of the resource |

### List ServiceInstances for Source
`GET https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/list-source-service-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | The numbers of items to return per page. |
| offset | integer | no | The number of items to skip before starting to collect the result set. |
| filter | object | no | Filter for querying collections. |
| sort_by | object | no | The list of attribute and order to sort the result set by. |
| id | string | yes | ID of the resource |

### List ServiceInventories for Source
`GET https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/list-source-service-inventories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | The numbers of items to return per page. |
| offset | integer | no | The number of items to skip before starting to collect the result set. |
| filter | object | no | Filter for querying collections. |
| sort_by | object | no | The list of attribute and order to sort the result set by. |
| id | string | yes | ID of the resource |

### List ServiceOfferingNodes for Source
`GET https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/list-source-service-offering-nodes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | The numbers of items to return per page. |
| offset | integer | no | The number of items to skip before starting to collect the result set. |
| filter | object | no | Filter for querying collections. |
| sort_by | object | no | The list of attribute and order to sort the result set by. |
| id | string | yes | ID of the resource |

### List ServiceOfferings for Source
`GET https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/list-source-service-offerings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | The numbers of items to return per page. |
| offset | integer | no | The number of items to skip before starting to collect the result set. |
| filter | object | no | Filter for querying collections. |
| sort_by | object | no | The list of attribute and order to sort the result set by. |
| id | string | yes | ID of the resource |

### List ServicePlans for Source
`GET https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/list-source-service-plans` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | The numbers of items to return per page. |
| offset | integer | no | The number of items to skip before starting to collect the result set. |
| filter | object | no | Filter for querying collections. |
| sort_by | object | no | The list of attribute and order to sort the result set by. |
| id | string | yes | ID of the resource |

### List Tasks for Source
`GET https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/list-source-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | The numbers of items to return per page. |
| offset | integer | no | The number of items to skip before starting to collect the result set. |
| filter | object | no | Filter for querying collections. |
| sort_by | object | no | The list of attribute and order to sort the result set by. |
| id | string | yes | ID of the resource |

### List Tags
`GET https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/list-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | The numbers of items to return per page. |
| offset | integer | no | The number of items to skip before starting to collect the result set. |
| filter | object | no | Filter for querying collections. |
| sort_by | object | no | The list of attribute and order to sort the result set by. |

### List Tasks
`GET https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/list-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | The numbers of items to return per page. |
| offset | integer | no | The number of items to skip before starting to collect the result set. |
| filter | object | no | Filter for querying collections. |
| sort_by | object | no | The list of attribute and order to sort the result set by. |

### Show an existing Task
`GET https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/show-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | UUID of task |

### Update an existing Task
`POST https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/update-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | UUID of task |
| body | object | yes | JSON request body |

## Example
```
curl "https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/post-graph-ql" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Catalog Inventory API?
Create a free Apizie key, then send POST https://apizie.tech/v1/dev-tools:redhat-catalog-inventory/post-graph-ql with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Catalog Inventory API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Catalog Inventory itself also needs your own key from redhat.com.

### Can AI agents use the Catalog Inventory API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key dev-tools:redhat-catalog-inventory.

### What is the status of the Catalog Inventory API?
Needs your own provider key (bring your own key)