Skip to main content

Find a Log by ID

GET 
/logs/:id

Permissions​

The API token must include the following scopes: Fax.

Request​

Path Parameters

    id uuidrequired

    Unique ID of the log

Responses​

OK

Schema

    id uuid

    A unique identifier for the log

    from string

    The origin phone number in E.164 format.

    to string

    The destination phone number in E.164 format.

    status string

    The status of this fax call.

    direction string

    The direction of this fax call.

    source string

    Source of this log entry.

    type string

    Type of this log entry.

    url string

    URL for the resource associated with this log entry (if available)

    remote_station string
    charge number
    number_of_pages integer
    quality string

    charge_details

    object[]

    Details on charges associated with this log.

  • Array [

    • description string

    Description for this charge.

    charge number

    Charged amount.

  • ]

    • created_at date-time
    updated_at date-time
    error_code string

    Error code for this resource (if available).

    error_message string

    The description of this error (if available).

Loading...