---
updatedAt: 2025-11-11T21:56:10.000Z
agentTools:
  projectIndex: https://docs.conveyor.com/llms.txt
---

# GET Interactions by Connection ID

Gets all interactions (document interactions, q&a interactions) for a given connection

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "portal-api",
    "version": "2.0"
  },
  "servers": [
    {
      "url": "https://api.conveyor.com/api"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-KEY"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/v2/interactions/connections/{connection_id}": {
      "get": {
        "summary": "GET Interactions by Connection ID",
        "description": "Gets all interactions (document interactions, q&a interactions) for a given connection",
        "operationId": "get-interactions-by-connection-id",
        "parameters": [
          {
            "name": "type",
            "in": "query",
            "schema": {
              "type": "string",
              "enum": [
                "Document",
                "Q & A"
              ]
            }
          },
          {
            "name": "created_at_start",
            "in": "query",
            "description": "Interactions created on or after this date (YYYY-MM-DD)",
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "created_at_end",
            "in": "query",
            "description": "Interactions created on or before this date (YYYY-MM-DD)",
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "For pagination, this is the starting page",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 1
            }
          },
          {
            "name": "per_page",
            "in": "query",
            "description": "For pagination, this is the number of results per page",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 100
            }
          },
          {
            "name": "X-API-KEY",
            "in": "header",
            "description": "Your Conveyor API key",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "connection_id",
            "in": "path",
            "description": "UUID for the connection. This can be found from the GET Connections endpoint",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"interactions\": [\n    {\n      \"id\": \"759b07ab-f894-48db-bcbe-fac1e0feb0f1\",\n      \"created_at\": \"2023-09-07T21:31:31.623Z\",\n      \"type\": \"Q & A\",\n      \"email\": \"foo@bar.com\",\n      \"content\": \"Where are your servers based?\",\n      \"connection\": {\n        \"id\": \"b99f386f-8d5f-4263-8d8c-04adef2d135c\",\n        \"created_at\": \"2023-06-22T19:08:04.628Z\",\n        \"updated_at\": \"2023-09-07T17:24:59.429Z\",\n        \"_type\": \"exchange/connection\",\n        \"domain\": \"baz.com\",\n        \"crm_link\": \"https://foo.lightning.force.com/lightning/r/Account/0015f00000X3YqHAAV/view\",\n        \"crm_id\": \"0015f00000X3YqHAAV\",\n        \"authorizations_count\": 1,\n        \"authorizations_with_access_count\": 1,\n        \"authorizations_removed_count\": 0,\n        \"latest_activity_at\": null\n      }\n    },\n    {\n      \"id\": \"7efae8b2-4973-4ca9-b8d2-0dd90e8e1299\",\n      \"created_at\": \"2023-09-07T20:13:32.891Z\",\n      \"type\": \"Document\",\n      \"email\": \"kat@meow.com\",\n      \"content\": \"SOC 2 Type II Report\",\n      \"connection\": {\n        \"id\": \"14f96213-3e53-489e-a645-ae99f3fbab03\",\n        \"created_at\": \"2023-09-07T18:19:05.883Z\",\n        \"updated_at\": \"2023-09-07T20:13:29.988Z\",\n        \"_type\": \"exchange/connection\",\n        \"domain\": \"treats.com\",\n        \"crm_link\": \"https://foo.lightning.force.com/lightning/r/Account/0018I00000iPv7MQAS/view\",\n        \"crm_id\": \"0018I00000iPv7MQAS\",\n        \"authorizations_count\": 2,\n        \"authorizations_with_access_count\": 1,\n        \"authorizations_removed_count\": 1,\n        \"latest_activity_at\": \"2023-09-07T20:13:32.891Z\"\n      }\n    }\n  ],\n  \"page\": 1,\n  \"per_page\": 100,\n  \"total_pages\": 1\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "interactions": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "example": "759b07ab-f894-48db-bcbe-fac1e0feb0f1"
                          },
                          "created_at": {
                            "type": "string",
                            "example": "2023-09-07T21:31:31.623Z"
                          },
                          "type": {
                            "type": "string",
                            "example": "Q & A"
                          },
                          "email": {
                            "type": "string",
                            "example": "foo@bar.com"
                          },
                          "content": {
                            "type": "string",
                            "example": "Where are your servers based?"
                          },
                          "connection": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "example": "b99f386f-8d5f-4263-8d8c-04adef2d135c"
                              },
                              "created_at": {
                                "type": "string",
                                "example": "2023-06-22T19:08:04.628Z"
                              },
                              "updated_at": {
                                "type": "string",
                                "example": "2023-09-07T17:24:59.429Z"
                              },
                              "_type": {
                                "type": "string",
                                "example": "exchange/connection"
                              },
                              "domain": {
                                "type": "string",
                                "example": "baz.com"
                              },
                              "crm_link": {
                                "type": "string",
                                "example": "https://foo.lightning.force.com/lightning/r/Account/0015f00000X3YqHAAV/view"
                              },
                              "crm_id": {
                                "type": "string",
                                "example": "0015f00000X3YqHAAV"
                              },
                              "authorizations_count": {
                                "type": "integer",
                                "example": 1,
                                "default": 0
                              },
                              "authorizations_with_access_count": {
                                "type": "integer",
                                "example": 1,
                                "default": 0
                              },
                              "authorizations_removed_count": {
                                "type": "integer",
                                "example": 0,
                                "default": 0
                              },
                              "latest_activity_at": {}
                            }
                          }
                        }
                      }
                    },
                    "page": {
                      "type": "integer",
                      "example": 1,
                      "default": 0
                    },
                    "per_page": {
                      "type": "integer",
                      "example": 100,
                      "default": 0
                    },
                    "total_pages": {
                      "type": "integer",
                      "example": 1,
                      "default": 0
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "403",
            "content": {
              "application/json": {
                "examples": {
                  "Unauthorized": {
                    "value": ""
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": false,
    "proxy-enabled": false
  },
  "x-readme-fauxas": true
}
```