Sign in

v1

latestSwagger 2.0Apache 2.02026-07-13123128517.6 KB
me

Find account details

Searches for the user account details. Details include name, email, and basic account permissions. For authentication use api credentials.

get/me/account

Query parameters

fieldsstring

Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at partial response page.

Response

successful operation

namestring

Name associated with an account

keystring

~

idinteger

An id of an account

statestring

~

addressstring

~

activeboolean

~

country'US' | 'CA'

~

createdstring date-time

~

allowedToCreateCampaignboolean

~

brand'EZTEXTING' | 'CLUBTEXTING' | 'GROUPTEXTING' | 'TELLMYCELL' | 'EZ' | 'CALLFIRE' | 'TESLA'

~

messageClassstring

~

industry'UNKNOWN' | 'ADVERTISING' | 'AGRICULTURE' | 'AUTOMOTIVE' | 'COLLECTIONS' | 'COMMUNICATION' | 'CONSTRUCTION' | 'CONSULTING' | 'DECLINE' | 'EDUCATION' | 'EMERGENCY' | 'ENERGY' | 'ENTERTAINMENT' | 'FINANCE' | 'FINANCIAL' | 'GAMBLING' | 'GOVERNMENT' | 'HOSPITALITY' | 'HEALTHFITNESS' | 'HEALTHCARE' | 'INSURANCE' | 'LEAD' | 'LEGAL' | 'MANUFACTURING' | 'NGO' | 'OTHER' | 'POLITICAL' | 'POSTAL' | 'PROFESSIONAL' | 'REAL_ESTATE' | 'RETAIL' | 'SEARCH_MARKETING' | 'TECHNOLOGY' | 'TELECOM' | 'TRANSPORTATION'

~

companyNamestring

~

trustLevel'LOCKED' | 'SUSPENDED' | 'PROBATION' | 'NORMAL' | 'TRUSTED'

~

agencyManagedAccountsboolean

~

outboundThresholdinteger

~

textOutboundThresholdinteger

~

ezboolean

~

countryOrDefault'US' | 'CA'

~

canceledOrArchivedOrDeletedboolean

~

defaultNumberIdinteger

~

autoAddDoNotContactboolean

~

apiCallLimitinteger

~

receiverPeriodEnabledboolean

~

receiverPeriodTimeUnit'NANOSECONDS' | 'MICROSECONDS' | 'MILLISECONDS' | 'SECONDS' | 'MINUTES' | 'HOURS' | 'DAYS'

~

receiverPeriodCallinteger

~

receiverPeriodGlobalinteger

~

receiverPeriodTextinteger

~

einstring

~

messageFlowsstring[]

~

entityType'SP' | 'COMPANY'

~

websitestring

~

startCapableboolean

~

sharedShortCodeIdinteger

~

canceledboolean

~

archivedboolean

~

retainOnlyMetadataboolean

~

retainOnlyMetadataLastDetailRecordIdinteger

~

citystring

~

zipcodestring

~

industryNamestring

~

uiContextstring

~

failedVerificationAttemptsinteger

~

sharedShortCodeAllowedboolean

~

defaultNotificationTtlMillisinteger

~

tsrAgreementstring date-time

~

tsrInitialsstring

~

maxAgentsinteger

~

retainOnlyMetadataLastModifiedstring date-time

~

universalboolean

~

status'ACTIVE' | 'PENDING_CANCELLED' | 'CANCELLED' | 'ARCHIVING' | 'ARCHIVED' | 'DELETING' | 'DELETED'

~