GET api/v1/Company
Gets basic information about the user's company
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
fields |
Use this to only return the data fields you're interested in. Field names not found are ignored and no error is thrown. If no fields are found then the full object is returned. |
Collection of string |
None. |
suppressResponseCodes |
Some applications do wonky things if error codes are used. Use this to force 200s to always return. |
boolean |
None. |
APIKey |
This is your unique key that identifies you as the developer of this app. Required for all calls. |
string |
None. |
APIToken |
This is the user's session token generated when you authenticate the user |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
CompanyInfoName | Description | Type | Additional information |
---|---|---|---|
Name |
The Company's name |
string |
None. |
ImageURL |
The Company's logo |
string |
None. |
SecuritySettings |
The company's password requirements |
CompanySecurityInfo |
None. |
Response Formats
application/json, text/json
Sample:
{ "Name": "sample string 1", "ImageURL": "sample string 2", "SecuritySettings": { "PasswordMinLength": 1, "PasswordDuration": 1, "PasswordSpecialCharacters": "sample string 1", "PasswordMustHaveMixedCase": true, "PasswordMustHaveNumeric": true, "NumberOfPasswordsBeforeReuse": 1 } }