---
updatedAt: 2025-05-12T20:22:54.000Z
agentTools:
  projectIndex: https://docs.etherfax.net/llms.txt
---

# /inbox (get)

Gets/downloads the [FaxReceive](ref:faxreceive) information for the specified fax {id}. All information including the [FaxImage](ref:faxreceive) content is returned using this method.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "etherfax-rest-api-30",
    "version": "3.0"
  },
  "servers": [
    {
      "url": "https://na.connect.etherfax.net/rest/3.0/api"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/inbox?a=get": {
      "get": {
        "summary": "/inbox (get)",
        "description": "Gets/downloads the [FaxReceive](ref:faxreceive) information for the specified fax {id}. All information including the [FaxImage](ref:faxreceive) content is returned using this method.",
        "operationId": "inbox-get",
        "parameters": [
          {
            "name": "a",
            "in": "query",
            "description": "Action to perform.",
            "schema": {
              "type": "string",
              "default": "get"
            }
          },
          {
            "name": "id",
            "in": "query",
            "description": "Specifies the {id} of the <FaxReceive> object to retrieve.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "download",
            "in": "query",
            "description": "The download option allows the client to specify whether to include the FaxImage content when retrieving the received fax.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"JobId\": \"fc00fc44-9f52-4319-82c3-a4c4ec490f0c\",\n  \"FaxResult\": 0,\n  \"ConnectTime\": 41,\n  \"ConnectSpeed\": 33600,\n  \"PagesReceived\": 1,\n  \"RemoteId\": \"Pearson Medical\",\n  \"CalledNumber\": \"+17325551234\",\n  \"CallingNumber\": \"+1856551034\",\n  \"ReceivedOn\": \"2019-01-18T15:58:34.317\",\n  \"FaxImage\": null,\n  \"DeviceId\": 0,\n  \"TransactionType\": 1,\n  \"DocumentParams\": {\n    \"Type\": \"image/tiff\",\n    \"Length\": 42700,\n    \"Hash\": \"3db145c0f1979ec4b225de753b8c6071\",\n    \"Name\": null\n  }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "JobId": {
                      "type": "string",
                      "example": "fc00fc44-9f52-4319-82c3-a4c4ec490f0c"
                    },
                    "FaxResult": {
                      "type": "integer",
                      "example": 0,
                      "default": 0
                    },
                    "ConnectTime": {
                      "type": "integer",
                      "example": 41,
                      "default": 0
                    },
                    "ConnectSpeed": {
                      "type": "integer",
                      "example": 33600,
                      "default": 0
                    },
                    "PagesReceived": {
                      "type": "integer",
                      "example": 1,
                      "default": 0
                    },
                    "RemoteId": {
                      "type": "string",
                      "example": "Pearson Medical"
                    },
                    "CalledNumber": {
                      "type": "string",
                      "example": "+17325551234"
                    },
                    "CallingNumber": {
                      "type": "string",
                      "example": "+1856551034"
                    },
                    "ReceivedOn": {
                      "type": "string",
                      "example": "2019-01-18T15:58:34.317"
                    },
                    "FaxImage": {},
                    "DeviceId": {
                      "type": "integer",
                      "example": 0,
                      "default": 0
                    },
                    "TransactionType": {
                      "type": "integer",
                      "example": 1,
                      "default": 0
                    },
                    "DocumentParams": {
                      "type": "object",
                      "properties": {
                        "Type": {
                          "type": "string",
                          "example": "image/tiff"
                        },
                        "Length": {
                          "type": "integer",
                          "example": 42700,
                          "default": 0
                        },
                        "Hash": {
                          "type": "string",
                          "example": "3db145c0f1979ec4b225de753b8c6071"
                        },
                        "Name": {}
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "key": "Authorization",
        "value": "Basic"
      }
    ],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```