Skip to main content

GET /me

Get your own profile and phone line logins

The caller's own user record, plus the phone lines that person owns — each with its SIP username and password. This is what a web phone signs in with: see the Build your own web phone guide.

Scopeprofile:read
Role permissionNone — own lines only
CostFree

Sensitive. A SIP password is a long-lived phone login: anyone who has it can make calls on the account. Every read of this endpoint is recorded.

Whose lines. With an API key, the key's run-as user. With an OAuth token, the person who approved the app. Never anyone else's — the directory (GET /users) never carries passwords. A credential that is not tied to a user gets 403 permission_denied.

The user fields are the same as an entry of GET /users, except that lines is the detailed list below instead of a list of line names. On top of those you get what Teleconsole's own profile shows: the account, the role, contact details and address, photo, current status, and the numbers this user may text and fax from (the same lists as GET /sms/lines and GET /faxes/lines).

The connection details are the same for every account, so they are not returned: register over wss://websocket.telebroad.com:8443 as <sipUsername>@reg.telebroad.com:5060, with sipPassword.

Responses​

200​

The caller's own profile and lines.

FieldTypeDescription
idintegerThe user's id on the phone system — the same id GET /users returns.
usernamestringThe login this person signs in with. Empty for a user created without portal access.
firstNamestringThe user's first name.
lastNamestringThe user's last name.
titlestringJob title as entered in the portal. Free text.
emailstringThe user's email address. May be blank.
mobilestringThe personal/cell number on the user's profile — not a number on the account. May be blank.
companystringThe per-user company override, falling back to the account's own name.
timeZonestringThe user's IANA zone.
extensionstringThe dial-by-name extension. Not necessarily a phone extension; see extensions.
extensionsstring[]The PBX extensions assigned to this user.
numbersstring[]The account DIDs owned by this user.
voicemailsstring[]The mailbox names the user owns.
accountobjectThe company this user belongs to.
account.idintegerThe account id.
account.namestringThe account name.
account.callerIdstringThe account's default outbound caller ID.
roleobjectThe user's portal role. For an API key, the run-as user's role.
role.idinteger
role.namestring
telephonestringThe phone number typed on the user's profile. Free text, may be blank.
faxstringThe fax number typed on the user's profile. Free text, may be blank.
addressobjectThe postal address on the user's profile. Every part may be blank.
address.line1string
address.line2string
address.line3string
address.citystring
address.statestring
address.postalCodestring
address.otherstring
countrystringThe user's country code. May be blank.
languagestringThe user's language code. May be blank.
photoUrlstringThe user's profile photo. null without one.
statusobjectThe status the user set in Teleconsole ("In a meeting"). null when none is set.
status.idinteger
status.namestring
status.descriptionstring
status.emojistring
status.expiresAtstring (RFC 3339)When the status clears by itself (UTC). null when it doesn't.
linesobject[]The lines this person owns, each with its SIP login. Empty when they own none.
lines[].sipUsernamestringThe line name — the SIP user to register as (<sipUsername>@reg.telebroad.com:5060).
lines[].sipPasswordstringThe line's SIP password. A long-lived phone login — store it like a password, never in logs or URLs. Changes when the line's password is reset in the admin center.
lines[].descriptionstringThe line's label in the portal.
lines[].extensionstringThe internal number colleagues dial to reach this line.
lines[].callerIdstringThe line's caller ID setting, as configured: a number, or default when the line uses the default caller ID. Check this to know the line follows the default, whatever number that is today.
lines[].callerIdNumberstringThe number people see when this line calls out right now. Same as callerId when that is a number; for default, the number the default currently is.
lines[].featureCodestringThe short code that dials this line directly. Empty when it has none.
smsNumbersobject[]The numbers this user may text from — the same list as GET /sms/lines.
smsNumbers[].numberstringThe sending number, already in the exact form from wants. Copy it straight through — no reformatting.
smsNumbers[].namestringThe line's caller-ID name, as shown in the portal. Empty if none is set.
smsNumbers[].userIdsinteger[]The users assigned to this line in the message center. Each value is a user's numeric id — the id field returned by GET /users, which is where you look up which id belongs to which person. An empty userIds means the line is unrestricted — available to everyone, not that nobody has it.
smsNumbers[].bulkEnabledbooleanWhether the number is registered for 10DLC bulk/campaign traffic. Shown for information only — you can't filter the list by it. Campaign registration is not required to send through this API, so a line with false sends fine.
faxNumbersobject[]The numbers this user may fax from — the same list as GET /faxes/lines.
faxNumbers[].numberstringThe fax number in the exact form from and the number filter want. Copy it straight through.
faxNumbers[].namestringThe number's caller-ID name. Empty if none is set.
{
"data": {
"id": 481920,
"username": "dspencer",
"firstName": "Dana",
"lastName": "Spencer",
"title": "Support Lead",
"email": "dana@acme.example",
"mobile": "13475550188",
"company": "Acme Inc",
"timeZone": "America/New_York",
"extension": "204",
"extensions": [
"204"
],
"numbers": [
"12125550188"
],
"voicemails": [
"204"
],
"account": {
"id": 651,
"name": "Acme Inc",
"callerId": "12125550100"
},
"role": {
"id": 1,
"name": "Account Owner"
},
"telephone": "12125550188",
"fax": "",
"address": {
"line1": "1 Main St",
"line2": "",
"line3": "",
"city": "Brooklyn",
"state": "NY",
"postalCode": "11201",
"other": ""
},
"country": "us",
"language": "en",
"photoUrl": "https://cdn.telebroad.com/photos/481920.png",
"status": {
"id": 12207,
"name": "In a meeting",
"description": "",
"emoji": "📅",
"expiresAt": "2026-11-10T19:30:00Z"
},
"lines": [
{
"sipUsername": "acme-204",
"sipPassword": "s3cr3t-EXAMPLE",
"description": "Dana's desk",
"extension": "204",
"callerId": "default",
"callerIdNumber": "12125550100",
"featureCode": "*204"
}
],
"smsNumbers": [
{
"number": "12125550100",
"name": "Acme Main",
"userIds": [],
"bulkEnabled": false
}
],
"faxNumbers": [
{
"number": "12125550101",
"name": "Acme Fax"
}
]
}
}

Errors​

StatusMeaning
401unauthenticated — no credential, or one that is invalid, revoked or expired. The WWW-Authenticate header names the scope the endpoint wanted.
403Two different failures share this status; the type field tells them apart — insufficient_scope (the credential lacks the scope) or permission_denied (the scope is fine, but the user's role lacks the permission).
500internal_error — something failed on our side, not with your request. Safe to retry.

See Errors for the full catalog and what to do about each.

Example​

curl -X GET 'https://api.account.telebroad.com/api/public/v1/me' \
-H "Authorization: Bearer $TB_KEY"

Try it in the playground →