---
title: "Integration Info"
method: GET
path: "/integrations/{integration_type}"
---

# Integration Info

`GET /integrations/{integration_type}`

Information about the data provided by each integration.

## Path parameters

- `integration_type` 'wms' | 'freight' | 'cart' | 'carrier' | 'erp', required

## Query parameters

- `integration_name` AllowedOperators
  - `eq` string
  - `neq` string
  - `in` string[] — Comma-separated.
  - `nin` string[] — Comma-separated.
- `actions` string[]

## Headers

- `x-trackstar-api-key` string, required

## Response `200`

Successful response

- IntegrationsResponseSchema
  - `data` IntegrationInfo[], required — Integration Info
    - `integration_name` string, required — The name of the integration.
    - `display_name` string, required — The display name of the integration.
    - `install_method` 'input' | 'oauth', required — How users install the integration within the Trackstar Modal.
    - `description` string, required — A description of the integration.
    - `logo_url` string, required — The URL of the integration's logo.
    - `installation_guide_url` string, nullable, required — The URL of the installation guide.
    - `docs` unknown, required
    - `write_operations` WriteOperation[], required — The write operations supported by the integration.
      - `action` string, required — The action that can be performed.
      - `url` string, required — The URL for the action.
      - `required_base_schema_fields` string[], required — The required fields for the action.
      - `optional_base_schema_fields` string[], required — The optional fields for the action.
      - `integration_specific_fields` IntegrationSpecificFields, required
        - `properties` object, required — The integration specific fields and their definitions.
        - `type` string, required — The type of the integration specific fields.
        - `required_fields` string[] — The required fields for the integration specific fields.
    - `list_operations` ListOperation[], required — The list operations supported by the integration.
      - `action` string, required — The action that can be performed.
      - `url` string, required — The URL for the action.
      - `implemented_fields` object, required — The fields that are implemented for the action.
    - `available_actions` string[], required — The actions supported by the integration.

## Other responses

- `404` — Not found
- `422` — Validation error

---

[API](https://skmtc.dev/trackstarhq/apis/trackstar-api.md) · [All operations](https://skmtc.dev/trackstarhq/apis/trackstar-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/trackstarhq/trackstar-api/revisions/4bc5c6e1a8bf/schema)