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

slug

required

URL-friendly unique slug identifier.

string

shortCode

Unique 4 to 6 character uppercase short code.

string

maxConcurrency

Maximum allowed concurrent SMS messaging connections.

integer

tcrStatus

The Campaign Registry (TCR) 10DLC registration status.

string

phoneNumber

Provisioned system phone number.

string

Example

{
  "id": "a1b2c3d4-e5f6-7890-abcd-1234567890ab",
  "name": "Community Food Pantry",
  "slug": "hope-community-center",
  "shortCode": "DCC",
  "maxConcurrency": 5,
  "tcrStatus": "APPROVED",
  "phoneNumber": "+17045550100"
}

401

Unauthorized

403

Forbidden