Get a SIP profile by ID
sip_profiles.retrieve(strsip_profile_id) -> SipProfile
GET/v3/sip-profiles/{sipProfileId}
Get a SIP profile by ID
import os
from linq import LinqAPIV3
client = LinqAPIV3(
api_key=os.environ.get("LINQ_API_V3_API_KEY"), # This is the default and can be omitted
)
sip_profile = client.sip_profiles.retrieve(
"sip_8a3f9c2b1d4e4f5a9b8c7d6e5f4a3b2c",
)
print(sip_profile.id){
"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": 403,
"code": 2005,
"message": "Access denied - insufficient permissions for this resource",
"doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/2xxx/2005/"
},
"success": false
}{
"error": {
"status": 404,
"code": 2001,
"message": "Resource not found",
"doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/2xxx/2001/"
},
"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
{
"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": 403,
"code": 2005,
"message": "Access denied - insufficient permissions for this resource",
"doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/2xxx/2005/"
},
"success": false
}{
"error": {
"status": 404,
"code": 2001,
"message": "Resource not found",
"doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/2xxx/2001/"
},
"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
}