# List Logs

GET https://%7BYour_Space_Name%7D.signalwire.com/api/voice/logs

List the available logs.

#### Permissions

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

[Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Reference: https://signalwire.com/docs/apis/voice/logs/list-voice-logs

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: voice
  version: 1.0.0
paths:
  /logs:
    get:
      operationId: list-voice-logs
      summary: List Logs
      description: >-
        List the available logs.


        #### Permissions


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


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).
      tags:
        - subpackage_logs
      parameters:
        - name: include_deleted
          in: query
          description: Include logs for deleted activity.
          required: false
          schema:
            type: boolean
            default: false
        - name: created_before
          in: query
          description: Return logs for activity prior to this date.
          required: false
          schema:
            type: string
        - name: created_on
          in: query
          description: Return logs for activity on this date.
          required: false
          schema:
            type: string
        - name: created_after
          in: query
          description: Return logs for activity after this date.
          required: false
          schema:
            type: string
        - name: page_number
          in: query
          description: >-
            Page number to return. Requires `page_token` for values greater than
            0.
          required: false
          schema:
            type: integer
            default: 0
        - name: page_size
          in: query
          description: >-
            Specify the number of results to return on a single page. The
            default page size is `50` and the maximum is `1000`.
          required: false
          schema:
            type: integer
            default: 50
        - name: page_token
          in: query
          description: >-
            Token for cursor-based pagination. Required when `page_number` is
            greater than 0.
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            SignalWire Basic Authentication using Project ID and API Token.


            The client sends HTTP requests with the Authorization header
            containing

            the word Basic followed by a space and a base64-encoded string of
            project_id:token.

            The project ID will be used as the username and the API token as the
            password.


            Example:

            ```

            Authorization: Basic base64(project_id:token)

            ```
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LogListResponse'
        '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'
        '422':
          description: The request contains invalid parameters. See errors for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceLogsListStatusCode422'
        '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/api/voice
components:
  schemas:
    LogPaginationResponse:
      type: object
      properties:
        self:
          type: string
          description: URL of the current page.
        first:
          type: string
          description: URL of the first page.
        next:
          type: string
          description: URL of the next page. Absent on the last page.
        prev:
          type: string
          description: URL of the previous page. Absent on the first page.
      required:
        - self
        - first
      description: Pagination links for voice log list responses
      title: LogPaginationResponse
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
      title: uuid
    VoiceSources:
      type: string
      enum:
        - dialogflow
        - laml
        - realtime_api
      title: VoiceSources
    ChargeDetail:
      type: object
      properties:
        description:
          type: string
          description: Description for this charge.
        charge:
          type: number
          format: double
          description: Charged amount.
      required:
        - description
        - charge
      description: Details on charges associated with this log.
      title: ChargeDetail
    RelayVoiceType:
      type: string
      enum:
        - laml_call
        - relay_pstn_call
        - relay_sip_call
        - relay_webrtc_call
      title: RelayVoiceType
    VoiceDirection:
      type: string
      enum:
        - inbound
        - outbound
        - outbound-api
        - outbound-dial
      title: VoiceDirection
    VoiceLogStatus:
      type: string
      enum:
        - queued
        - initiated
        - ringing
        - in-progress
        - busy
        - failed
        - no-answer
        - canceled
        - completed
        - ended
        - answered
        - created
        - ending
        - joined
      title: VoiceLogStatus
    RelayVoiceLog:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: A unique identifier for the log.
        from:
          type: string
          description: The origin phone number.
        to:
          type: string
          description: The destination phone number.
        source:
          $ref: '#/components/schemas/VoiceSources'
          description: Source of this log entry.
        charge:
          type: number
          format: double
          description: The charge in dollars.
        charge_details:
          type: array
          items:
            $ref: '#/components/schemas/ChargeDetail'
          description: Details on charges associated with this log.
        created_at:
          type: string
          format: date-time
          description: Date and time when the call entry was created.
        type:
          $ref: '#/components/schemas/RelayVoiceType'
          description: Type of this log entry.
        url:
          type:
            - string
            - 'null'
          format: uri
          description: >-
            URL for the resource associated with this log entry. Present for
            LAML calls, null for Relay calls.
        direction:
          $ref: '#/components/schemas/VoiceDirection'
          description: The direction of the voice activity.
        status:
          $ref: '#/components/schemas/VoiceLogStatus'
          description: The status of the voice activity.
        duration:
          type:
            - integer
            - 'null'
          description: The duration of the voice activity in seconds.
        duration_ms:
          type:
            - integer
            - 'null'
          description: The duration of the voice activity in milliseconds.
        billing_ms:
          type:
            - integer
            - 'null'
          description: The billable duration of the voice activity in milliseconds.
        parent_id:
          type:
            - string
            - 'null'
          description: Parent log identifier for related call entries.
      required:
        - id
        - from
        - to
        - source
        - charge
        - charge_details
        - created_at
        - type
        - url
        - direction
        - status
        - duration
        - duration_ms
        - billing_ms
        - parent_id
      description: >-
        Voice log for Compatibility and Relay call types. Returned when `type`
        is `laml_call`, `relay_pstn_call`, `relay_sip_call`, or
        `relay_webrtc_call`.
      title: RelayVoiceLog
    VideoRoomVoiceType:
      type: string
      enum:
        - video_room_pstn_leg
        - video_room_sip_leg
      title: VideoRoomVoiceType
    VideoRoomVoiceLog:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: A unique identifier for the log.
        from:
          type: string
          description: The origin phone number.
        to:
          type: string
          description: The destination phone number.
        source:
          $ref: '#/components/schemas/VoiceSources'
          description: Source of this log entry.
        charge:
          type: number
          format: double
          description: The charge in dollars.
        charge_details:
          type: array
          items:
            $ref: '#/components/schemas/ChargeDetail'
          description: Details on charges associated with this log.
        created_at:
          type: string
          format: date-time
          description: Date and time when the call entry was created.
        type:
          $ref: '#/components/schemas/VideoRoomVoiceType'
          description: Type of this log entry.
        url:
          description: Always null for this call type.
        direction:
          $ref: '#/components/schemas/VoiceDirection'
          description: The direction of the voice activity.
        status:
          $ref: '#/components/schemas/VoiceLogStatus'
          description: The status of the voice activity.
        duration:
          type:
            - integer
            - 'null'
          description: The duration of the voice activity in seconds.
        duration_ms:
          type:
            - integer
            - 'null'
          description: The duration of the voice activity in milliseconds.
      required:
        - id
        - from
        - to
        - source
        - charge
        - charge_details
        - created_at
        - type
        - url
        - direction
        - status
        - duration
        - duration_ms
      description: >-
        Voice log for audio legs in a Video Room. Returned when `type` is
        `video_room_pstn_leg` or `video_room_sip_leg`.
      title: VideoRoomVoiceLog
    DialogflowVoiceLogType:
      type: string
      enum:
        - dialogflow_call
      description: Type of this log entry.
      title: DialogflowVoiceLogType
    DialogflowVoiceLog:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: A unique identifier for the log.
        from:
          type: string
          description: The origin phone number.
        to:
          type: string
          description: The destination phone number.
        source:
          $ref: '#/components/schemas/VoiceSources'
          description: Source of this log entry.
        charge:
          type: number
          format: double
          description: The charge in dollars.
        charge_details:
          type: array
          items:
            $ref: '#/components/schemas/ChargeDetail'
          description: Details on charges associated with this log.
        created_at:
          type: string
          format: date-time
          description: Date and time when the call entry was created.
        type:
          $ref: '#/components/schemas/DialogflowVoiceLogType'
          description: Type of this log entry.
        url:
          description: Always null for this call type.
        status:
          $ref: '#/components/schemas/VoiceLogStatus'
          description: The status of the voice activity.
        duration:
          type:
            - integer
            - 'null'
          description: The duration of the voice activity in seconds.
      required:
        - id
        - from
        - to
        - source
        - charge
        - charge_details
        - created_at
        - type
        - url
        - status
        - duration
      description: >-
        Voice log for Dialogflow call types. Returned when `type` is
        `dialogflow_call`.
      title: DialogflowVoiceLog
    FabricVoiceLogType:
      type: string
      enum:
        - fabric_subscriber_device_leg
      description: Type of this log entry.
      title: FabricVoiceLogType
    FabricVoiceLog:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: A unique identifier for the log.
        from:
          type: string
          description: The origin phone number.
        to:
          type: string
          description: The destination phone number.
        source:
          $ref: '#/components/schemas/VoiceSources'
          description: Source of this log entry.
        charge:
          type: number
          format: double
          description: The charge in dollars.
        charge_details:
          type: array
          items:
            $ref: '#/components/schemas/ChargeDetail'
          description: Details on charges associated with this log.
        created_at:
          type: string
          format: date-time
          description: Date and time when the call entry was created.
        type:
          $ref: '#/components/schemas/FabricVoiceLogType'
          description: Type of this log entry.
        url:
          description: Always null for this call type.
        direction:
          $ref: '#/components/schemas/VoiceDirection'
          description: The direction of the voice activity.
        status:
          oneOf:
            - $ref: '#/components/schemas/VoiceLogStatus'
            - type: 'null'
          description: The status of the voice activity. Always null for this call type.
      required:
        - id
        - from
        - to
        - source
        - charge
        - charge_details
        - created_at
        - type
        - url
        - direction
        - status
      description: >-
        Voice log for Fabric Subscriber Device call types. Returned when `type`
        is `fabric_subscriber_device_leg`.
      title: FabricVoiceLog
    DiscardedVoiceLog:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: A unique identifier for the log.
        discarded_at:
          type: string
          format: date-time
          description: Date and time when the log was discarded.
        created_at:
          type: string
          format: date-time
          description: Date and time when the log was originally created.
      required:
        - id
        - discarded_at
        - created_at
      description: >-
        A discarded/deleted voice log entry. Returned when the log has been
        deleted. Only present when `include_deleted` is `true`.
      title: DiscardedVoiceLog
    VoiceLog:
      oneOf:
        - $ref: '#/components/schemas/RelayVoiceLog'
        - $ref: '#/components/schemas/VideoRoomVoiceLog'
        - $ref: '#/components/schemas/DialogflowVoiceLog'
        - $ref: '#/components/schemas/FabricVoiceLog'
        - $ref: '#/components/schemas/DiscardedVoiceLog'
      description: >-
        A voice log entry. The specific fields present depend on the `type`
        value. Discarded logs return only `id`, `discarded_at`, and
        `created_at`.
      title: VoiceLog
    LogListResponse:
      type: object
      properties:
        links:
          $ref: '#/components/schemas/LogPaginationResponse'
          description: Pagination links
        data:
          type: array
          items:
            $ref: '#/components/schemas/VoiceLog'
          description: Array of voice log entries
      required:
        - links
        - data
      description: Response model for voice log list endpoint
      title: LogListResponse
    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
    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
    VoiceLogsListStatusCode422:
      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: VoiceLogsListStatusCode422
    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
  securitySchemes:
    SignalWireBasicAuth:
      type: http
      scheme: basic
      description: >-
        SignalWire Basic Authentication using Project ID and API Token.


        The client sends HTTP requests with the Authorization header containing

        the word Basic followed by a space and a base64-encoded string of
        project_id:token.

        The project ID will be used as the username and the API token as the
        password.


        Example:

        ```

        Authorization: Basic base64(project_id:token)

        ```

```

## SDK Code Examples

```python
import requests

url = "https://{your_space_name}.signalwire.com/api/voice/logs"

headers = {"Authorization": "Basic <project_id>:<api_token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://{your_space_name}.signalwire.com/api/voice/logs';
const options = {method: 'GET', headers: {Authorization: 'Basic <project_id>:<api_token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{your_space_name}.signalwire.com/api/voice/logs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <project_id>:<api_token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://{your_space_name}.signalwire.com/api/voice/logs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <project_id>:<api_token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://{your_space_name}.signalwire.com/api/voice/logs")
  .header("Authorization", "Basic <project_id>:<api_token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://{your_space_name}.signalwire.com/api/voice/logs', [
  'headers' => [
    'Authorization' => 'Basic <project_id>:<api_token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://{your_space_name}.signalwire.com/api/voice/logs");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic <project_id>:<api_token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Basic <project_id>:<api_token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://{your_space_name}.signalwire.com/api/voice/logs")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```