Smartapp.com

Smartapp.com (1.0.0)

Download OpenAPI specification:Download

E-mail: contact@smartapp.com URL: mailto:contact@smartapp.com License: Apache 2.0 Terms of Service

company

operations about companies

Creates a new company object

Request
Request Body schema: application/json
name
required
string

Name of the company

website
string

Company websute URL (url should include protocol- http or https)

object

Additional information that you want to hook to your company object

Array of objects (companyLocation)

The locations can be an array of one or more locations. If the argument is not passed in, it will create the location by the name headquarters

Responses
200

Created a company

400

Invalid company name

402

company name '' already exists

post/company/create
Request samples
application/json
{
  • "name": "smartapp.com",
  • "website": "https://www.smartapp.com/",
  • "metadata": {
    },
  • "locations": [
    ]
}
Response samples
application/json
{
  • "name": "smartapp.com",
  • "uniqueID": "00000000-0000-0000-0000-000000000000",
  • "website": "smartapp.com",
  • "image": "https://www.smartapp.com/assets/images/logos/smartapplogo.svg",
  • "createdBy": {
    },
  • "modifiedBy": {
    },
  • "metadata": { },
  • "locations": [
    ]
}

Gets a company from its id

Retrieves the details of an existing company. You need to supply only the unique company identifier that was returned upon company creation

Request
query Parameters
UniqueID
required
string <uuid>

The unique identifier of the company to be retrieved

Example: UniqueID=0000-00000000-0000-000000000000
Responses
200

A Company Details object

400

Invalid companyId or Invalid company

get/company/get/uniqueid
Request samples
Response samples
application/json
{
  • "name": "smartapp.com",
  • "uniqueID": "00000000-0000-0000-0000-000000000000",
  • "website": "smartapp.com",
  • "image": "https://www.smartapp.com/assets/images/logos/smartapplogo.svg",
  • "createdBy": {
    },
  • "modifiedBy": {
    },
  • "metadata": { },
  • "locations": [
    ]
}
Gets a company from its name
Retrieves the details of an existing company. You need only supply the company name that was returned upon company creation


Request
path Parameters
name
required
string
Company name


 
 Example:  smartapp.com
Responses
200
A Company Details object


400
Invalid Company or Invalid company name


get/company/getbyname/{name}
Request samples
Response samples
application/json
{
  • "name": "smartapp.com",
  • "uniqueID": "00000000-0000-0000-0000-000000000000",
  • "website": "smartapp.com",
  • "image": "https://www.smartapp.com/assets/images/logos/smartapplogo.svg",
  • "createdBy": {
    },
  • "modifiedBy": {
    },
  • "metadata": { },
  • "locations": [
    ]
}
Retrieves the details of existing companies
Request
query Parameters
skip
integer
 Default:  0
Number of records to skip from the result set. If skip is not passed in then it will default to 0


 
 Example:  skip=10
take
integer
 Default:  25
Number of records to return from skip. If take is not passed in then it will default to 25


 
 Example:  take=10
Array of objects (companyFieldData) 
 
object (metadataFilterParams) 
 
Responses
200
Returns an array of company objects along with the total count of records


post/company/getbymetadata
Request samples
Response samples
application/json
{
  • "totalCount": 0,
  • "companies": [
    ]
}
Permanently deletes a company.
Permanently deletes a company. It cannot be undone. Also deletes all the additional information and locations on the company


Request
query Parameters
UniqueID
required
string <uuid> 
The unique identifier of the company to be deleted


 
 Example:  UniqueID=00000000-0000-0000-0000-000000000000
Responses
200
Deleted the company


400
Invalid CompanyId


post/company/delete/uniqueid
Request samples
Updates the specified company
Updates the specified company by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the website parameter, that becomes the company's website and is used in the future


Request
query Parameters
UniqueID
required
string <uuid> 
The unique identifier of the company to be updated


 
 Example:  UniqueID=00000000-0000-0000-0000-000000000000
name
string
 
 Example:  name=smartapp.com
website
string
 
 Example:  website=https://smartapp.com/
object
Additional information that you want to update


 
 Example:  sales office=false
Responses
200
company was updated


400
Invalid CompanyId or Invalid Company Name


402
Compnay name '' already exists


post/company/update
Request samples
Response samples
application/json
{
  • "name": "smartapp.com",
  • "uniqueID": "00000000-0000-0000-0000-000000000000",
  • "website": "smartapp.com",
  • "image": "https://www.smartapp.com/assets/images/logos/smartapplogo.svg",
  • "createdBy": {
    },
  • "modifiedBy": {
    },
  • "metadata": { },
  • "locations": [
    ]
}
Gets members of the specified company
Retrieves the detils of members of a specified company. You need to only supply the company identifier that was returned upon company creation.


Request
query Parameters
UniqueID
required
string <uuid> 
The unique identifier of the company for which you want to get list of members


 
 Example:  UniqueID=00000000-0000-0000-0000-000000000000
skip
integer
 Default:  0
Number of records to skip from the result set. If not passed in will default to 0


 
 Example:  skip=10
take
integer
 Default:  25
Number of records to return from skip, if not passed in will default to 25


 
 Example:  take=20
searchText
string
 
Responses
200
members listed


400
Invalid company id


get/company/members
Request samples
Response samples
application/json
{
  • "totalCount": 0,
  • "members": [
    ]
}
➔ Next to company location