Get the current organization's details. Returns the organization associated with the API key used for authentication.

GET

https://host.com/v1/org

GET

/v1/org

1 const url = 'https://host.com/v1/org';
2 const options = {method: 'GET', headers: {'X-API-Key': '<apiKey>'}};
3 
4 try {
5   const response = await fetch(url, options);
6   const data = await response.json();
7   console.log(data);
8 } catch (error) {
9   console.error(error);
10 }

1 {
2   "id": "string",
3   "name": "string",
4   "twilioPhoneNumber": "string",
5   "verifiedPhoneNumber": "string",
6   "faqs": [
7     {
8       "id": "string",
9       "question": "string",
10       "answer": "string"
11     }
12   ],
13   "voiceSettings": {
14     "voice": "string",
15     "voiceProvider": "string",
16     "country": "string",
17     "languages": [
18       "string"
19     ]
20   },
21   "localization": "string",
22   "operationSchedule": {
23     "timeZone": "string",
24     "businessSchedule": [
25       {
26         "day": "sunday",
27         "hours": [
28           {
29             "start": "string",
30             "end": "string"
31           }
32         ]
33       }
34     ],
35     "outboundSchedule": [
36       {
37         "day": "sunday",
38         "hours": [
39           {
40             "start": "string",
41             "end": "string"
42           }
43         ]
44       }
45     ]
46   },
47   "isDemo": true,
48   "subscriptionStatus": "string",
49   "stripeId": "string",
50   "salesforceId": "string",
51   "accountOwner": {
52     "firstName": "string",
53     "lastName": "string",
54     "email": "string",
55     "phoneNumber": "string",
56     "extension": "string"
57   },
58   "address": {
59     "addressLine1": "string",
60     "addressLine2": "string",
61     "city": "string",
62     "state": "string",
63     "zipCode": "string"
64   },
65   "alternatePhoneNumbers": [
66     {
67       "value": "string",
68       "areaCode": {
69         "value": "string"
70       },
71       "countryCode": {
72         "value": "string"
73       }
74     }
75   ]
76 }

Authentication

X-API-Keystring

API Key authentication. Generate your API key in the Gail Portal under General > Integrations > API Keys.

Response

idstringformat: "uuid"

namestring or null

twilioPhoneNumberstring or null

verifiedPhoneNumberstring or null

faqslist of objects or null

voiceSettingsobjectOptional

localizationstring or nullOptional

operationScheduleobjectOptional

isDemobooleanOptional

subscriptionStatusstring or nullOptional

stripeIdstring or nullOptional

salesforceIdstring or nullOptional

accountOwnerobjectOptional

addressobjectOptional

alternatePhoneNumberslist of objects or nullOptional

Errors

404

Not Found Error