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 Authentication API

Log in via Username & Password and "Sign In As User"

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

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

This API exposes 1 operation across 1 path, and defines 25 schemas. It is described by OpenAPI 3.0.3, at version v1.

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

1 operations 1 paths 25 schemas 1 POST

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 Authentication 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 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Authentication 1

Log in via Username & Password and "Sign In As User"

POST
/v1/auth
Username & password login
login body → 200401420429

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are login200Response (13 properties), rateLimitingResponse (6 properties), loginRequest (4 properties). Each schema is shown below with its type and property counts.

sendhubNumber
string
This line's SendHub number (E.164 format)
settingsJson
string
login200Response
object
13 properties
rateLimitingResponse
object
6 properties
registrationStatus
string
nullableInteger
integer
disableIncomingSms
boolean
nullableString
string
authenticationType
string
id
string
isVerifiedEmail
boolean
Whether this user's email has been verified
idInt
integer
onboardingWebFinished
username
string
User's (SendHub line's) username
twilioPhoneNumberId
This is used internally and may be expanded upon or removed in the future
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
paymentScheduleIdInt
integer
Your plan's payment schedule type: 1. Monthly 2. Yearly 3. Consumable (eg. free trial)
idBoth
nullableStringRO
deletedNullable
boolean
userId
The ID of a SendHub user (an individual line)
loginRequest
object
4 properties
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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sendhub-authentication-api-openapi.yml Raw ↑

Other APIs SendHub publishes across the network.

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

This is an independent, third-party profile of SendHub Authentication 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.