> Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes.

# get

> Retrieve the current project SIP profile.

Retrieve the current project SIP profile.

### Schema

```yaml
openapi: 3.1.0
info:
  title: API
  version: 1.0.0
paths:
  /api/relay/rest/sip_profile:
    get:
      operationId: subpackageSipProfile_retrieve_sip_profile
      summary: Get SIP profile
      description: >-
        Retrieves the SIP Profile shared across your SignalWire project. The
        profile supplies project-wide defaults to SIP Credentials that use it;
        individual registering devices and external destinations are represented
        by [SIP Credentials](/docs/apis/rest/sip-credentials/get-sip-credential)
        and [SIP Gateways](/docs/apis/rest/sip-gateway/get-sip-gateway).


        #### 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_sipProfile
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SipProfileResponse'
        '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'
tags:
  - name: subpackage_sipProfile
servers:
  - url: https://%7BYour_Space_Name%7D.signalwire.com
    description: SignalWire API
components:
  schemas:
    SipProfileResponseDefaultEncryption:
      type: string
      enum:
        - required
        - optional
      description: >-
        A string representing whether connections to an endpoint that uses this
        profile require encryption or if encryption is optional. Encryption will
        always be used if possible. Possible values are required or optional.
      title: SipProfileResponseDefaultEncryption
    SipProfileResponse:
      type: object
      properties:
        domain:
          type: string
          description: >-
            A string representation of the fully qualified domain name for this
            profile.
        domain_identifier:
          type: string
          description: >-
            String representing the domain_identifier portion of the profile.
            Must be unique across your project.
        default_codecs:
          type: array
          items:
            type: string
          description: >-
            A list of codecs this profile will support. Currently supported
            values are: OPUS, G722, PCMU, PCMA, VP8, H264.
        default_ciphers:
          type: array
          items:
            type: string
          description: >-
            A list of encryption ciphers this profile will support. Currently
            supported values are: AEAD_AES_256_GCM_8, AES_256_CM_HMAC_SHA1_80,
            AES_CM_128_HMAC_SHA1_80, AES_256_CM_HMAC_SHA1_32,
            AES_CM_128_HMAC_SHA1_32.
        default_encryption:
          $ref: '#/components/schemas/SipProfileResponseDefaultEncryption'
          description: >-
            A string representing whether connections to an endpoint that uses
            this profile require encryption or if encryption is optional.
            Encryption will always be used if possible. Possible values are
            required or optional.
        default_send_as:
          type: string
          description: >-
            The e164 formatted number you wish to set as the originating number
            when dialing PSTN phone numbers from a SIP Endpoint that uses this
            profile. Specify null or an empty string to randomly choose a
            purchased or verified number from within the project.
      description: Response containing the SIP profile.
      title: SipProfileResponse
    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

```

## **Response Example**

### Response (200)

```json
{
  "domain": "your-space-example.sip.signalwire.com",
  "domain_identifier": "example",
  "default_codecs": [
    "string"
  ],
  "default_ciphers": [
    "string"
  ],
  "default_encryption": "optional",
  "default_send_as": "+15551234567"
}
```

## **Example**

```typescript {4}
import { RestClient } from "@signalwire/sdk";

const client = new RestClient();
const profile = await client.sipProfile.get();
console.log(profile);
```

> Retrieve the current project SIP profile.