> For a complete index of all SignalWire documentation pages, fetch https://signalwire.com/docs/llms.txt

# get

> Retrieve a specific fax log entry.

Retrieve a specific fax log entry.

### Schema

```yaml
openapi: 3.1.0
info:
  title: API
  version: 1.0.0
paths:
  /api/fax/logs/{id}:
    get:
      operationId: get_fax_log
      summary: Get fax log
      description: >-
        Find a log by ID.


        #### Permissions


        The API token used to authenticate must have the following scope(s)
        enabled to make a successful request: _Fax_.


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).
      tags:
        - subpackage_faxLogs
      parameters:
        - name: id
          in: path
          description: Unique ID of the log
          required: true
          schema:
            $ref: '#/components/schemas/uuid'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fax.LogResponse'
        '400':
          description: The request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode400'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode404'
        '422':
          description: The request contains invalid parameters. See errors for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fax.FaxLogShowStatusCode422'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
servers:
  - url: https://%7BYour_Space_Name%7D.signalwire.com
    description: SignalWire API
components:
  schemas:
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
      title: uuid
    FaxLogResponseStatus:
      type: string
      enum:
        - queued
        - initiated
        - ringing
        - in-progress
        - busy
        - failed
        - no-answer
        - canceled
        - completed
      description: The status of this fax call.
      title: FaxLogResponseStatus
    FaxLogResponseDirection:
      type: string
      enum:
        - inbound
        - outbound-api
        - outbound-dial
      description: The direction of this fax call.
      title: FaxLogResponseDirection
    FaxLogResponseSource:
      type: string
      enum:
        - laml
      description: Source of this log entry.
      title: FaxLogResponseSource
    FaxLogResponseType:
      type: string
      enum:
        - laml_call
      description: Type of this log entry.
      title: FaxLogResponseType
    FaxLogResponseQuality:
      type: string
      enum:
        - fine
        - standard
        - superfine
      description: The quality that was set when the fax document was sent.
      title: FaxLogResponseQuality
    Fax.ChargeDetail:
      type: object
      properties:
        description:
          type: string
          description: Description for this charge.
        charge:
          type: number
          format: double
          description: Charged amount.
      required:
        - description
        - charge
      title: Fax.ChargeDetail
    Fax.LogResponse:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: A unique identifier for the log
        from:
          type:
            - string
            - 'null'
          description: The origin phone number in E.164 format.
        to:
          type:
            - string
            - 'null'
          description: The destination phone number in E.164 format.
        status:
          $ref: '#/components/schemas/FaxLogResponseStatus'
          description: The status of this fax call.
        direction:
          oneOf:
            - $ref: '#/components/schemas/FaxLogResponseDirection'
            - type: 'null'
          description: The direction of this fax call.
        source:
          $ref: '#/components/schemas/FaxLogResponseSource'
          description: Source of this log entry.
        type:
          $ref: '#/components/schemas/FaxLogResponseType'
          description: Type of this log entry.
        url:
          type: string
          format: uri
          description: URL for the associated fax resource with this log entry.
        remote_station:
          type:
            - string
            - 'null'
          description: Represents a customer hosted Fax server.
        charge:
          type: number
          format: double
          description: The amount charged for this fax request.
        number_of_pages:
          type:
            - integer
            - 'null'
          description: The number of pages the fax document contained.
        quality:
          oneOf:
            - $ref: '#/components/schemas/FaxLogResponseQuality'
            - type: 'null'
          description: The quality that was set when the fax document was sent.
        charge_details:
          type: array
          items:
            $ref: '#/components/schemas/Fax.ChargeDetail'
          description: Details on charges associated with this log.
        created_at:
          type: string
          format: date-time
          description: Date and time when the fax was created.
        error_code:
          type:
            - string
            - 'null'
          description: Error code for this resource (if available).
        error_message:
          type:
            - string
            - 'null'
          description: The description of this error (if available).
      required:
        - id
        - from
        - to
        - status
        - direction
        - source
        - type
        - url
        - remote_station
        - charge
        - number_of_pages
        - quality
        - charge_details
        - created_at
        - error_code
        - error_message
      title: Fax.LogResponse
    TypesStatusCodesStatusCode400Error:
      type: string
      enum:
        - Bad Request
      title: TypesStatusCodesStatusCode400Error
    Types.StatusCodes.StatusCode400:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode400Error'
      required:
        - error
      description: The request is invalid.
      title: Types.StatusCodes.StatusCode400
    TypesStatusCodesStatusCode401Error:
      type: string
      enum:
        - Unauthorized
      title: TypesStatusCodesStatusCode401Error
    Types.StatusCodes.StatusCode401:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode401Error'
      required:
        - error
      description: Access is unauthorized.
      title: Types.StatusCodes.StatusCode401
    TypesStatusCodesStatusCode404Error:
      type: string
      enum:
        - Not Found
      title: TypesStatusCodesStatusCode404Error
    Types.StatusCodes.StatusCode404:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode404Error'
      required:
        - error
      description: The server cannot find the requested resource.
      title: Types.StatusCodes.StatusCode404
    Types.StatusCodes.RestApiErrorItem:
      type: object
      properties:
        type:
          type: string
          description: The category of error.
        code:
          type: string
          description: A specific error code.
        message:
          type: string
          description: A description of what caused the error.
        attribute:
          type:
            - string
            - 'null'
          description: The request parameter that caused the error, if applicable.
        url:
          type: string
          description: A link to documentation about this error.
      required:
        - type
        - code
        - message
        - url
      description: Details about a specific error.
      title: Types.StatusCodes.RestApiErrorItem
    Fax.FaxLogShowStatusCode422:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Types.StatusCodes.RestApiErrorItem'
          description: List of validation errors.
      required:
        - errors
      description: The request contains invalid parameters. See errors for details.
      title: Fax.FaxLogShowStatusCode422
    TypesStatusCodesStatusCode500Error:
      type: string
      enum:
        - Internal Server Error
      title: TypesStatusCodesStatusCode500Error
    Types.StatusCodes.StatusCode500:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode500Error'
      required:
        - error
      description: An internal server error occurred.
      title: Types.StatusCodes.StatusCode500

```

## **Response Example**

### Response (200)

```json
{
  "id": "b7182dc2-00f3-40e4-a5ce-20f164b329df",
  "from": "+12065551212",
  "to": "+12065553434",
  "status": "completed",
  "direction": "inbound",
  "source": "laml",
  "type": "laml_call",
  "url": "https://example.signalwire.com/api/laml/2010-04-01/Accounts/b7182dc2-00f3-40e4-a5ce-20f164b329df/Faxes/c9a1d3e4-56f7-89ab-cdef-0123456789ab",
  "remote_station": null,
  "charge": 0.01,
  "number_of_pages": 2,
  "quality": "fine",
  "charge_details": [],
  "created_at": "2024-05-06T12:20:00Z",
  "error_code": "34004",
  "error_message": "The call dropped prematurely"
}
```

## **Example**

```typescript {9}
import { RestClient } from "@signalwire/sdk";

const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com"
});

const fax = await client.logs.fax.get("fax-log-id");
console.log(fax.from, "->", fax.to);
```