---
updatedAt: 2026-04-21T14:40:57.000Z
agentTools:
  projectIndex: https://developer.zylo.com/llms.txt
---

# Get Integration by ID

Note: Suite integrations (such as Atlassian) may not have an `application_id` since they can be related to multiple applications.

### Required Permissions
`integrations:read`
### Rate Limit
`basic`

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "components": {
    "schemas": {
      "UUID": {
        "type": "string",
        "example": "52907745-7672-470e-a803-a2f8feb52944",
        "description": "Stringified UUIDv4.",
        "pattern": "[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}"
      },
      "DateTime": {
        "type": "string",
        "format": "date-time",
        "description": "Diplays dates as a string in the format \"YYYY-MM-DD HH:MM:SS\"."
      },
      "DateDay": {
        "type": "string",
        "format": "date",
        "description": "Displays dates as a string in the format \"YYYY-MM-DD\"."
      },
      "Integrations": {
        "properties": {
          "application_id": {
            "allOf": [
              {
                "$ref": "#/components/schemas/UUID"
              }
            ],
            "nullable": true,
            "description": "Unique identifier for the application associated with the integration."
          },
          "application_name": {
            "type": "string",
            "nullable": true,
            "description": "The name of the application associated with the integration."
          },
          "error_message": {
            "type": "string",
            "nullable": true,
            "description": "The error message for the integration."
          },
          "external_organization_id": {
            "type": "string",
            "nullable": true,
            "description": "The unique ID of the instance in the third party provider."
          },
          "id": {
            "$ref": "#/components/schemas/UUID",
            "description": "Unique identifier for an integration."
          },
          "last_fetch_date": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DateDay"
              }
            ],
            "nullable": true,
            "description": "The last date integration data was fetched."
          },
          "last_processed_date": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DateDay"
              }
            ],
            "nullable": true,
            "description": "The date in which the integration was last processed."
          },
          "mapped_apps_failed_count": {
            "type": "number",
            "format": "double",
            "nullable": true,
            "description": "Only applicable for SSO integrations. The number of mapped applications that failed to run."
          },
          "mapped_apps_running_count": {
            "type": "number",
            "format": "double",
            "nullable": true,
            "description": "Only applicable for SSO integrations. The number of mapped applications that are currently running."
          },
          "mapped_apps_succeeded_count": {
            "type": "number",
            "format": "double",
            "nullable": true,
            "description": "Only applicable for SSO integrations. The number of mapped applications that have succeeded."
          },
          "mappings": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "nullable": true,
            "description": "The mapping for the integration, only available for Usage Connect."
          },
          "status": {
            "type": "string",
            "enum": [
              "RUNNING",
              "SUCCEEDED",
              "FAILED"
            ],
            "description": "The status of the integration."
          },
          "type": {
            "type": "string",
            "enum": [
              "aha!",
              "airtable",
              "asana",
              "asanav2",
              "atlassian",
              "azuread",
              "calendly",
              "centrify",
              "concur",
              "concurendorsed",
              "concurv2",
              "confluence",
              "coupa",
              "docusign",
              "domo",
              "dropbox",
              "expensify",
              "figjam",
              "figma",
              "github",
              "gsuite",
              "hrroster",
              "idaptive",
              "informatica",
              "intacct",
              "jiracloud",
              "looker",
              "microsoftteams",
              "monday",
              "msdynamics365",
              "netsuite",
              "office365",
              "office365v2",
              "okta",
              "onelogin",
              "outreach",
              "outreachv2",
              "pagerduty",
              "pagerdutyv2",
              "salesforce",
              "servicenow",
              "servicenowv2",
              "slack",
              "smartsheet",
              "usageconnect",
              "veevacrm",
              "veevavault",
              "workdayfinancialap",
              "workdayfinancialexpense",
              "workdayhris",
              "zendesk",
              "zoom"
            ],
            "description": "The type of integration."
          },
          "zylo_created_at": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DateTime"
              }
            ],
            "nullable": true,
            "description": "Date and time the record was created in Zylo."
          },
          "zylo_modified_at": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DateTime"
              }
            ],
            "nullable": true,
            "description": "Date and time the record was last modified in Zylo. Uses the created date by default."
          }
        },
        "required": [
          "application_id",
          "application_name",
          "error_message",
          "external_organization_id",
          "id",
          "last_fetch_date",
          "last_processed_date",
          "mapped_apps_failed_count",
          "mapped_apps_running_count",
          "mapped_apps_succeeded_count",
          "mappings",
          "status",
          "type",
          "zylo_created_at",
          "zylo_modified_at"
        ],
        "type": "object",
        "additionalProperties": true
      }
    },
    "securitySchemes": {
      "apiKey": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "info": {
    "title": "Resources",
    "version": "2.0.0"
  },
  "paths": {
    "/v2/integrations/{integrationId}": {
      "get": {
        "operationId": "IntegrationsController_GetIntegrationById",
        "responses": {
          "200": {
            "description": "Ok",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Integrations"
                }
              }
            }
          }
        },
        "description": "Note: Suite integrations (such as Atlassian) may not have an `application_id` since they can be related to multiple applications.\n\n### Required Permissions\n`integrations:read`\n### Rate Limit\n`basic`",
        "summary": "Get Integration by ID",
        "tags": [
          "Integrations"
        ],
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "integrationId",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/UUID"
            }
          }
        ],
        "x-proxy-enabled": false
      }
    }
  },
  "servers": [
    {
      "url": "https://api.zylo.com/"
    }
  ],
  "tags": [
    {
      "name": "Integrations"
    }
  ]
}
```