Table of Contents
In Supportable, a Company represents the organization or entity which holds the Supportable account. It is the highest-level subscriber. A Supportable account only ever contains a single Company record, and this Company is parent to one or more Sub-Entities.
You can obtain details about your Company by using the Company endpoint.
Sample Request #
Headers | Authorization = Bearer [token] |
Parameters | None |
Body | None |
Path #
GET https://connect.supportableapp.com/api/company
Sample Response JSON #
Status: 200
{ "id": "63119fd1c42741794219e7bb", "name": "Doing Business LLC", "shortName": "DOBIS", "dba": "DB", "website": "www.dobis.com", "address": { "address1": "Innovation Drive", "address2": null, "city": "Oak Park", "state": { "_id": "IL", "name": "Illinois" }, "zip": "60301", "county": null }, "contacts": [ { "_id": "1", "name": "Joe John Jenson", "email": "jjj@dobis.com", "phone": "1234567895", "isPrimary": true } ] }
Notes on Values #
Attribute | Data Type | Description |
---|---|---|
id | string | The unique identifier for the Company record. |
status | boolean | Indicates whether the Company is current active in Supportable. |
name | string | The full legal name of the Company. |
shortName | string | The shortened name of the Company, used in some areas of the application to conserve space. |
dba | string | “Doing business as,” the name under which the company does business, if different from the legal name of the company. |
website | string | The URL for the Company’s official website. |
address | object | The Company’s primary address. |
address.address1 | string | The first line of the Company’s address. |
address.address2 | string | The second line of the Company’s address. |
address.city | string | The city component of the Company’s address. |
address.state | object | The state component of the Company’s address. |
address.state.id | string | The 2-letter state code. |
address.state.name | string | The full name of the state. |
address.zip | string | The full 9-digit ZIP code (12345-0123) component of the Company’s address. |
address.county | string | The county component of the Company’s address. |
contacts | array of objects | The contacts through which representatives of Supportable may reach the Company. |
contacts.id | string | The unique identifier for the Company contact. |
contacts.name | string | The name of the contact. |
contacts.email | string | The contact’s email address. |
contacts.phone | string | The primary phone number for the contact. |
contacts.isPrimary | boolean | Whether this is the primary contact for the Company. (Note: A Company may have only one primary contact at a time). |