Skip to content
Linq Copy agent prompt

List SIP profiles

client.SipProfiles.List(ctx) (*SipProfileListResponse, error)
GET/v3/sip-profiles

Retrieve all SIP profiles for the authenticated partner.

ReturnsExpand Collapse
type SipProfileListResponse struct{…}
SipProfiles []SipProfile

The partner’s SIP profiles

ID string

Unique identifier for the SIP profile

AssignedNumberCount int64

How many phone numbers reference this profile

CreatedAt Time
formatdate-time
Name string

Human-readable name

PrimaryUri string

Your SIP endpoint as scheme + host (sip: UDP / sips: TLS); no user part — we set it to the called number on each call.

UpdatedAt Time
formatdate-time
Version int64

Monotonic version, incremented on each update

BackupUri stringOptional

Optional failover SIP URI. Null when unset.

List SIP profiles

package main

import (
  "context"
  "fmt"

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

func main() {
  client := linqgo.NewClient(
    option.WithAPIKey("My API Key"),
  )
  sipProfiles, err := client.SipProfiles.List(context.TODO())
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", sipProfiles.SipProfiles)
}
{
  "sip_profiles": [
    {
      "id": "sip_8a3f9c2b1d4e4f5a9b8c7d6e5f4a3b2c",
      "assigned_number_count": 0,
      "created_at": "2026-10-29T10:30:00Z",
      "name": "byoc-primary",
      "primary_uri": "sips:sip.partner.example",
      "updated_at": "2026-10-29T10:30:00Z",
      "version": 1,
      "backup_uri": null
    }
  ]
}
{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token",
    "doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/2xxx/2004/"
  },
  "success": false
}
{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error",
    "doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/3xxx/3006/"
  },
  "success": false
}
Returns Examples
{
  "sip_profiles": [
    {
      "id": "sip_8a3f9c2b1d4e4f5a9b8c7d6e5f4a3b2c",
      "assigned_number_count": 0,
      "created_at": "2026-10-29T10:30:00Z",
      "name": "byoc-primary",
      "primary_uri": "sips:sip.partner.example",
      "updated_at": "2026-10-29T10:30:00Z",
      "version": 1,
      "backup_uri": null
    }
  ]
}
{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token",
    "doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/2xxx/2004/"
  },
  "success": false
}
{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error",
    "doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/3xxx/3006/"
  },
  "success": false
}