DataIntegrationsListResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DataIntegrationsListResponse",
  "title": "DataIntegrationsListResponse",
  "type": "object",
  "properties": {
    "object": {
      "type": "string",
      "description": "Indicates this is a list response.",
      "const": "list"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "description": "Distinguishes the data provider object.",
            "const": "data_provider"
          },
          "id": {
            "type": "string",
            "description": "The unique identifier of the provider.",
            "example": "data_integration_01EHZNVPK3SFK441A1RGBFSHRT"
          },
          "name": {
            "type": "string",
            "description": "The display name of the provider (e.g., \"GitHub\", \"Slack\").",
            "example": "GitHub"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "description": "A description of the provider explaining how it will be used, if configured.",
            "example": "Connect your GitHub account to access repositories."
          },
          "slug": {
            "type": "string",
            "description": "The slug identifier used in API calls (e.g., `github`, `slack`, `notion`).",
            "example": "github"
          },
          "integration_type": {
            "type": "string",
            "description": "The type of integration (e.g., `github`, `slack`).",
            "example": "github"
          },
          "credentials_type": {
            "type": "string",
            "description": "The type of credentials used by the provider (e.g., `oauth2`).",
            "example": "oauth2"
          },
          "scopes": {
            "description": "The OAuth scopes configured for this provider, or `null` if none are configured.",
            "example": [
              "repo",
              "user:email"
            ],
            "oneOf": [
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              {
                "type": "null"
              }
            ]
          },
          "ownership": {
            "type": "string",
            "enum": [
              "userland_user",
              "organization"
            ],
            "description": "Whether the provider is owned by a user or organization."
          },
          "created_at": {
            "type": "string",
            "description": "The timestamp when the provider was created.",
            "example": "2024-01-15T10:30:00.000Z"
          },
          "updated_at": {
            "type": "string",
            "description": "The timestamp when the provider was last updated.",
            "example": "2024-01-15T10:30:00.000Z"
          },
          "integrationType": {
            "type": "string",
            "deprecated": true,
            "description": "Use integration_type instead."
          },
          "credentialsType": {
            "type": "string",
            "deprecated": true,
            "description": "Use credentials_type instead."
          },
          "createdAt": {
            "type": "string",
            "deprecated": true,
            "description": "Use created_at instead."
          },
          "updatedAt": {
            "type": "string",
            "deprecated": true,
            "description": "Use updated_at instead."
          },
          "connected_account": {
            "description": "The user's [connected account](/reference/pipes/connected-account) for this provider, or `null` if the user has not connected.",
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "object": {
                    "type": "string",
                    "description": "Distinguishes the connected account object.",
                    "const": "connected_account"
                  },
                  "id": {
                    "type": "string",
                    "description": "The unique identifier of the connected account.",
                    "example": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT"
                  },
                  "user_id": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The [User](/reference/authkit/user) identifier associated with this connection.",
                    "example": "user_01EHZNVPK3SFK441A1RGBFSHRT"
                  },
                  "organization_id": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The [Organization](/reference/organization) identifier associated with this connection, or `null` if not scoped to an organization.",
                    "example": null
                  },
                  "scopes": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "description": "The OAuth scopes granted for this connection.",
                    "example": [
                      "repo",
                      "user:email"
                    ]
                  },
                  "state": {
                    "type": "string",
                    "enum": [
                      "connected",
                      "needs_reauthorization",
                      "disconnected"
                    ],
                    "description": "The state of the connected account:\n- `connected`: The connection is active and tokens are valid.\n- `needs_reauthorization`: The user needs to reauthorize the connection, typically because required scopes have changed.\n- `disconnected`: The connection has been disconnected.",
                    "example": "connected"
                  },
                  "created_at": {
                    "type": "string",
                    "description": "The timestamp when the connection was created.",
                    "example": "2024-01-16T14:20:00.000Z"
                  },
                  "updated_at": {
                    "type": "string",
                    "description": "The timestamp when the connection was last updated.",
                    "example": "2024-01-16T14:20:00.000Z"
                  },
                  "userlandUserId": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "deprecated": true,
                    "description": "Use `user_id` instead."
                  },
                  "organizationId": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "deprecated": true,
                    "description": "Use `organization_id` instead."
                  },
                  "createdAt": {
                    "type": "string",
                    "deprecated": true,
                    "description": "Use `created_at` instead."
                  },
                  "updatedAt": {
                    "type": "string",
                    "deprecated": true,
                    "description": "Use `updated_at` instead."
                  }
                },
                "required": [
                  "object",
                  "id",
                  "user_id",
                  "organization_id",
                  "scopes",
                  "state",
                  "created_at",
                  "updated_at",
                  "userlandUserId",
                  "organizationId",
                  "createdAt",
                  "updatedAt"
                ]
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "object",
          "id",
          "name",
          "description",
          "slug",
          "integration_type",
          "credentials_type",
          "scopes",
          "ownership",
          "created_at",
          "updated_at",
          "integrationType",
          "credentialsType",
          "createdAt",
          "updatedAt",
          "connected_account"
        ]
      },
      "description": "A list of [providers](/reference/pipes/provider), each including a [`connected_account`](/reference/pipes/connected-account) field with the user's connection status."
    }
  },
  "required": [
    "object",
    "data"
  ]
}