List DIRs in an enterprise

Return the DIRs (Display Identity Records) belonging to a single enterprise. Pagination is JSON:API style (page[number], page[size], max 250). Supports filter[] query params: filter[status], filter[display_name][contains], filter[call_reason][contains], plus the renewal-window filters filter[expiring_at][gte] / filter[expiring_at][lte] and the convenience filter[expiring_within_days] (mutually exclusive with the explicit gte/lte form). Sortable by created_at, updated_at, display_name, status, submitted_at, verified_at, expiring_at (prefix - for descending; default -created_at).

GET

enterprises

{enterprise_id}

dir

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const dirListResponse of client.enterprises.dir.list(
  '4a6192a4-573d-446d-b3ce-aff9117272a6',
)) {
  console.log(dirListResponse.id);
}

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
page = client.enterprises.dir.list(
    enterprise_id="4a6192a4-573d-446d-b3ce-aff9117272a6",
)
page = page.data[0]
print(page.id)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	page, err := client.Enterprises.Dir.List(
		context.TODO(),
		"4a6192a4-573d-446d-b3ce-aff9117272a6",
		telnyx.EnterpriseDirListParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.enterprises.dir.DirListPage;
import com.telnyx.sdk.models.enterprises.dir.DirListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        DirListPage page = client.enterprises().dir().list("4a6192a4-573d-446d-b3ce-aff9117272a6");
    }
}

require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

page = telnyx.enterprises.dir.list("4a6192a4-573d-446d-b3ce-aff9117272a6")

puts(page)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $page = $client->enterprises->dir->list(
    '4a6192a4-573d-446d-b3ce-aff9117272a6',
    filterCallReasonContains: 'filter[call_reason][contains]',
    filterDisplayNameContains: 'filter[display_name][contains]',
    filterExpiringAtGte: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
    filterExpiringAtLte: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
    filterExpiringWithinDays: 1,
    filterStatus: 'draft',
    pageNumber: 1,
    pageSize: 20,
    sort: 'created_at',
  );

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

telnyx enterprises:dir list \
  --api-key 'My API Key' \
  --enterprise-id 4a6192a4-573d-446d-b3ce-aff9117272a6

curl --request GET \
  --url https://api.telnyx.com/v2/enterprises/{enterprise_id}/dir \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "16635d38-75a6-4481-82e8-69af60e05011",
      "enterprise_id": "4a6192a4-573d-446d-b3ce-aff9117272a6",
      "display_name": "Acme Plumbing",
      "reselling": false,
      "certify_brand_is_accurate": true,
      "certify_no_shaft_content": true,
      "certify_ip_ownership": true,
      "authorizer_name": "Sam Owner",
      "authorizer_email": "sam@acmeplumbing.example.com",
      "logo_url": "https://acmeplumbing.example.com/logo-256.bmp",
      "call_reasons": [
        {
          "reason": "Appointment reminders",
          "created_at": "2026-04-26T18:06:51.940749Z"
        }
      ],
      "documents": [
        {
          "document_id": "2a7e8337-e803-4057-a4ae-26c40eb0bc6c",
          "document_type": "business_registration",
          "description": "Certificate of incorporation."
        }
      ],
      "rejection_reasons": [
        {
          "code": "documentation_incomplete",
          "title": "Documentation incomplete",
          "detail": "Provided documents do not establish business identity.",
          "message": "Please re-upload a clearer scan of the certificate."
        }
      ],
      "rejected_at": "2023-11-07T05:31:56Z",
      "created_at": "2026-04-26T18:06:51.940749Z",
      "updated_at": "2026-04-26T18:09:24.785211Z",
      "submitted_at": "2026-04-26T18:07:03.716411Z",
      "verified_at": "2026-04-26T18:07:29.537926Z",
      "expiring_at": "2027-04-26T18:07:29.537981Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 42,
    "page_number": 1,
    "page_size": 20
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

enterprise_id

string<uuid>

required

The enterprise id. Lowercase UUID.

Example:

"4a6192a4-573d-446d-b3ce-aff9117272a6"

Query Parameters

page[number]

integer

default:1

1-based page number. Out-of-range values return an empty page with correct meta.

Required range: x >= 1

Example:

1

page[size]

integer

default:20

Items per page. Maximum 250; values above are clamped to 250.

Required range: 1 <= x <= 250

Example:

20

sort

enum<string>

default:-created_at

Sort field. Allowed: created_at, updated_at, display_name, status, submitted_at, verified_at, expiring_at. Prefix with - for descending. Default -created_at.

Available options:

created_at,

-created_at,

updated_at,

-updated_at,

display_name,

-display_name,

status,

-status,

submitted_at,

-submitted_at,

verified_at,

-verified_at,

expiring_at,

-expiring_at

filter[expiring_at][gte]

string<date-time>

Return only DIRs whose expiring_at is at or after this ISO-8601 timestamp.

filter[expiring_at][lte]

string<date-time>

Return only DIRs whose expiring_at is at or before this ISO-8601 timestamp.

filter[expiring_within_days]

integer

Convenience: returns DIRs whose expiring_at falls within the next N days (1–365). Equivalent to setting filter[expiring_at][gte]=<now> + filter[expiring_at][lte]=<now+N>. Mutually exclusive with the explicit [gte]/[lte] filters - combining returns 400.

Required range: 1 <= x <= 365

filter[status]

enum<string>

Filter by DIR status. DIR lifecycle status.

draft - newly created; editable; not yet submitted.
submitted / in_review - Telnyx is reviewing.
verified - approved; phone numbers may be attached.
rejected - Telnyx rejected this submission; rejection_reasons is populated; customer can edit and resubmit.
unsuccessful - system-side error during processing; customer can edit and resubmit.
suspended - temporarily disabled (e.g. by an active infringement claim).
expired - verification expired; customer must resubmit.
infringement_claimed - a trademark/impersonation claim is open against this DIR.
permanently_rejected - terminal; cannot be resubmitted.

Available options:

draft,

submitted,

in_review,

verified,

rejected,

unsuccessful,

suspended,

expired,

infringement_claimed,

permanently_rejected

filter[display_name][contains]

string

Case-insensitive partial match on display name.

filter[call_reason][contains]

string

Case-insensitive partial match on call reason.

Response

Paginated list of DIRs.

data

object[]

required

Show child attributes

meta

object

required

JSON:API pagination metadata returned with every paginated list response. Page numbering is 1-based. page_size reports the number of items actually returned in data for this page; the requested size is taken from the page[size] query parameter.

Show child attributes

Activate Branded Calling on an enterprise

Create a Display Identity Record (DIR)

⌘I

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const dirListResponse of client.enterprises.dir.list(
  '4a6192a4-573d-446d-b3ce-aff9117272a6',
)) {
  console.log(dirListResponse.id);
}

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
page = client.enterprises.dir.list(
    enterprise_id="4a6192a4-573d-446d-b3ce-aff9117272a6",
)
page = page.data[0]
print(page.id)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	page, err := client.Enterprises.Dir.List(
		context.TODO(),
		"4a6192a4-573d-446d-b3ce-aff9117272a6",
		telnyx.EnterpriseDirListParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.enterprises.dir.DirListPage;
import com.telnyx.sdk.models.enterprises.dir.DirListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        DirListPage page = client.enterprises().dir().list("4a6192a4-573d-446d-b3ce-aff9117272a6");
    }
}

require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

page = telnyx.enterprises.dir.list("4a6192a4-573d-446d-b3ce-aff9117272a6")

puts(page)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $page = $client->enterprises->dir->list(
    '4a6192a4-573d-446d-b3ce-aff9117272a6',
    filterCallReasonContains: 'filter[call_reason][contains]',
    filterDisplayNameContains: 'filter[display_name][contains]',
    filterExpiringAtGte: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
    filterExpiringAtLte: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
    filterExpiringWithinDays: 1,
    filterStatus: 'draft',
    pageNumber: 1,
    pageSize: 20,
    sort: 'created_at',
  );

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

telnyx enterprises:dir list \
  --api-key 'My API Key' \
  --enterprise-id 4a6192a4-573d-446d-b3ce-aff9117272a6

curl --request GET \
  --url https://api.telnyx.com/v2/enterprises/{enterprise_id}/dir \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "16635d38-75a6-4481-82e8-69af60e05011",
      "enterprise_id": "4a6192a4-573d-446d-b3ce-aff9117272a6",
      "display_name": "Acme Plumbing",
      "reselling": false,
      "certify_brand_is_accurate": true,
      "certify_no_shaft_content": true,
      "certify_ip_ownership": true,
      "authorizer_name": "Sam Owner",
      "authorizer_email": "sam@acmeplumbing.example.com",
      "logo_url": "https://acmeplumbing.example.com/logo-256.bmp",
      "call_reasons": [
        {
          "reason": "Appointment reminders",
          "created_at": "2026-04-26T18:06:51.940749Z"
        }
      ],
      "documents": [
        {
          "document_id": "2a7e8337-e803-4057-a4ae-26c40eb0bc6c",
          "document_type": "business_registration",
          "description": "Certificate of incorporation."
        }
      ],
      "rejection_reasons": [
        {
          "code": "documentation_incomplete",
          "title": "Documentation incomplete",
          "detail": "Provided documents do not establish business identity.",
          "message": "Please re-upload a clearer scan of the certificate."
        }
      ],
      "rejected_at": "2023-11-07T05:31:56Z",
      "created_at": "2026-04-26T18:06:51.940749Z",
      "updated_at": "2026-04-26T18:09:24.785211Z",
      "submitted_at": "2026-04-26T18:07:03.716411Z",
      "verified_at": "2026-04-26T18:07:29.537926Z",
      "expiring_at": "2027-04-26T18:07:29.537981Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 42,
    "page_number": 1,
    "page_size": 20
  }
}