How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SendHub Profile API

View and manage your account and lines

SendHub Profile API is one of 6 APIs that SendHub publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Profile. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 5 paths, and defines 67 schemas. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against a single base URL, https://api.sendhub.com.

6 operations 5 paths 67 schemas 5 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://api.sendhub.com
Authentication
API Key, API Key, HTTP Basic
License
Terms of Service
Resource Areas
1

Authentication & Security 3

SendHub Profile API declares 3 security schemes for authenticating requests. An API key is passed in the query as username (username). An API key is passed in the query as api_key (api_key). It accepts HTTP basic authentication (basic_auth). By default, every request must be authenticated.

  • username — Your SendHub line's username (can be found in your My Settings page)
  • api_key — Your SendHub line's API key (can be found in your My Settings page)
  • basic_auth — Use your SendHub line's password or API key as the password with HTTP Basic Authentication (Your username and API key can be found in your My Settings page)

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 5 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Profile 6

View and manage your account and lines

GET
/v1/settings
Get Settings
getSettings → 200401420429
PUT
/v1/settings
Update Settings
updateSettings body → 200401420429
GET
/v1/profile
Get Profile
getProfile → 200401420429
GET
/v1/enterprises/{enterprise_id}
Get Enterprise (Account)
getEnterprise 1 param → 200401420429
GET
/v1/enterprises/{enterprise_id}/users
List Users
listUsers 1 param → 200401420429
GET
/v1/enterprises/{enterprise_id}/users/{user_id}
Get User
getUser 2 params → 200401420429

Schemas 67

The contract defines 67 schemas that model the data the API accepts and returns. The most detailed are settings (48 properties), listNestedUser (25 properties), userProfile (19 properties), enterprise (14 properties). Each schema is shown below with its type and property counts.

settingsJson
string
registrationStatus
string
modifiedTs
enterpriseName
string
Your company name
internalId
next
string
profileUnread
integer
Shows how many unread threads this User (line) has
pendingPhoneNumber
string
Phone number waiting to be verified for the "Personal Cell" field
listUsersResponse
object
2 properties
username
string
User's (SendHub line's) username
twilioPhoneNumberId
This is used internally and may be expanded upon or removed in the future
formattedSendhubNumber
string
This line's SendHub number (formatted)
offset
integer
pusherKey
string
userProfile
object
19 properties 19 required
idBoth
enterprise
object
14 properties 13 required
listNestedUser
object
25 properties 23 required
dateJoined
Timestamp that this SendHub User (line) was created
sendhubNumber
string
This line's SendHub number (E.164 format)
nullableString
string
planId
The plan ID
idStr
string
Same as id but always a string
id
string
brandId
string
10DLC Brand ID
timestamp
string
A UTC timestamp 2021-08-01T03:48:55.350453 equals August 1st, 2021 at 3:48 and 55.350453 seconds AM (UTC)
personalCell
string
The Personal Cell number in your [My Settings page](https://app.sendhub.com/settings)
signature
string
Signature that the SendHub apps append to new messages Note: SendHub does not use this field when sending via the API
date
string
authGroup
userName
string
User's (SendHub line's) name
previous
string
mixpanelId
string
This is used internally and may be expanded upon or removed in the future
nullableStringRO
updateSettings
userId
The ID of a SendHub user (an individual line)
enterpriseJoinLink
string
This is used internally and may be expanded upon or removed in the future
customerId
timestampWithoutDecimal
string
A UTC timestamp 2021-08-01T03:48:34 equals August 1st, 2021 at 3:48 and 34 seconds AM (UTC)
disableIncomingSms
boolean
paymentPeriodStart
createdTs
paymentPeriodEnd
isVerifiedEmail
boolean
Whether this user's email has been verified
limit
integer
user
object
Individual SendHub user (line)
email
string
settings
object
Settings for an individual user (SendHub line)
48 properties
upvotes
integer
This is used internally and may be expanded upon or removed in the future
enterpriseId
The enterprise ID
deletedNullable
boolean
enterpriseSize
integer
How manu Users (lines) your account has
onboardingMobileFinished
boolean
This is used internally and may be expanded upon or removed in the future
downvotes
integer
This is used internally and may be expanded upon or removed in the future
rateLimitingResponse
object
6 properties
profileResourceUri
string
Resource URI for this User's profile
paymentScheduleId
string
Your plan's payment schedule type: 1. Monthly 2. Yearly 3. Consumable (eg. free trial)
modifiedTsWithoutDecimal
idInt
integer
onboardingWebFinished
authGroups
array
dateRO
twilioPhoneNumberIdStr
createdTsWithoutDecimal
meta
object
4 properties
image
string
The URL for this user's profile image
enterpriseIdStr
The enterprise ID

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sendhub-profile-api-openapi.yml Raw ↑

Other APIs SendHub publishes across the network.

SendHub Authentication API
SendHub Contact API
SendHub Group API
SendHub Message API
SendHub Thread API
Where this information came from

This is an independent, third-party profile of SendHub Profile API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.