Users

Users represent agents and admins inside an organization. These endpoints manage profile data, access roles, personal API keys, and roster visibility.

The user model

Properties

Name
_id
Type
string
Description
Unique identifier for the user.
Name
organizationId
Type
string
Description
Organization the user belongs to.
Name
departmentId
Type
string
Description
Optional department/team reference.
Name
email
Type
string
Description
Login email (unique).
Name
fullName
Type
string
Description
Full name of the user.
Name
phoneNumber
Type
string
Description
Personal phone number.
Name
designation
Type
string
Description
Job title or role description.
Name
accessRole
Type
string
Description
Access level (SUPERADMIN, ADMIN, DEPARTMENT_HEAD, SALES_REP).
Name
sinchPhoneNumber
Type
string
Description
Assigned Sinch number used for outbound SMS.
Name
persona
Type
objectId
Description
Optional persona record for AI personalization.
Name
loginDisabled
Type
boolean
Description
Whether the account is disabled.
Name
automations
Type
object
Description
Map of automationId → enabled flag for this user.
Name
createdAt
Type
timestamp
Description
When the user was created.
Name
updatedAt
Type
timestamp
Description
When the user was last updated.

GET/api/user/profile

Get the current user profile

Returns the authenticated user's profile and persona without the password hash.

Request

GET

/api/user/profile

curl https://api.tether.com/api/user/profile \
  -H "Authorization: Bearer {token}"

PUT/api/user/profile

Update profile

Update profile fields for the current user. Admins and higher can also update selected fields for lower-role users by passing their id.

Updatable fields

Name
fullName
Type
string
Description
Name
email
Type
string
Description
Name
phoneNumber
Type
string
Description
Name
designation
Type
string
Description
Name
sinchPhoneNumber
Type
string
Description
Rewrites historic messages to the new number.
Name
departmentId
Type
string
Description
Name
ConversationListAutoScrolling
Type
boolean
Description
Name
callForwardingEnabled
Type
boolean
Description
Name
persona
Type
object
Description
Persona details to store or update.

Request

PUT

/api/user/profile

curl -X PUT https://api.tether.com/api/user/profile \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "fullName": "Jamie Agent",
    "phoneNumber": "+11235550123",
    "designation": "Account Executive",
    "persona": {
      "position": "Sales",
      "leadProvider": "Meta",
      "region": "US"
    }
  }'

GET/api/user/api-key

Manage personal API keys

Generate or fetch a user-scoped API key for external integrations.

GET /api/user/api-key — returns (and creates if missing) an API key.
POST /api/user/api-key/regenerate — rotates the key.

Request

POST

/api/user/api-key/regenerate

curl -X POST https://api.tether.com/api/user/api-key/regenerate \
  -H "Authorization: Bearer {token}"

POST/api/user/list

List users in an organization

Retrieve users scoped to an organization (and optionally a team). Superadmins can pass organizationId; admins can filter by teamId.

Optional body fields

Name
organizationId
Type
string
Description
Target organization (superadmin only).
Name
teamId
Type
string
Description
Filter by team/department.

Request

POST

/api/user/list

curl -X POST https://api.tether.com/api/user/list \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{ "teamId": "65fd90c0f1e0a8123456789b" }'

DELETE/api/user/:id

Delete a user

Superadmins, admins, and team leads can delete users with roles lower than or equal to theirs.

Request

DELETE

/api/user/:id

curl -X DELETE https://api.tether.com/api/user/6610f3e6c4b5f1c987654321 \
  -H "Authorization: Bearer {token}"