> ## Documentation Index
> Fetch the complete documentation index at: https://docs.unpod.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Bridge by Slug

> Retrieve details of a specific telephony bridge using its slug

<ResponseExample>
  ```json Success Response (200) theme={null}
  {
    "status_code": 200,
    "message": "Bridge fetched successfully.",
    "data": {
      "id": 314,
      "name": "Sales Bridge",
      "slug": "sales-bridge-001",
      "numbers": [
        {
          "id": 501,
          "number_id": 25,
          "number": "+1234567890",
          "state": "ASSIGNED",
          "active": true,
          "channels_count": 2,
          "status": "active"
        }
      ]
    }
  }
  ```

  ```json Error Response (404) theme={null}
  {
    "status_code": 404,
    "message": "Bridge not found.",
    "errors": "No bridge exists with the provided slug"
  }
  ```
</ResponseExample>

# Get Bridge by Slug

Retrieve full details of a specific telephony bridge using its unique slug identifier, including its assigned phone numbers and current configuration.

<Note>
  **Prerequisites:** Make sure you have your API Token and Org-Handle ready. See [Authentication](/api/get-started/authentication) for details.
</Note>

### Path Parameters

| Name | Type   | Required | Description        |
| ---- | ------ | -------- | ------------------ |
| slug | string | Yes      | Unique bridge slug |

<Note>
  You can get the bridge `slug` by hitting the [Get All Bridges](/api/telephony/get-all-bridges) API. The `slug` field in the response is your Bridge Slug.
</Note>

### Headers

| Name          | Type   | Required | Description                     |
| ------------- | ------ | -------- | ------------------------------- |
| Authorization | string | Yes      | API Key format: `Token <token>` |
| Org-Handle    | string | Yes      | Organization domain handle      |

<Note>
  You can get the `Org-Handle` by hitting the [Get All Organizations](/api/space/organizations#get-all-organizations) API. The `domain_handle` field in the response is your Org-Handle.
</Note>

### Response Fields

| Field        | Type    | Description      |
| ------------ | ------- | ---------------- |
| status\_code | integer | HTTP status code |
| message      | string  | Response message |
| data         | object  | Bridge details   |

### Bridge Object Fields

| Field   | Type    | Description                    |
| ------- | ------- | ------------------------------ |
| id      | integer | Bridge unique identifier       |
| name    | string  | Bridge display name            |
| slug    | string  | Unique bridge slug identifier  |
| numbers | array   | List of assigned phone numbers |

### Number Object Fields

| Field           | Type    | Description                            |
| --------------- | ------- | -------------------------------------- |
| id              | integer | Number assignment ID                   |
| number\_id      | integer | Phone number ID                        |
| number          | string  | Phone number (E.164 format)            |
| state           | string  | Number state: `ASSIGNED`, `UNASSIGNED` |
| active          | boolean | Whether number is active               |
| channels\_count | integer | Number of active channels              |
| status          | string  | Number status: `active`, `inactive`    |

## Common Error Codes

| Status Code | Description                                 |
| ----------- | ------------------------------------------- |
| 200         | Success - Bridge fetched successfully       |
| 401         | Unauthorized - Invalid or missing API token |
| 403         | Forbidden - Invalid organization handle     |
| 404         | Not Found - Bridge not found                |
| 500         | Internal Server Error - Server-side error   |

## Code Examples

<CodeGroup>
  ```javascript Node.js theme={null}
  const axios = require('axios');

  const headers = {
    'Authorization': 'Token your-api-token',
    'Org-Handle': 'your-org-handle'
  };

  // Get bridge by slug
  const getBridgeBySlug = async (slug) => {
    const response = await axios.get(
      `https://unpod.ai/api/v2/platform/telephony/bridges/${slug}/`,
      { headers }
    );
    const bridge = response.data.data;
    console.log(`Bridge: ${bridge.name} (${bridge.slug})`);
    console.log(`Assigned numbers: ${bridge.numbers.length}`);
    return bridge;
  };

  // Example usage
  getBridgeBySlug('sales-bridge-001');
  ```

  ```python Python theme={null}
  import requests

  headers = {
      'Authorization': 'Token your-api-token',
      'Org-Handle': 'your-org-handle'
  }

  def get_bridge_by_slug(slug: str):
      """Get bridge details by slug"""
      url = f'https://unpod.ai/api/v2/platform/telephony/bridges/{slug}/'
      response = requests.get(url, headers=headers)
      data = response.json()
      bridge = data['data']
      print(f"Bridge: {bridge['name']} ({bridge['slug']})")
      print(f"Assigned numbers: {len(bridge['numbers'])}")
      return bridge

  # Example usage
  get_bridge_by_slug('sales-bridge-001')
  ```

  ```bash cURL theme={null}
  # Get bridge by slug
  curl -X GET "https://unpod.ai/api/v2/platform/telephony/bridges/sales-bridge-001/" \
    -H "Authorization: Token your-api-token" \
    -H "Org-Handle: your-org-handle"
  ```
</CodeGroup>

## Best Practices

1. **Slug Validation**: Handle 404 errors when a bridge slug may have been deleted or renamed
2. **Number Inspection**: Check the `numbers` array to verify active phone numbers before routing calls
3. **Active Status**: Only numbers with `active: true` and `status: active` are ready to handle calls
4. **Error Handling**: Always handle potential errors and edge cases
5. **Security**: Keep API tokens secure and rotate them regularly


## OpenAPI

````yaml GET /api/v2/platform/telephony/bridges/{slug}/
openapi: 3.0.3
info:
  title: Unpod API
  description: REST API for Unpod Voice AI Platform
  version: 2.0.0
servers:
  - url: https://unpod.ai/
    description: QA
  - url: https://unpod.ai/
    description: Production
security: []
tags:
  - name: Organisation
  - name: Spaces
  - name: Agents
  - name: Tasks
  - name: Runs
  - name: Call Logs
  - name: Analytics
  - name: Providers
  - name: Bridges
  - name: Numbers
  - name: Trunks
  - name: Telephony
  - name: Billing
paths:
  /api/v2/platform/telephony/bridges/{slug}/:
    get:
      tags:
        - Bridges
      summary: Get Bridge by Slug
      operationId: getBridgeBySlug
      parameters:
        - name: slug
          in: path
          required: true
          schema:
            type: string
            example: sales-bridge-001
        - $ref: '#/components/parameters/OrgHandle'
      responses:
        '200':
          description: Bridge details
          content:
            application/json:
              example:
                status_code: 200
                message: Bridge fetched successfully.
                data:
                  id: 314
                  name: Sales Bridge
                  slug: sales-bridge-001
                  numbers:
                    - id: 501
                      number_id: 25
                      number: '+1234567890'
                      state: ASSIGNED
                      active: true
                      channels_count: 2
                      status: active
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
        - TokenAuth: []
components:
  parameters:
    OrgHandle:
      name: Org-Handle
      in: header
      required: true
      schema:
        type: string
        example: unpod.tv
      description: Organization domain handle
  responses:
    Unauthorized:
      description: Unauthorized - Invalid or missing API token
      content:
        application/json:
          example:
            status_code: 401
            message: Authentication credentials were not provided.
    NotFound:
      description: Resource not found
      content:
        application/json:
          example:
            status_code: 404
            message: Not found.
  securitySchemes:
    TokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: 'Format: Token <your-api-key>'

````