# List all Verified Caller IDs

GET https://YOUR_SPACE.signalwire.com/api/relay/rest/verified_caller_ids

Returns a list of your Verified Caller IDs. The caller IDs are returned sorted by creation date, with the most recent caller IDs appearing first. The list is filterable by sending in any of the following parameters.

#### 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/relay-rest/verified-caller-id/list-verified-caller-ids

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: relay-rest
  version: 1.0.0
paths:
  /verified_caller_ids:
    get:
      operationId: list-verified-caller-ids
      summary: List all Verified Caller IDs
      description: >-
        Returns a list of your Verified Caller IDs. The caller IDs are returned
        sorted by creation date, with the most recent caller IDs appearing
        first. The list is filterable by sending in any of the following
        parameters.


        #### 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_verifiedCallerId
      parameters:
        - name: filter_name
          in: query
          description: >-
            String representing the name assigned to the caller ID. Will return
            all Verified Caller IDs containing this value as a substring.
          required: false
          schema:
            type: string
        - name: filter_number
          in: query
          description: >-
            String representing the number assigned to the caller ID. Will
            return all Verified Caller IDs containing this value as a substring.
          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/VerifiedCallerIDListResponse'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
servers:
  - url: https://YOUR_SPACE.signalwire.com/api/relay/rest
components:
  schemas:
    PaginationLinks:
      type: object
      properties:
        self:
          type: string
          description: Link to the current page.
        first:
          type: string
          description: Link to the first page.
        next:
          type: string
          description: Link to the next page. Only present when there are more results.
        prev:
          type: string
          description: Link to the previous page. Only present when not on the first page.
      required:
        - self
        - first
      description: Pagination links for list responses.
      title: PaginationLinks
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
      title: uuid
    VerifiedCallerIdStatus:
      type: string
      enum:
        - Verified
        - Awaiting Verification
      description: The verification status for the caller ID.
      title: VerifiedCallerIdStatus
    VerifiedCallerID:
      type: object
      properties:
        type:
          type: string
          description: The type of the returned object, this should be verified_caller_id.
        id:
          $ref: '#/components/schemas/uuid'
          description: The unique identifier of the Verified Caller ID on SignalWire.
        number:
          type: string
          description: >-
            String representing the phone number for the caller ID. This must be
            a valid, routeable phone number in E.164 format.
        name:
          type: string
          description: >-
            String representing the name portion of the caller ID. If not
            provided, the default will be the formatted number that has been
            provided.
        extension:
          type: string
          description: >-
            String representing the extension of the phone number for the caller
            ID. This is only used when placing the verification call.
        verified:
          type: boolean
          description: A boolean representing whether the number has been verified or not.
        verified_at:
          type: string
          format: date-time
          description: >-
            Nullable DateTime field representing the date and time that the
            number was verified. If the number has not been verified, it will be
            null.
        status:
          $ref: '#/components/schemas/VerifiedCallerIdStatus'
          description: The verification status for the caller ID.
      required:
        - id
        - number
        - verified
      description: Verified caller ID model.
      title: VerifiedCallerID
    VerifiedCallerIDListResponse:
      type: object
      properties:
        links:
          $ref: '#/components/schemas/PaginationLinks'
          description: Pagination links.
        data:
          type: array
          items:
            $ref: '#/components/schemas/VerifiedCallerID'
          description: List of verified caller IDs.
      description: Response containing a list of verified caller IDs.
      title: VerifiedCallerIDListResponse
    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
    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.signalwire.com/api/relay/rest/verified_caller_ids"

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

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

print(response.json())
```

```javascript
const url = 'https://your_space.signalwire.com/api/relay/rest/verified_caller_ids';
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.signalwire.com/api/relay/rest/verified_caller_ids"

	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.signalwire.com/api/relay/rest/verified_caller_ids")

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.signalwire.com/api/relay/rest/verified_caller_ids")
  .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.signalwire.com/api/relay/rest/verified_caller_ids', [
  'headers' => [
    'Authorization' => 'Basic <project_id>:<api_token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://your_space.signalwire.com/api/relay/rest/verified_caller_ids");
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.signalwire.com/api/relay/rest/verified_caller_ids")! 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()
```