Retrieve the organization's settings

GET

/api/organizations/settings

const url = 'https://example.com/api/organizations/settings';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/organizations/settings \
  --header 'Authorization: Bearer <token>'

Authorizations

BearerAuth

Responses

200

Organization settings retrieved successfully

application/json

object

required

Unique identifier (UUID v4) for the resource.

string format: uuid

name

required

Full display name of the resource, facility, or individual.

string

legalName

Legal corporate entity name registered with the IRS for EIN tax verification and 10DLC compliance.

string

slug

required

URL-friendly unique slug identifier.

string

shortCode

Unique 4 to 6 character uppercase short code.

string

orgStatus

Lifecycle operational status of the organization tenant (ENABLED or DISABLED).

string

Allowed values: ENABLED DISABLED

maxConcurrency

Maximum allowed concurrent SMS messaging connections.

integer

tcrStatus

The Campaign Registry (TCR) 10DLC registration status.

string

tcrBrandStatus

Granular status of 10DLC Brand registration.

string

Allowed values: unregistered pending verified failed

tcrCampaignStatus

Granular status of 10DLC Campaign registration.

string

Allowed values: unregistered pending verified failed

phoneStatus

Granular status of phone number assignment.

string

Allowed values: unassigned reserved ordered assigned failed

profileStatus

Granular status of messaging profile and vault setup.

string

Allowed values: unconfigured active failed

tcrBrandId

Registered 10DLC Brand ID.

string

nullable

tcrCampaignId

Registered 10DLC Campaign ID.

string

nullable

provisioningError

Error message from the latest telephony provisioning attempt.

string

nullable

provisioningStepErrors

Map of individual step names to specific error details.

object

phoneNumber

Provisioned system phone number.

string

redirectPhoneNumber

Configured human operator redirect phone number.

string

einTaxId

Legal 501(c)(3) EIN Tax Identifier for 10DLC discount verification.

string

dailySmsCap

Maximum allowed outbound SMS dispatches per day.

integer

monthlySmsBudget

Monthly SMS dispatch cap budget.

integer

quietHoursEnabled

Whether non-emergency outbound messaging is paused during night hours.

boolean

quietHoursStart

Start time for quiet hours window (HH:mm).

string

quietHoursEnd

End time for quiet hours window (HH:mm).

string

bypassQuietHoursForEmergency

Whether emergency triage alerts bypass quiet hours.

boolean

smsSenderName

Brand display name prepended to outgoing broadcast SMS.

string

supportEmail

Support email populating automated HELP responses.

string

supportPhone

Support hotline phone populating automated HELP responses.

string

street

Physical street address line.

string

city

City name.

string

state

State or province code.

string

zip

ZIP or postal code.

string

legalStreet

Official registered physical headquarters address line matching IRS/state tax records.

string

legalCity

Official registered city matching IRS/state tax records.

string

legalState

Official registered two-letter state matching IRS/state tax records.

string

legalZip

Official registered ZIP postal code matching IRS/state tax records.

string

Example

{
  "id": "a1b2c3d4-e5f6-7890-abcd-1234567890ab",
  "name": "Community Food Pantry",
  "legalName": "Multiply Church, Inc.",
  "slug": "hope-community-center",
  "shortCode": "DCC",
  "orgStatus": "ENABLED",
  "maxConcurrency": 5,
  "tcrStatus": "APPROVED",
  "tcrBrandStatus": "unregistered",
  "tcrCampaignStatus": "unregistered",
  "phoneStatus": "unassigned",
  "profileStatus": "unconfigured",
  "tcrBrandId": "B1234567",
  "tcrCampaignId": "C1234567",
  "provisioningError": "Failed to create 10DLC brand: API error (402): Insufficient Funds",
  "phoneNumber": "+17045550100",
  "redirectPhoneNumber": "+18005550100",
  "einTaxId": "12-3456789",
  "dailySmsCap": 2000,
  "monthlySmsBudget": 50000,
  "quietHoursEnabled": true,
  "quietHoursStart": "21:00",
  "quietHoursEnd": "07:00",
  "bypassQuietHoursForEmergency": true,
  "smsSenderName": "DreamCenter",
  "supportEmail": "[email protected]",
  "supportPhone": "+17045550199",
  "street": "24 Junction Pkwy MEM",
  "city": "Concord",
  "state": "NC",
  "zip": "28027",
  "legalStreet": "280 Rone Avenue",
  "legalCity": "Concord",
  "legalState": "NC",
  "legalZip": "28025"
}

401

Unauthorized

403

Forbidden