Maestrano Enterprise API
API Endpoint
https://api-hub.maestrano.com/api/mnoe/v1This documentation presents all the entities available on MNOE API, provided by Maestrano.
API V2
The V2 documentation may be found here.
API V1 Details
The section below presents the high level details of the V1 API.
Endpoint
The MNOE API production endpoint is available here: https://api-hub.maestrano.com
Path prefixing
All API path must be prefixed by: api/mnoe/v1/
Authentication
The MNOE APIs use HTTP basic authentication:
api_key: <your tenant API key>
api_secret: <your tenant API secret>
Postman
You may use our Postman Collection and Environment to help you in your testing.
Right Click “Save Link As…” to save the collection and the environment. You will have to edit the environment to change the Tenant Api Key and Secret.
Download Links:
-
Collection: mnohub_api_v1.postman_collection.json
-
Environment: mnohub_api_v1.postman_environment.json
More documentation about:
API | Querying ¶
Resources collection ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/:collection_name
Responses
Body
{
"data": [
{
"id": 1,
"uid": "org-fbba",
"name": "x4d3\n Company",
"created_at": "2016-08-25T10:08:37Z",
"updated_at": "2016-08-25T10:17:19Z",
"account_frozen": false,
"soa_enabled": true,
"mails": null,
"logo": null,
"latitude": 0,
"longitude": 0,
"geo_country_code": null,
"geo_state_code": null,
"geo_city": null,
"geo_tz": null,
"geo_currency": null,
"meta_data": null,
"industry": null,
"size": null,
"has_myob_essentials_only?": false,
"billing_currency": "USD",
"financial_year_end_month": 6,
"current_billing": {
"cents": 0,
"currency": "USD"
}, ...Resources collectionGET/:collection_name
To retrieve a collection of resources, an HTTP GET request is issued agains the resources endpoint. By default, only the first 100 elements of the collection ordered by creation date are returned. Refer to the filter and pagination section below for more details.
To retrieve the list of organizations the following request is sent
GET /organizationsSingle Resource ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/:collection_name/:id
Responses
Body
{
"data": {
"id": 1,
"uid": "org-fbba",
"name": "x4d3\n Company",
"created_at": "2016-08-25T10:08:37Z",
"updated_at": "2016-08-25T10:17:19Z",
"account_frozen": false,
"soa_enabled": true,
"mails": null,
"logo": null,
"latitude": 0,
"longitude": 0,
"geo_country_code": null,
"geo_state_code": null,
"geo_city": null,
"geo_tz": null,
"geo_currency": null,
"meta_data": null,
"industry": null,
"size": null,
"has_myob_essentials_only?": false,
"billing_currency": "USD",
"financial_year_end_month": 6,
"current_billing": {
"cents": 0,
"currency": "USD"
},
"current_credit": {
"cents": 0,
"currency": "AUD"
},...Single ResourceGET/:collection_name/:id
To fetch a single resource by its unique identifier, a GET request against the resource URL can be sent.
GET /organizations/5Children Resource ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/:parent_entity/:parent_entity_id/:collection_name/:id
Responses
Body
{
"data": [
{
"id": 1,
"uid": "vtiger6.app.dev.maestrano.io",
"name": "Vtiger",
"status": "running",
"app_id": 1,
"created_at": "2016-08-25T10:08:39Z",
"updated_at": "2016-08-25T10:08:39Z",
"started_at": null,
"stack": "cube",
"terminated_at": null,
"stopped_at": null,
"billing_type": "hourly",
"autostop_at": null,
"autostop_interval": null,
"next_status": null,
"soa_enabled": true,
"http_url": null,
"durations": {
"provisioning": 60,
"starting": 30,
"stopping": 20,
"terminating": 30
},
"owner_id": 1
}
]
}Children ResourceGET/:parent_entity/:parent_entity_id/:collection_name/:id
To fetch a nested resource, all you need is to provide the parent entity name and the parent entity id.
For example
GET /organizations/1/app_instancesPagination ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/:collection_name?limit=100&skip=10
PaginationGET/:collection_name?limit=100&skip=10
When retrieving a collection of resources, you may paginate your calls.
-
skip the index of the first element
-
limit the number of returned elements
The pagination details are returned when fetching a collection.
Ordering ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/:collection_name?sort[]=stack.asc&sort[]=name.asc
OrderingGET/:collection_name?sort[]=stack.asc&sort[]=name.asc
You may order the result by providing a sort array, containing a list of [FIELD_NAME].asc|desc For example:
-
name.asc
-
stack.desc
-
created_at.desc
Examples:
Request to fetch the first 10 Organizations (response provided)
GET /organization?limit=10Request to retrieve the last created Organizations
GET /organizations?limit=1&sort[]=created_at.descRequest to retrieve the Organizations from index 10 to 19 ordered by name
GET /organizations?limit=10&skip=10&sort[]=name.ascFiltering ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/:collection_name?filter[:filter_option]=:value
FilteringGET/:collection_name?filter[:filter_option]=:value
To filter a request on the collection of resources, the filter URL parameter can be specified. The following criteria are currently supported:
:filter_option may be equal to:
-
field: the request will be filtered for the lines which field is equal to the value -
field.operation: where operation may be:- eq : attribute must be equal to value
- ne : attribute must be not equal to value
- gte : attribute must be greater or equal to value
- gt : attribute must be greater to value
- lt : attribute must be lower than value
- lte : attribute must be lower or equal to value
- like : attribute must be like to value (for example “%somevalue%”)
- in : attribute must be in the collection
- nin : attribute must be not in the collection
Examples:
Retrieve the Organizations having a billing_currency in USD
GET /organizations?filter[billing_currency]=USDRetrieve the Invoices that are at status “DRAFT”
GET /invoices?filter[status]=DRAFTRetrieve the Organization that have a latitude greater than 2000 and have a name starting from a letter a to x
GET /organizations?filter[latitude.gt]=200&filter[name.lte]=xRetrieve the Invoices that where created before the 1985-09-17T20:00:00
GET /invoices?filter[created_at.lt]=1985-09-17T20:00:00Retrieve the Users with a name containing “jo”
GET /users?filter[name.like]=%25jo%25Retrieve the organizations with a name that is in the list[“Corporate Name”, “Maker Association”]
GET /organizations?filter[name.in][]=Corporate Name&filter[name.in][]=Maker AssociationAPI | Save Data ¶
Resource creation ¶
POST https://api-hub.maestrano.com/api/mnoe/v1/:collection_name
Resource creationPOST/:collection_name
To create a new resource, an HTTP POST request is issued against the resource collection endpoint. The payload of the request must contain the resource attributes as described in the resources schemas in the sections below.
To create a resource of type organizations the following request can be sent:
POST /organizationswith the following payload:
{
"data": {
"name": "demo"
}
}Resource update ¶
PUT https://api-hub.maestrano.com/api/mnoe/v1/:collection_name/:id
Requests
Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"name": "demo2"
}
}Responses
Body
{
"data": {
"id": 3,
"uid": "org-fbbw",
"name": "new-value",
"created_at": "2016-08-25T12:12:35Z",
"updated_at": "2016-08-25T12:21:53Z",
"account_frozen": false,
"soa_enabled": true,
"mails": null,
"logo": null,
"latitude": 0,
"longitude": 0,
"geo_country_code": null,
"geo_state_code": null,
"geo_city": null,
"geo_tz": null,
"geo_currency": null,
Headers
Content-Type: application/vnd.api+jsonBody
{
"errors": [
{
"id": "a5cd9eb0-4ced-0134-6081-305adaeda98c",
"href": "http://maestrano.github.io/maestrano-hub/#organizations-organization-put",
"status": "404",
"code": "resource-not-found",
"title": "Resource not found",
"detail": "Resource not found"
}
]
}Resource updatePUT/:collection_name/:id
To update a resource, an HTTP PUT request is issued against the single resource endpoint. The payload of the request must contain the resource attributes as described in the resources schemas in the sections below.
To update a resource of type organizations with the id 22 the following request can be sent:
PUT /organizations/22with the following payload:
{
"data": {
"name": "demo2"
}
}Common Workflows ¶
Maestrano Model
-
Maestrano model contains User and Organizations/Companies.
-
An organization may contains several users and a user may be in multiple organizations.
-
A user has a role inside an organization.
User Roles
-
Super Admin: has all power within the company including access to billing management
-
Admin: can manage other members (except Super Admin users) and manage the company apps
-
Power User: can see other members and start idle company apps
-
Member: can see other members and access the company apps
Create Users and Organizations
Create User directly linked to Organization
The best way to create a user directly linked to the company is to use the orga_on_create field when creating a User.
{
"data": {
"name": "Bob",
"surname": "Partridge",
"email": "bob.partridge@test.com",
"orga_on_create": true,
"company": "Bob's Company"
}
}This will automatically create the Organization “Bob’s Company” and the user “Bob Partrige” as a Super Admin of the company.
Add other Users to the Organization
In order to add user to an organization, Use this call:
{
"data": {
"id": 9, // The id of the user
"role": "Power User" // The role of the user
}
}Change User role
In order to add user to add user to an organization, Use this call:
Update User’s role in an organization
{
"data": {
"role": "Member"
}
}Remove User from an Organization
Create a User
Invite the user via email
When user invite other users, we advice to send an mail only containing a confirmation_token. The User should then update his password himself.
You should never send password via email.
Generate a confirmation_token randomly, for example: Bfb7zVWMxU7y6QYxZkZC. Create the user with the confirmation_token and set confirmation_sent_at to the current time.
{
"data": {
"name": "Bob",
"surname": "Partridge",
"email": "bob.partridge@test.com",
"password": "HisPassword",
"company": "Bob's Company",
"confirmation_token": "Bfb7zVWMxU7y6QYxZkZC",
"confirmation_sent_at": "2016-09-13T16:28:40"
}
}Send an email to your newly created user containing a link containing the confirmation_token.
For example: http://platform.com/mnoe/auth/users/confirmation?confirmation_token=Bfb7zVWMxU7y6QYxZkZC
The user clicks on the link the request contains the confirmation_token parameters. Extract that parameter and retrieve the user by confirmation_token:
GET /users?$limit=1&filter[confirmation_token]=Bfb7zVWMxU7y6QYxZkZCYou may check that the confirmation_sent_at is not too old. (for example less than 3 days) before proceeding.
The user can decide his password.
{
"data": {
"password": "HisChosenPassword"
}
}Directly create the user with a password
Use this option if you would like users to give their details and password when they create an account on the platform.
{
"data": {
"name": "Bob",
"surname": "Partridge",
"email": "bob.partridge@test.com",
"password": "HisPassword",
"company": "Bob's Company"
}
}Provision an App for an Organization
In order to provision an application for an Organization, you should first list the list of available applications and extract their nid.
{ “data”: { “product”: “vtiger6” //product nid } }
Apps ¶
Describe an app available on Maestrano
Apps List ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/apps
Responses
Body
{
"data": [
{
"id": 12,
"nid": "orangehrm",
"uid": null,
"name": "OrangeHRM",
"description": "<p>OrangeHRM is a precise and convenient HR Management (HRM) system targeted for Small and Medium Enterprises. The functionality includes employee information management, employee absence management, recruitment management, employee performance evaluation, leaves management, reporting lines management and many other HR management tools. Orange HRM also provides Expense tracker, timesheets, leave calendar, notifications and exports to Microsoft Excel (CSV extractor) for reports, leave and recruitment details.</p>\n\n<p>More than 1 million users worldwide trust this HR application. It is an all-in-one solution to manage your workforce, thanks to the various management modules already included in the tool: employee information, employee absence, recruitment, employee performance evaluation and other HR management tools.</p>\n\n<p>The application is simple and intuitive and will deliver awesome results which will allow you to have a better understanding of the status of your workforce and help manage better your most critical resource - your people!</p>\n\n<p>Added to the peace of mind of a deployment by Maestrano, you are all set and guaranteed to have the best tool, always up to date.</p>\n",
"created_at": "2012-11-17T05:49:55Z",
"updated_at": "2017-03-09T08:19:38Z",
"logo": "//cdn.maestrano.com/web/mno/uploads/app/logo/12/orangehrm.png",
"website": "http://www.orangehrm.com",
"slug": "12-orangehrm",
"categories": [
"Human Resources Information System (HRIS)"
],
"key_benefits": [
"Easily manage your employees' information, performance and etc. with one system",
"Affordable, flexible and streamline Human Resource system",
"Simplify your recruitment process"
],
"key_features": [
"Intuitive dashboard",
"Time & Attendance Management",
"Personal Information Management",
"Recruitment",
"Leave/Time Off management",
"Performance & KPI Management"
],
"testimonials": [
{
"author": "Susie Macmillan",
"company": "Da Vinci ",
"text": "Da Vinci marketing was looking for a simple HR online portal that would provide \"Self service\" for our employees for tracking leave and time on projects OrangeHRM has proven to be simple, reliable and easy to use for both management and staff."
},
{
"author": "Michael C. Brown",
"company": "InHouse Techies",
"text": "Inhouse Techies have recommended OrangeHRM to our clients for their HRIS needs. The open source version is ideal for SME's while more advanced features can be added in the form of add-ons. The application has helped us a great deal in maintaining a comprehensive employee database and managing expiration dates related to various memberships and licenses of our client and its employees. The system is easy to use and we would recommend OrangeHRM for any business industries."
}
],
"worldwide_usage": 770000,
"tiny_description": "Manage your employees easily",
"stack": "cube",
"terms_url": "http://www.gnu.org/licenses/gpl-2.0.html",
"pictures": [
"//cdn.maestrano.com/web/mno/uploads/dyn_assets/pictures/57696/content_content_OrangeHR1.JPG",
"//cdn.maestrano.com/web/mno/uploads/dyn_assets/pictures/57727/content_content_OrangeHR_3.JPG",
"//cdn.maestrano.com/web/mno/uploads/dyn_assets/pictures/57760/content_content_OrangeHR_6.JPG",
"//cdn.maestrano.com/web/mno/uploads/dyn_assets/pictures/57788/content_content_OrangeHR_4.JPG",
"//cdn.maestrano.com/web/mno/uploads/dyn_assets/pictures/57809/content_content_OrangeHR_2.JPG"
],
"tags": "[\"Orange HRM\", \"Human Resources\", \"Human Resources Management\", \"HR Management\", \"HR System\", \"HR Tools\", \"Leaves Tracker\", \"Resources Management\", \"Hiring System\", \"Hire\", \"People\", \"Workforce Management\"]",
"pricing_plans": {
"AUD": [
{
"name": "First user",
"price": {
"value": 123,
"options": {
"symbol": "$",
"decimal": ".",
"thousand": ",",
"precision": 2,
"format": "%s%v",
"subunit_symbol": "c",
"subunit_format": "%v%s",
"subunit_to_unit": 100
}
},
"currency": "AUD",
"factor": "/month"
},
{
"name": "Additional user",
"price": {
"value": 123,
"options": {
"symbol": "$",
"decimal": ".",
"thousand": ",",
"precision": 2,
"format": "%s%v",
"subunit_symbol": "c",
"subunit_format": "%v%s",
"subunit_to_unit": 100
}
},
"currency": "AUD",
"factor": "/month",
"description": "Invite your colleagues to use this application"
}
],
"USD": [
{
"name": "First user",
"price": {
"value": 123,
"options": {
"symbol": "$",
"decimal": ".",
"thousand": ",",
"precision": 2,
"format": "%s%v",
"subunit_symbol": "c",
"subunit_format": "%v%s",
"subunit_to_unit": 100
}
},
"currency": "USD",
"factor": "/month"
},
{
"name": "Additional user",
"price": {
"value": 123,
"options": {
"symbol": "$",
"decimal": ".",
"thousand": ",",
"precision": 2,
"format": "%s%v",
"subunit_symbol": "c",
"subunit_format": "%v%s",
"subunit_to_unit": 100
}
},
"currency": "USD",
"factor": "/month",
"description": "Invite your colleagues to use this application"
}
],
"default": [
{
"name": "First user",
"price": {
"value": 10,
"options": {
"symbol": "$",
"decimal": ".",
"thousand": ",",
"precision": 2,
"format": "%s%v",
"subunit_symbol": "c",
"subunit_format": "%v%s",
"subunit_to_unit": 100
}
},
"currency": "USD",
"factor": "/month"
},
{
"name": "Additional user",
"price": {
"value": 10,
"options": {
"symbol": "$",
"decimal": ".",
"thousand": ",",
"precision": 2,
"format": "%s%v",
"subunit_symbol": "c",
"subunit_format": "%v%s",
"subunit_to_unit": 100
}
},
"currency": "USD",
"factor": "/month",
"description": "Invite your colleagues to use this application"
}
]
},
"trademark": "OrangeHRM is a registered trademark of OrangeHRM in the United States, the European Union and other countries.",
"active": true,
"appinfo": {
"responsive": false,
"starReady": false,
"connecReady": false,
"differentPrice": false,
"new": false,
"popular": false,
"single_billing": false
},
"api_key": null,
"metadata_url": "http://www.orangehrm.com/maestrano/metadata",
"metadata": {
"environment": "orangehrm",
"app": {
"host": null
},
"api": {
"host": "https://api-hub.maestrano.com",
"base": "/api/v1/"
},
"sso": {
"init_path": null,
"consume_path": null,
"idp": "https://api-hub.maestrano.com",
"x509_fingerprint": "[FINGERPRINT]",
"x509_certificate": "[CERTIFICATE]"
},
"connec": {
"host": "https://api-connec.maestrano.com"
},
"webhook": {
"account": {
"groups_path": null,
"group_users_path": null
},
"connec": {
"initialization_path": null,
"notifications_path": null
}
}
},
"rank": 1500,
"multi_instantiable": false,
"details": {
"environment": "orangehrm",
"app": {
"host": null
},
"api": {
"host": "https://api-hub.maestrano.com",
"base": "/api/v1/"
},
"sso": {
"init_path": null,
"consume_path": null,
"idp": "https://api-hub.maestrano.com",
"x509_fingerprint": "[FINGERPRINT]",
"x509_certificate": "[CERTIFICATE]"
},
"connec": {
"host": "https://api-connec.maestrano.com"
},
"webhook": {
"account": {
"groups_path": null,
"group_users_path": null
},
"connec": {
"initialization_path": null,
"notifications_path": null
}
}
},
"subcategories": [],
"average_rating": null,
"running_instances_count": 1
}
],
"metadata": {
"pagination": {
"count": 21,
"skip": 0,
"limit": 0
}
}
}Get AppsGET/apps
Get the list of apps in an array.
App Instances ¶
Attributes
-
id ID - read-only
-
uid UUID - read-only
-
name Name of the app
-
status An App Instance can have 3 status: “running”, “stopped” or “terminated”
-
app The description of the App - read-only (See Apps]
-
owner The owner of the App Instance, most likely an Organization (See Organizations]
-
created_at Time of creation
-
updated_at Time of last update
-
started_at Time of last start
-
stack Type of the app, it can be: “cloud”, “cube” or “connector”
-
terminated_at Time of the termination
-
stopped_at Time of last stop
-
billing_type Type of the billing, default:“monthly”
-
autostop_at Time of the planned stop
-
autostop_interval Interval of the planned stop
-
next_status The next status the app will have after performing the current action
-
soa_enabled Service-oriented architecture state
-
http_url Url on which it can be reached
App Instances ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/app_instances
Responses
Body
{
"data": [
{
"id": 1,
"uid": "cld-9p9y",
"name": "Demo App",
"status": "terminated",
"app_id": 25,
"created_at": "2016-06-23T14:21:36Z",
"updated_at": "2016-07-19T10:52:05Z",
"started_at": null,
"stack": "cloud",
"terminated_at": "2016-07-19T10:52:05Z",
"stopped_at": null,
"billing_type": null,
"autostop_at": null,
"autostop_interval": null,
"next_status": null,
"soa_enabled": true,
"http_url": "https://demo.com/maestrano/auth/saml/init/default?group_id=cld-9p9y",
"durations": {
"provisioning": 120,
"starting": 90,
"stopping": 60,
"terminating": 40
},
"app": {
"id": 25,
"nid": "demo",
"uid": "app-15uz",
"name": "Demo App",
"description": "Use it for demo purpose.",
"created_at": "2016-06-23T10:05:26Z",
"updated_at": "2016-06-23T10:05:26Z",
"logo": "http://localhost:3000/assets/fallback/default_app_logo-f08ad534dcbbefd196d1556356b2513f175a0af89100ea39ecdae842a364c5b2.jpg",
"website": null,
"slug": "25-demo-app",
"categories": [
"Operations Management"
],
"key_benefits": [],
"key_features": [],
"testimonials": null,
"worldwide_usage": null,
"tiny_description": "Demo Application",
"stack": "cloud",
"terms_url": null,
"pictures": [],
"tags": null,
"pricing_plans": {
"default": null
},
"active": true,
"appinfo": null,
"api_key": "b8767cbafbf4e4d5d790a7b11e456de1bd8669db8c8fde09a43edbf76e2b2ff9",
"metadata_url": null,
"metadata": {
"sso": {
"enabled": true,
"idm": "https://demo.com",
"init_path": "/maestrano/auth/saml/init/default"
}
},
"rank": null,
"details": {
"sso": {
"enabled": true,
"idm": "https://demo.com",
"init_path": "/maestrano/auth/saml/init/default"
}
}
},
"owner": {
"id": 3,
"uid": "org-fbbw",
"name": "Xade",
"created_at": "2016-06-23T14:18:35Z",
"updated_at": "2016-08-02T12:25:32Z",
"account_frozen": false,
"soa_enabled": true,
"mails": null,
"logo": null,
"latitude": 0,
"longitude": 0,
"geo_country_code": null,
"geo_state_code": null,
"geo_city": null,
"geo_tz": "America/Los_Angeles",
"geo_currency": "USD",
"meta_data": null,
"industry": null,
"size": null,
"has_myob_essentials_only?": false,
"billing_currency": "USD",
"financial_year_end_month": 6,
"current_billing": {
"cents": 0,
"currency": "USD"
},
"current_credit": {
"cents": 0,
"currency": "AUD"
}
}
}
],
"metadata": {
"pagination": {
"count": 4,
"skip": 0,
"limit": 0
}
}
}Get App InstancesGET/app_instances
Get the list of application instances.
App Instance ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/app_instances/42
Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 5048,
"uid": "pec.mcube.co",
"name": "vTiger",
"status": "terminated",
"app_id": 73,
"created_at": "2015-06-01T12:21:37Z",
"updated_at": "2015-07-08T14:48:12Z",
"started_at": "2015-07-08T14:12:59Z",
"stack": "cube",
"terminated_at": "2015-07-08T14:47:50Z",
"stopped_at": "2015-06-15T05:16:23Z",
"billing_type": "monthly",
"autostop_at": null,
"autostop_interval": null,
"next_status": "terminated",
"soa_enabled": true,
"http_url": "https://pec.mcube.co",
"durations": {
"provisioning": 90,
"starting": 30,
"stopping": 20,
"terminating": 20
},
"owner_id": 3541
}
}Get App InstanceGET/app_instances/{id}
Get a single App Instance.
URI Parameters
- id
integer(required) Example: 42The app instance ID
PUT https://api-hub.maestrano.com/api/mnoe/v1/app_instances/42
Requests
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"name": "Another Name"
}
}Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 5048,
"uid": "pec.mcube.co",
"name": "vTiger",
"status": "terminated",
"app_id": 73,
"created_at": "2015-06-01T12:21:37Z",
"updated_at": "2015-07-08T14:48:12Z",
"started_at": "2015-07-08T14:12:59Z",
"stack": "cube",
"terminated_at": "2015-07-08T14:47:50Z",
"stopped_at": "2015-06-15T05:16:23Z",
"billing_type": "monthly",
"autostop_at": null,
"autostop_interval": null,
"next_status": "terminated",
"soa_enabled": true,
"http_url": "https://pec.mcube.co",
"durations": {
"provisioning": 90,
"starting": 30,
"stopping": 20,
"terminating": 20
},
"owner_id": 3541
}
}Update an App InstancePUT/app_instances/{id}
Update a single App Instance.
URI Parameters
- id
integer(required) Example: 42The app instance ID
Organization App Instances ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/organizations/1/app_instances
Responses
Body
{
"data": [
{
"id": 1,
"uid": "cld-9p9y",
"name": "Demo App",
"status": "terminated",
"app_id": 25,
"created_at": "2016-06-23T14:21:36Z",
"updated_at": "2016-07-19T10:52:05Z",
"started_at": null,
"stack": "cloud",
"terminated_at": "2016-07-19T10:52:05Z",
"stopped_at": null,
"billing_type": null,
"autostop_at": null,
"autostop_interval": null,
"next_status": null,
"soa_enabled": true,
"http_url": "https://demo.com/maestrano/auth/saml/init/default?group_id=cld-9p9y",
"durations": {
"provisioning": 120,
"starting": 90,
"stopping": 60,
"terminating": 40
},
"app": {
"id": 25,
"nid": "demo",
"uid": "app-15uz",
"name": "Demo App",
"description": "Use it for demo purpose.",
"created_at": "2016-06-23T10:05:26Z",
"updated_at": "2016-06-23T10:05:26Z",
"logo": "http://localhost:3000/assets/fallback/default_app_logo-f08ad534dcbbefd196d1556356b2513f175a0af89100ea39ecdae842a364c5b2.jpg",
"website": null,
"slug": "25-demo-app",
"categories": [
"Operations Management"
],
"key_benefits": [],
"key_features": [],
"testimonials": null,
"worldwide_usage": null,
"tiny_description": "Demo Application",
"stack": "cloud",
"terms_url": null,
"pictures": [],
"tags": null,
"pricing_plans": {
"default": null
},
"active": true,
"appinfo": null,
"api_key": "b8767cbafbf4e4d5d790a7b11e456de1bd8669db8c8fde09a43edbf76e2b2ff9",
"metadata_url": null,
"metadata": {
"sso": {
"enabled": true,
"idm": "https://demo.com",
"init_path": "/maestrano/auth/saml/init/default"
}
},
"rank": null,
"details": {
"sso": {
"enabled": true,
"idm": "https://demo.com",
"init_path": "/maestrano/auth/saml/init/default"
}
}
},
"owner": {
"id": 3,
"uid": "org-fbbw",
"name": "Xade",
"created_at": "2016-06-23T14:18:35Z",
"updated_at": "2016-08-02T12:25:32Z",
"account_frozen": false,
"soa_enabled": true,
"mails": null,
"logo": null,
"latitude": 0,
"longitude": 0,
"geo_country_code": null,
"geo_state_code": null,
"geo_city": null,
"geo_tz": "America/Los_Angeles",
"geo_currency": "USD",
"meta_data": null,
"industry": null,
"size": null,
"has_myob_essentials_only?": false,
"billing_currency": "USD",
"financial_year_end_month": 6,
"current_billing": {
"cents": 0,
"currency": "USD"
},
"current_credit": {
"cents": 0,
"currency": "AUD"
}
}
}
],
"metadata": {
"pagination": {
"count": 4,
"skip": 0,
"limit": 0
}
}
}Get Organization App InstancesGET/organizations/{organization_id}/app_instances
Get the list of app instances.
URI Parameters
- organization_id
string(required) Example: 1The organization ID
POST https://api-hub.maestrano.com/api/mnoe/v1/organizations/1/app_instances
Requests
Body
{
"data": {
"product": "demo"
}
}Responses
Body
{
"data": {
"id": 28,
"uid": "cld-9pfb",
"name": "Demo App",
"status": "running",
"app_id": 25,
"created_at": "2016-08-25T12:34:02Z",
"updated_at": "2016-08-25T12:34:02Z",
"started_at": null,
"stack": "cloud",
"terminated_at": null,
"stopped_at": null,
"billing_type": null,
"autostop_at": null,
"autostop_interval": null,
"next_status": null,
"soa_enabled": true,
"http_url": "https://demo.com/maestrano/auth/saml/init/default?group_id=cld-9pfb",
"durations": {
"provisioning": 120,
"starting": 90,
"stopping": 60,
"terminating": 40
},
"owner_id": 3
}
}Create Organization New App InstancePOST/organizations/{organization_id}/app_instances
Create a new app instance.
URI Parameters
- organization_id
string(required) Example: 1The organization ID
Organization App Instance ¶
PUT https://api-hub.maestrano.com/api/mnoe/v1/organizations/1/app_instances/42
Requests
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"name": "Another Name"
}
}Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 5048,
"uid": "pec.mcube.co",
"name": "vTiger",
"status": "terminated",
"app_id": 73,
"created_at": "2015-06-01T12:21:37Z",
"updated_at": "2015-07-08T14:48:12Z",
"started_at": "2015-07-08T14:12:59Z",
"stack": "cube",
"terminated_at": "2015-07-08T14:47:50Z",
"stopped_at": "2015-06-15T05:16:23Z",
"billing_type": "monthly",
"autostop_at": null,
"autostop_interval": null,
"next_status": "terminated",
"soa_enabled": true,
"http_url": "https://pec.mcube.co",
"durations": {
"provisioning": 90,
"starting": 30,
"stopping": 20,
"terminating": 20
},
"owner_id": 3541
}
}Update an Organization App InstancePUT/organizations/{organization_id}/app_instances/{id}
Update a single App Instance.
URI Parameters
- organization_id
string(required) Example: 1The organization ID
- id
integer(required) Example: 42The app instance ID
App Instances Sync ¶
Attributes
- connectors Array of the applications synchronisation status. They contain the fields:
- uid the uid of the application instance being synchronised
- name the name of the application instance being synchronised
- status the current status of the synchronisation
- message the message of the last synchronisation
- last_sync_date the last time the application was synchronised
App Instances Sync ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/organizations/1/app_instance_syncs
Responses
Body
{
"data": {
"connectors": [
{
"name": "name",
"status": "FAILED",
"message": "Could not get synchronisation status.",
"last_sync_date": null
}
]
},
"metadata": {
"pagination": {
"count": 1,
"skip": 0,
"limit": 0
}
}
}Get App Instances SyncGET/organizations/{organization_id}/app_instance_syncs
Get the list of application instances.
URI Parameters
- organization_id
string(required) Example: 1The organization ID
POST https://api-hub.maestrano.com/api/mnoe/v1/organizations/1/app_instance_syncs
Requests
Body
{}Responses
Body
{
"data": {
"connectors": [
{
"name": "name",
"status": "FAILED",
"message": "Could not get synchronisation status.",
"last_sync_date": null
}
]
},
"metadata": {
"pagination": {
"count": 1,
"skip": 0,
"limit": 0
}
}
}Trigger New SynchronisationPOST/organizations/{organization_id}/app_instance_syncs
Trigger a new Synchronisation.
URI Parameters
- organization_id
string(required) Example: 1The organization ID
Audit Event ¶
Attribute
-
ID ID of the audit event
-
key Event key
-
user_id User ID of the event
-
description Description of the event
-
metadata Metadata related to the event
-
subject_type Type of the event’ subject
-
subject_id ID of the event’ subject
-
created_ad Date of the event
-
user Description of the user
-
details Details of the user
Audit Event List ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/audit_events
Responses
Body
{
"data": [
{
"id": 1,
"key": "user_login",
"user_id": 1,
"description": "User login",
"metadata": "git@xade.eu",
"subject_type": "MnoEnterprise::User",
"subject_id": 1,
"created_at": "2016-08-25T13:15:47Z",
"user": {
"name": "x4d3\n",
"surname": "x4d3\n"
},
"details": "git@xade.eu"
}
],
"metadata": {
"pagination": {
"count": 1,
"skip": 0,
"limit": 0
}
}
}Get Audit EventsGET/audit_events
Get the list of arrears situations.
Arrears Situations ¶
Attribute
-
ID id of the arrear
-
status Status of the arrear: “pending”, “performing”, “performed”, “resolved”, “cancelled”
-
category Category of the arrear: “credit_expired”, “payment_failed”, “free_trial_expired”
-
name Name of the owner of the arrear
Arrears Situation List ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/arrears_situation
Responses
Body
{
"data": [
{
"id": 2,
"status": "pending",
"category": "credit_expired",
"name": "x4d3\n Company"
}
],
"metadata": {
"pagination": {
"count": 1,
"skip": 0,
"limit": 0
}
}
}Get Arrears SituationGET/arrears_situation
Get the list of events.
Credit Card ¶
Attributes
-
id ID - read-only
-
created_at Date of create
-
updated_at Date of last update
-
title Title of the customer
-
first_name First name on the card
-
last_name Last name on the card
-
country Country of delivery
-
masked_number Credit Card number masked except last 4 numbers
-
number Credit Card number
-
month Month of expiration
-
year Year of expiration
-
billing_address Customer billing address
-
billing_city Customer billing city
-
billing_postcode Customer billing post code
-
billing_country Customer billing country
-
verification_value Verification code
-
organization_id Id of the linked organization
Credit Card ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/organizations/1/credit_card
Responses
Body
{
"data": {
"id": 1,
"created_at": "2015-07-08T02:41:34Z",
"updated_at": "2015-09-30T02:34:32Z",
"title": "Mr.",
"first_name": "John",
"last_name": "Doe",
"country": "AU",
"masked_number": "XXXX-XXXX-XXXX-1111",
"number": null,
"month": 10,
"year": 2015,
"billing_address": "46 Market Street",
"billing_city": "albuquerque",
"billing_postcode": "2000",
"billing_country": "AU",
"verification_value": null,
"organization_id": 1
},
"metadata": {
"pagination": {
"count": 1,
"skip": 0,
"limit": 0
}
}
}Get Credit CardGET/organizations/{organization_id}/credit_card
Get the organization credit card.
URI Parameters
- organization_id
string(required) Example: 1The organization ID
POST https://api-hub.maestrano.com/api/mnoe/v1/organizations/1/credit_card
Requests
Body
{
"data": [
{
"id": 23,
"nid": "connector-salesforce",
"uid": "app-15un",
"name": "SalesForce",
"description": null,
"created_at": "2016-02-16T23:58:19Z",
"updated_at": "2016-02-16T23:58:19Z",
"logo": "http://localhost:3000/assets/fallback/default_app_logo-f08ad534dcbbefd196d1556356b2513f175a0af89100ea39ecdae842a364c5b2.jpg",
"website": "http://www.salesforce.com",
"slug": "23-salesforce",
"categories": [
"Customer Management",
"Collaboration"
],
"key_benefits": [],
"key_features": [],
"testimonials": null,
"worldwide_usage": null,
"tiny_description": "Track and organize your business sales",
"stack": "cloud",
"terms_url": null,
"pictures": [],
"tags": null,
"pricing_plans": {
"default": null
},
"active": true,
"appinfo": null,
"api_key": "44bf3aa60e43f0022da5d6ce759c4e2413ac298c76c84f7ce8b57c19b8b49a52",
"metadata_url": "http://www.salesforce.com/maestrano/metadata",
"metadata": {
"sso": {
"enabled": true,
"idm": "https://connector-salesforce.com",
"init_path": "/maestrano/auth/saml/init/default"
}
},
"details": {
"sso": {
"enabled": true,
"idm": "https://connector-salesforce.com",
"init_path": "/maestrano/auth/saml/init/default"
}
}
}
],
"metadata": {
"pagination": {
"count": 21,
"skip": 0,
"limit": 0
}
}
}Responses
Add New Credit CardPOST/organizations/{organization_id}/credit_card
Create a credit card. Only one can be link to an organization.
URI Parameters
- organization_id
string(required) Example: 1The organization ID
POST https://api-hub.maestrano.com/api/mnoe/v1/organizations/1/credit_card
Requests
Body
{
"data": {
"organization_id": 3,
"title": "Mr.",
"first_name": "John",
"last_name": "Doe",
"month": 3,
"year": 2021,
"country": "AS",
"billing_address": "46 Market Street",
"billing_city": "Sydney",
"billing_postcode": "2000",
"billing_country": "AU",
"number": "4111111111111111",
"verification_value": "000"
},
"entity": "credit_cards",
"resource": {
"data": {
"organization_id": 3,
"title": "Mr.",
"first_name": "John",
"last_name": "Doe",
"month": 3,
"year": 2021,
"country": "AS",
"billing_address": "46 Market Street",
"billing_city": "Sydney",
"billing_postcode": "2000",
"billing_country": "AU",
"number": "4111111111111111",
"verification_value": "000"
}
}
}Responses
Update the Credit CardPOST/organizations/{organization_id}/credit_card
Updates the credit card.
URI Parameters
- organization_id
string(required) Example: 1The organization ID
Impac Dashboard ¶
Attributes
-
id ID - read-only
-
name Name of the Dashboard
-
widgets_order Display order of the widgets
-
organization_ids Ids of the organizations with access
-
currency Currency displayed on the widgets
-
group
-
hist_parameters
-
owner_id Id of the owner
-
owner_type Type of owner (Organization or User)
-
widgets Widgets used
-
widgets_templates Widgets templates to be applied on the widgets used
Dashboards ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/dashboards
Responses
Body
{
"data": [
{
"id": 1,
"name": "Finance",
"widgets_order": [],
"organization_ids": [
"org-fbbw"
],
"currency": "USD",
"group": null,
"hist_parameters": null,
"owner_id": 1,
"owner_type": "User",
"widgets": [
{
"id": 1,
"dashboard": {
"id": 1,
"organization_id": null,
"name": "Finance",
"created_at": "2016-02-23T04:17:44.000Z",
"updated_at": "2016-02-23T04:17:44.000Z",
"metadata": {
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner_type": "User",
"owner_id": 1,
"uid": "dhb-4llf"
},
"name": "Assets vs Liabilities",
"width": 3,
"widget_category": "accounts/classifications_summary",
"settings": {
"template": "accounts/assets-vs-liabilities",
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner": "usr-4l0e"
},
{
"id": 2,
"dashboard": {
"id": 1,
"organization_id": null,
"name": "Finance",
"created_at": "2016-02-23T04:17:44.000Z",
"updated_at": "2016-02-23T04:17:44.000Z",
"metadata": {
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner_type": "User",
"owner_id": 1,
"uid": "dhb-4llf"
},
"name": "All invoices",
"width": 3,
"widget_category": "invoices/list",
"settings": {
"entity": "customers",
"order_by": "total_invoiced",
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner": "usr-4l0e"
},
{
"id": 3,
"dashboard": {
"id": 1,
"organization_id": null,
"name": "Finance",
"created_at": "2016-02-23T04:17:44.000Z",
"updated_at": "2016-02-23T04:17:44.000Z",
"metadata": {
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner_type": "User",
"owner_id": 1,
"uid": "dhb-4llf"
},
"name": "Growth per product",
"width": 3,
"widget_category": "sales/growth",
"settings": {
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner": "usr-4l0e"
}
],
"kpis": [],
"widgets_templates": [
{
"path": "accounts/balance",
"name": "Account balance",
"desc": "Display the current value of a given account",
"icon": "university",
"width": 3
},
{
"path": "accounts/comparison",
"name": "Accounts comparison",
"desc": "Bar chart presenting the comparison of different selected accounts",
"icon": "bar-chart",
"width": 6
},
{
"path": "accounts/expenses_revenue",
"name": "Expenses / Revenue",
"desc": "Pie chart representing the sum of your 'expense' accounts versus the sum of your 'revenue' accounts",
"icon": "pie-chart",
"width": 3
},
{
"path": "accounts/payable_receivable",
"name": "Payable / Receivable",
"desc": "Display the sum of your accounts of types 'payable' and 'receivable'",
"icon": "university",
"width": 3
},
{
"path": "accounts/assets_summary",
"name": "Assets summary",
"desc": "Pie chart representing your different 'asset' accounts values",
"icon": "pie-chart",
"width": 3
},
{
"path": "accounts/assets_summary",
"name": "Liabilities summary",
"metadata": {
"classification": "liability"
},
"desc": "Pie chart representing your different 'liability' accounts values",
"icon": "pie-chart",
"width": 3
},
{
"path": "accounts/assets_summary",
"name": "Assets / Liabilities summary",
"metadata": {
"template": "accounts/assets_liability_summary"
},
"desc": "Compare Assets and Liabilities accounts",
"icon": "pie-chart",
"width": 3
},
{
"path": "sales/performance",
"name": "Teams performance",
"desc": "Comparison of the performance of your accounts managers and sales teams",
"icon": "list-alt",
"width": 6
}
]
}
],
"metadata": {
"pagination": {
"count": 1,
"skip": 0,
"limit": 0
}
}
}Get DashboardsGET/dashboards
Get the list of arrears situations.
POST https://api-hub.maestrano.com/api/mnoe/v1/dashboards
Requests
Body
{
"data": {
"name": "Finance",
"currency": "USD",
"organization_ids": [
3
]
},
"parent_entity": "users",
"parent_id": "9",
"entity": "dashboards",
"resource": {
"data": {
"name": "Finance",
"currency": "USD",
"organization_ids": [
3
]
}
}
}Responses
Create New DashboardPOST/dashboards
Create a new dashboard.
Organization Dashboards ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/organizations/1/dashboards
Responses
Body
{
"data": [
{
"id": 1,
"name": "Finance",
"widgets_order": [],
"organization_ids": [
"org-fbbw"
],
"currency": "USD",
"group": null,
"hist_parameters": null,
"owner_id": 1,
"owner_type": "User",
"widgets": [
{
"id": 1,
"dashboard": {
"id": 1,
"organization_id": null,
"name": "Finance",
"created_at": "2016-02-23T04:17:44.000Z",
"updated_at": "2016-02-23T04:17:44.000Z",
"metadata": {
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner_type": "User",
"owner_id": 1,
"uid": "dhb-4llf"
},
"name": "Assets vs Liabilities",
"width": 3,
"widget_category": "accounts/classifications_summary",
"settings": {
"template": "accounts/assets-vs-liabilities",
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner": "usr-4l0e"
},
{
"id": 2,
"dashboard": {
"id": 1,
"organization_id": null,
"name": "Finance",
"created_at": "2016-02-23T04:17:44.000Z",
"updated_at": "2016-02-23T04:17:44.000Z",
"metadata": {
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner_type": "User",
"owner_id": 1,
"uid": "dhb-4llf"
},
"name": "All invoices",
"width": 3,
"widget_category": "invoices/list",
"settings": {
"entity": "customers",
"order_by": "total_invoiced",
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner": "usr-4l0e"
},
{
"id": 3,
"dashboard": {
"id": 1,
"organization_id": null,
"name": "Finance",
"created_at": "2016-02-23T04:17:44.000Z",
"updated_at": "2016-02-23T04:17:44.000Z",
"metadata": {
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner_type": "User",
"owner_id": 1,
"uid": "dhb-4llf"
},
"name": "Growth per product",
"width": 3,
"widget_category": "sales/growth",
"settings": {
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner": "usr-4l0e"
}
],
"kpis": [],
"widgets_templates": [
{
"path": "accounts/balance",
"name": "Account balance",
"desc": "Display the current value of a given account",
"icon": "university",
"width": 3
},
{
"path": "accounts/comparison",
"name": "Accounts comparison",
"desc": "Bar chart presenting the comparison of different selected accounts",
"icon": "bar-chart",
"width": 6
},
{
"path": "accounts/expenses_revenue",
"name": "Expenses / Revenue",
"desc": "Pie chart representing the sum of your 'expense' accounts versus the sum of your 'revenue' accounts",
"icon": "pie-chart",
"width": 3
},
{
"path": "sales/performance",
"name": "Teams performance",
"desc": "Comparison of the performance of your accounts managers and sales teams",
"icon": "list-alt",
"width": 6
}
]
}
],
"metadata": {
"pagination": {
"count": 1,
"skip": 0,
"limit": 0
}
}
}Get Organization DashboardsGET/organizations/{organization_id}/dashboards
Get the list of the organization dashboards.
URI Parameters
- organization_id
string(required) Example: 1The organization ID
POST https://api-hub.maestrano.com/api/mnoe/v1/organizations/1/dashboards
Requests
Body
{
"data": {
"name": "Finance",
"currency": "USD",
"organization_ids": [
3
]
},
"parent_entity": "users",
"parent_id": "9",
"entity": "dashboards",
"resource": {
"data": {
"name": "Finance",
"currency": "USD",
"organization_ids": [
3
]
}
}
}Responses
Create New Organization DashboardPOST/organizations/{organization_id}/dashboards
Create a new dashboard.
URI Parameters
- organization_id
string(required) Example: 1The organization ID
Dashboard ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/dashboards/1
Responses
Body
{
"data": [
{
"id": 1,
"name": "Finance",
"widgets_order": [],
"organization_ids": [
"org-fbbw"
],
"currency": "USD",
"group": null,
"hist_parameters": null,
"owner_id": 1,
"owner_type": "User",
"widgets": [
{
"id": 1,
"dashboard": {
"id": 1,
"organization_id": null,
"name": "Finance",
"created_at": "2016-02-23T04:17:44.000Z",
"updated_at": "2016-02-23T04:17:44.000Z",
"metadata": {
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner_type": "User",
"owner_id": 1,
"uid": "dhb-4llf"
},
"name": "Assets vs Liabilities",
"width": 3,
"widget_category": "accounts/classifications_summary",
"settings": {
"template": "accounts/assets-vs-liabilities",
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner": "usr-4l0e"
},
{
"id": 2,
"dashboard": {
"id": 1,
"organization_id": null,
"name": "Finance",
"created_at": "2016-02-23T04:17:44.000Z",
"updated_at": "2016-02-23T04:17:44.000Z",
"metadata": {
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner_type": "User",
"owner_id": 1,
"uid": "dhb-4llf"
},
"name": "All invoices",
"width": 3,
"widget_category": "invoices/list",
"settings": {
"entity": "customers",
"order_by": "total_invoiced",
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner": "usr-4l0e"
},
{
"id": 3,
"dashboard": {
"id": 1,
"organization_id": null,
"name": "Finance",
"created_at": "2016-02-23T04:17:44.000Z",
"updated_at": "2016-02-23T04:17:44.000Z",
"metadata": {
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner_type": "User",
"owner_id": 1,
"uid": "dhb-4llf"
},
"name": "Growth per product",
"width": 3,
"widget_category": "sales/growth",
"settings": {
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner": "usr-4l0e"
}
],
"kpis": [],
"widgets_templates": [
{
"path": "accounts/balance",
"name": "Account balance",
"desc": "Display the current value of a given account",
"icon": "university",
"width": 3
},
{
"path": "accounts/comparison",
"name": "Accounts comparison",
"desc": "Bar chart presenting the comparison of different selected accounts",
"icon": "bar-chart",
"width": 6
},
{
"path": "accounts/expenses_revenue",
"name": "Expenses / Revenue",
"desc": "Pie chart representing the sum of your 'expense' accounts versus the sum of your 'revenue' accounts",
"icon": "pie-chart",
"width": 3
},
{
"path": "accounts/payable_receivable",
"name": "Payable / Receivable",
"desc": "Display the sum of your accounts of types 'payable' and 'receivable'",
"icon": "university",
"width": 3
},
{
"path": "accounts/assets_summary",
"name": "Assets summary",
"desc": "Pie chart representing your different 'asset' accounts values",
"icon": "pie-chart",
"width": 3
},
{
"path": "accounts/assets_summary",
"name": "Liabilities summary",
"metadata": {
"classification": "liability"
},
"desc": "Pie chart representing your different 'liability' accounts values",
"icon": "pie-chart",
"width": 3
},
{
"path": "accounts/assets_summary",
"name": "Assets / Liabilities summary",
"metadata": {
"template": "accounts/assets_liability_summary"
},
"desc": "Compare Assets and Liabilities accounts",
"icon": "pie-chart",
"width": 3
},
{
"path": "sales/performance",
"name": "Teams performance",
"desc": "Comparison of the performance of your accounts managers and sales teams",
"icon": "list-alt",
"width": 6
}
]
}
],
"metadata": {
"pagination": {
"count": 1,
"skip": 0,
"limit": 0
}
}
}Get DashboardGET/dashboards/{id}
Get a single dashboard.
URI Parameters
- owner_id
string(required) Example: 1The owner ID (Organization or User)
- id
string(required) Example: 1The dashboard ID
PUT https://api-hub.maestrano.com/api/mnoe/v1/dashboards/1
Requests
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"name": "Finance & Human Resources"
},
"entity": "dashboards",
"id": "1",
"resource": {
"data": {
"name": "Finance & Human Resources"
}
}
}Responses
Body
{
"data": [
{
"id": 1,
"name": "Finance",
"widgets_order": [],
"organization_ids": [
"org-fbbw"
],
"currency": "USD",
"group": null,
"hist_parameters": null,
"owner_id": 1,
"owner_type": "User",
"widgets": [
{
"id": 1,
"dashboard": {
"id": 1,
"organization_id": null,
"name": "Finance",
"created_at": "2016-02-23T04:17:44.000Z",
"updated_at": "2016-02-23T04:17:44.000Z",
"metadata": {
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner_type": "User",
"owner_id": 1,
"uid": "dhb-4llf"
},
"name": "Assets vs Liabilities",
"width": 3,
"widget_category": "accounts/classifications_summary",
"settings": {
"template": "accounts/assets-vs-liabilities",
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner": "usr-4l0e"
},
{
"id": 2,
"dashboard": {
"id": 1,
"organization_id": null,
"name": "Finance",
"created_at": "2016-02-23T04:17:44.000Z",
"updated_at": "2016-02-23T04:17:44.000Z",
"metadata": {
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner_type": "User",
"owner_id": 1,
"uid": "dhb-4llf"
},
"name": "All invoices",
"width": 3,
"widget_category": "invoices/list",
"settings": {
"entity": "customers",
"order_by": "total_invoiced",
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner": "usr-4l0e"
},
{
"id": 3,
"dashboard": {
"id": 1,
"organization_id": null,
"name": "Finance",
"created_at": "2016-02-23T04:17:44.000Z",
"updated_at": "2016-02-23T04:17:44.000Z",
"metadata": {
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner_type": "User",
"owner_id": 1,
"uid": "dhb-4llf"
},
"name": "Growth per product",
"width": 3,
"widget_category": "sales/growth",
"settings": {
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner": "usr-4l0e"
}
],
"kpis": [],
"widgets_templates": [
{
"path": "accounts/balance",
"name": "Account balance",
"desc": "Display the current value of a given account",
"icon": "university",
"width": 3
},
{
"path": "accounts/comparison",
"name": "Accounts comparison",
"desc": "Bar chart presenting the comparison of different selected accounts",
"icon": "bar-chart",
"width": 6
},
{
"path": "accounts/expenses_revenue",
"name": "Expenses / Revenue",
"desc": "Pie chart representing the sum of your 'expense' accounts versus the sum of your 'revenue' accounts",
"icon": "pie-chart",
"width": 3
},
{
"path": "accounts/payable_receivable",
"name": "Payable / Receivable",
"desc": "Display the sum of your accounts of types 'payable' and 'receivable'",
"icon": "university",
"width": 3
},
{
"path": "accounts/assets_summary",
"name": "Assets summary",
"desc": "Pie chart representing your different 'asset' accounts values",
"icon": "pie-chart",
"width": 3
},
{
"path": "accounts/assets_summary",
"name": "Liabilities summary",
"metadata": {
"classification": "liability"
},
"desc": "Pie chart representing your different 'liability' accounts values",
"icon": "pie-chart",
"width": 3
},
{
"path": "accounts/assets_summary",
"name": "Assets / Liabilities summary",
"metadata": {
"template": "accounts/assets_liability_summary"
},
"desc": "Compare Assets and Liabilities accounts",
"icon": "pie-chart",
"width": 3
},
{
"path": "sales/performance",
"name": "Teams performance",
"desc": "Comparison of the performance of your accounts managers and sales teams",
"icon": "list-alt",
"width": 6
}
]
}
],
"metadata": {
"pagination": {
"count": 1,
"skip": 0,
"limit": 0
}
}
}Update an DashboardPUT/dashboards/{id}
Update a single dashboard.
URI Parameters
- owner_id
string(required) Example: 1The owner ID (Organization or User)
- id
string(required) Example: 1The dashboard ID
Organization Dashboard ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/organizations/1/dashboards/1
Responses
Body
{
"data": [
{
"id": 1,
"name": "Finance",
"widgets_order": [],
"organization_ids": [
"org-fbbw"
],
"currency": "USD",
"group": null,
"hist_parameters": null,
"owner_id": 1,
"owner_type": "User",
"widgets": [
{
"id": 1,
"dashboard": {
"id": 1,
"organization_id": null,
"name": "Finance",
"created_at": "2016-02-23T04:17:44.000Z",
"updated_at": "2016-02-23T04:17:44.000Z",
"metadata": {
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner_type": "User",
"owner_id": 1,
"uid": "dhb-4llf"
},
"name": "Assets vs Liabilities",
"width": 3,
"widget_category": "accounts/classifications_summary",
"settings": {
"template": "accounts/assets-vs-liabilities",
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner": "usr-4l0e"
},
{
"id": 2,
"dashboard": {
"id": 1,
"organization_id": null,
"name": "Finance",
"created_at": "2016-02-23T04:17:44.000Z",
"updated_at": "2016-02-23T04:17:44.000Z",
"metadata": {
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner_type": "User",
"owner_id": 1,
"uid": "dhb-4llf"
},
"name": "All invoices",
"width": 3,
"widget_category": "invoices/list",
"settings": {
"entity": "customers",
"order_by": "total_invoiced",
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner": "usr-4l0e"
},
{
"id": 3,
"dashboard": {
"id": 1,
"organization_id": null,
"name": "Finance",
"created_at": "2016-02-23T04:17:44.000Z",
"updated_at": "2016-02-23T04:17:44.000Z",
"metadata": {
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner_type": "User",
"owner_id": 1,
"uid": "dhb-4llf"
},
"name": "Growth per product",
"width": 3,
"widget_category": "sales/growth",
"settings": {
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner": "usr-4l0e"
}
],
"kpis": [],
"widgets_templates": [
{
"path": "accounts/balance",
"name": "Account balance",
"desc": "Display the current value of a given account",
"icon": "university",
"width": 3
},
{
"path": "accounts/comparison",
"name": "Accounts comparison",
"desc": "Bar chart presenting the comparison of different selected accounts",
"icon": "bar-chart",
"width": 6
},
{
"path": "accounts/expenses_revenue",
"name": "Expenses / Revenue",
"desc": "Pie chart representing the sum of your 'expense' accounts versus the sum of your 'revenue' accounts",
"icon": "pie-chart",
"width": 3
},
{
"path": "accounts/payable_receivable",
"name": "Payable / Receivable",
"desc": "Display the sum of your accounts of types 'payable' and 'receivable'",
"icon": "university",
"width": 3
},
{
"path": "accounts/assets_summary",
"name": "Assets summary",
"desc": "Pie chart representing your different 'asset' accounts values",
"icon": "pie-chart",
"width": 3
},
{
"path": "accounts/assets_summary",
"name": "Liabilities summary",
"metadata": {
"classification": "liability"
},
"desc": "Pie chart representing your different 'liability' accounts values",
"icon": "pie-chart",
"width": 3
},
{
"path": "accounts/assets_summary",
"name": "Assets / Liabilities summary",
"metadata": {
"template": "accounts/assets_liability_summary"
},
"desc": "Compare Assets and Liabilities accounts",
"icon": "pie-chart",
"width": 3
},
{
"path": "sales/performance",
"name": "Teams performance",
"desc": "Comparison of the performance of your accounts managers and sales teams",
"icon": "list-alt",
"width": 6
}
]
}
],
"metadata": {
"pagination": {
"count": 1,
"skip": 0,
"limit": 0
}
}
}Get DashboardGET/organizations/{organization_id}/dashboards/{id}
Get a single dashboard.
URI Parameters
- organization_id
string(required) Example: 1The owner ID (Organization or User)
- id
string(required) Example: 1The dashboard ID
PUT https://api-hub.maestrano.com/api/mnoe/v1/organizations/1/dashboards/1
Requests
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"name": "Finance & Human Resources"
},
"entity": "dashboards",
"id": "1",
"resource": {
"data": {
"name": "Finance & Human Resources"
}
}
}Responses
Body
{
"data": [
{
"id": 1,
"name": "Finance",
"widgets_order": [],
"organization_ids": [
"org-fbbw"
],
"currency": "USD",
"group": null,
"hist_parameters": null,
"owner_id": 1,
"owner_type": "User",
"widgets": [
{
"id": 1,
"dashboard": {
"id": 1,
"organization_id": null,
"name": "Finance",
"created_at": "2016-02-23T04:17:44.000Z",
"updated_at": "2016-02-23T04:17:44.000Z",
"metadata": {
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner_type": "User",
"owner_id": 1,
"uid": "dhb-4llf"
},
"name": "Assets vs Liabilities",
"width": 3,
"widget_category": "accounts/classifications_summary",
"settings": {
"template": "accounts/assets-vs-liabilities",
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner": "usr-4l0e"
},
{
"id": 2,
"dashboard": {
"id": 1,
"organization_id": null,
"name": "Finance",
"created_at": "2016-02-23T04:17:44.000Z",
"updated_at": "2016-02-23T04:17:44.000Z",
"metadata": {
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner_type": "User",
"owner_id": 1,
"uid": "dhb-4llf"
},
"name": "All invoices",
"width": 3,
"widget_category": "invoices/list",
"settings": {
"entity": "customers",
"order_by": "total_invoiced",
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner": "usr-4l0e"
},
{
"id": 3,
"dashboard": {
"id": 1,
"organization_id": null,
"name": "Finance",
"created_at": "2016-02-23T04:17:44.000Z",
"updated_at": "2016-02-23T04:17:44.000Z",
"metadata": {
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner_type": "User",
"owner_id": 1,
"uid": "dhb-4llf"
},
"name": "Growth per product",
"width": 3,
"widget_category": "sales/growth",
"settings": {
"currency": "USD",
"organization_ids": [
"org-fbbw"
]
},
"owner": "usr-4l0e"
}
],
"kpis": [],
"widgets_templates": [
{
"path": "accounts/balance",
"name": "Account balance",
"desc": "Display the current value of a given account",
"icon": "university",
"width": 3
},
{
"path": "accounts/comparison",
"name": "Accounts comparison",
"desc": "Bar chart presenting the comparison of different selected accounts",
"icon": "bar-chart",
"width": 6
},
{
"path": "accounts/expenses_revenue",
"name": "Expenses / Revenue",
"desc": "Pie chart representing the sum of your 'expense' accounts versus the sum of your 'revenue' accounts",
"icon": "pie-chart",
"width": 3
},
{
"path": "accounts/payable_receivable",
"name": "Payable / Receivable",
"desc": "Display the sum of your accounts of types 'payable' and 'receivable'",
"icon": "university",
"width": 3
},
{
"path": "accounts/assets_summary",
"name": "Assets summary",
"desc": "Pie chart representing your different 'asset' accounts values",
"icon": "pie-chart",
"width": 3
},
{
"path": "accounts/assets_summary",
"name": "Liabilities summary",
"metadata": {
"classification": "liability"
},
"desc": "Pie chart representing your different 'liability' accounts values",
"icon": "pie-chart",
"width": 3
},
{
"path": "accounts/assets_summary",
"name": "Assets / Liabilities summary",
"metadata": {
"template": "accounts/assets_liability_summary"
},
"desc": "Compare Assets and Liabilities accounts",
"icon": "pie-chart",
"width": 3
},
{
"path": "sales/performance",
"name": "Teams performance",
"desc": "Comparison of the performance of your accounts managers and sales teams",
"icon": "list-alt",
"width": 6
}
]
}
],
"metadata": {
"pagination": {
"count": 1,
"skip": 0,
"limit": 0
}
}
}Update an DashboardPUT/organizations/{organization_id}/dashboards/{id}
Update a single dashboard.
URI Parameters
- organization_id
string(required) Example: 1The owner ID (Organization or User)
- id
string(required) Example: 1The dashboard ID
Invites ¶
Attributes
-
id ID - read-only
-
created_at Date of creation - read-only
-
updated_at Date of last update - read-only
-
organization_id Id of the organization the invite belongs to
-
invitee_email Email of the invited person
-
referrer_id Id of the user that sent the invite
-
token Invitation token
-
status Status of the invite: “pending”, “accepted”, “declined”
Invites List ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/organizations/org_invites}
Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 644,
"user_id": 3510,
"user_email": "john.doe@maestrano.com",
"organization_id": 3541,
"referrer_id": 3489,
"token": "5fcecc7d8b22dc30dcae47b596eec8393d74c3e3a4974aa592982eaaae7dfd7f",
"status": "accepted",
"created_at": "2015-06-03T01:20:56Z",
"updated_at": "2015-06-03T01:20:56Z",
"user_role": "Member",
"team_id": null
}
}Get InvitesGET/organizations/org_invites}
Get the list of invites.
POST https://api-hub.maestrano.com/api/mnoe/v1/organizations/org_invites}
Requests
Body
{
"data": {
"user_email": "john.doe@maestrano.com",
"user_role": "Member",
"team_id": 1,
"referrer_id": 9
},
"parent_entity": "organizations",
"parent_id": "3",
"entity": "org_invites",
"resource": {
"data": {
"user_email": "john.doe@maestrano.com",
"user_role": "Member",
"team_id": 1,
"referrer_id": 9
}
}
}Responses
Create New invitePOST/organizations/org_invites}
Create a new invite.
Invites ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/organizations/42/org_invites/42
Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 644,
"user_id": 3510,
"user_email": "john.doe@maestrano.com",
"organization_id": 3541,
"referrer_id": 3489,
"token": "5fcecc7d8b22dc30dcae47b596eec8393d74c3e3a4974aa592982eaaae7dfd7f",
"status": "accepted",
"created_at": "2015-06-03T01:20:56Z",
"updated_at": "2015-06-03T01:20:56Z",
"user_role": "Member",
"team_id": null
}
}Get InviteGET/organizations/{organization_id}/org_invites/{id}
Get a single invites.
URI Parameters
- id
integer(required) Example: 42The invite ID
- organization_id
integer(required) Example: 42The ID of the organization the invite belongs to
PUT https://api-hub.maestrano.com/api/mnoe/v1/organizations/42/org_invites/42
Requests
Headers
Content-Type: application/json; charset=utf-8Body
{}Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 644,
"user_id": 3510,
"user_email": "john.doe@maestrano.com",
"organization_id": 3541,
"referrer_id": 3489,
"token": "5fcecc7d8b22dc30dcae47b596eec8393d74c3e3a4974aa592982eaaae7dfd7f",
"status": "accepted",
"created_at": "2015-06-03T01:20:56Z",
"updated_at": "2015-06-03T01:20:56Z",
"user_role": "Member",
"team_id": null
}
}Update an InvitePUT/organizations/{organization_id}/org_invites/{id}
Update a single invite.
URI Parameters
- id
integer(required) Example: 42The invite ID
- organization_id
integer(required) Example: 42The ID of the organization the invite belongs to
Invoices ¶
Attributes
-
id ID - read-only
-
started_at Date of invoice start
-
ended_at Date of invoice end
-
created_at Date of last creation
-
updated_at Date of last update
-
paid_at Date paid
-
slug something like “201305-NC8”
-
tax_pips_applied Tax calculation method for display purpose (Tax Inclusive / Exclusive)
-
billing_address Invoice billing address
-
price total price of the invoice
-
total_due total_due is a snapshot of the invoice before any payment has been done.
-
total_payable how much should be paid via credit card
-
tax_payable the taxes payable for this invoice Use the tax_pips_applied value for the tax rate Rounding follows the GST guidelines (normal math rounding) http://www.ato.gov.au/Media-centre/Media-releases/Certainty-for-business-in-GST-calculations-and-rounding/
-
total_due_remaining how much is remaining to pay for this invoice. Basically: total_due - paid
-
tax_due_remaining how much tax should be paid based on total_due_remaining tax_due_remaining = tax_payable - self.payment_paid*rate
-
previous_total_due the previous total due for this invoice as it will be displayed on the customer’s PDF. Use previous_due_invoices for thec alculations
-
previous_total_paid the previous total paid for this invoice as it will be displayedon the customer’s PDF
-
billing_summary the complete summary of the invoice as an array of consolidated (per app instance) item
Invoices List ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/organizations/1/invoices
Responses
Body
{
"data": [
{
"id": 208,
"started_at": "2013-02-28T21:43:20Z",
"ended_at": "2013-07-25T00:00:00Z",
"created_at": "2013-07-25T01:01:08Z",
"updated_at": "2013-08-25T01:01:06Z",
"paid_at": "2013-08-25T01:01:06Z",
"slug": "201307-N43",
"tax_pips_applied": null,
"billing_address": null,
"price": {
"cents": 105,
"currency": "AUD"
},
"total_due": {
"cents": 0,
"currency": "AUD"
},
"total_payable": {
"cents": 0,
"currency": "AUD"
},
"tax_payable": {
"cents": 0,
"currency": "AUD"
},
"total_due_remaining": {
"cents": 0,
"currency": "AUD"
},
"tax_due_remaining": {
"cents": 0,
"currency": "AUD"
},
"credit_paid": {
"cents": 0,
"currency": "AUD"
},
"previous_total_due": {
"cents": 0,
"currency": "AUD"
},
"previous_total_paid": {
"cents": 0,
"currency": "AUD"
},
"billing_summary": [
{
"app_uid": "rsq.mcube.co",
"name": "Feng Office",
"usage": "-",
"label": "CRM investors",
"price_tag": "$0.15",
"price": {
"cents": 15,
"currency": "AUD"
},
"lines": [
{
"label": "Application plan",
"price_tag": "$0.15",
"price": {
"cents": 15,
"currency": "AUD"
},
"converted_price": {
"cents": 15,
"currency": "AUD"
}
}
]
},
{
"app_uid": "www.mcube.co",
"name": "Lovely application",
"usage": "-",
"label": "ERO dam",
"price_tag": "$0.15",
"price": {
"cents": 15,
"currency": "AUD"
},
"lines": [
{
"label": "Application plan",
"price_tag": "$0.15",
"price": {
"cents": 15,
"currency": "AUD"
},
"converted_price": {
"cents": 15,
"currency": "AUD"
}
}
]
},
{
"app_uid": "sac.mcube.co",
"name": "Another Application",
"usage": "-",
"label": "Configuration Management",
"price_tag": "$0.15",
"price": {
"cents": 15,
"currency": "AUD"
},
"lines": [
{
"label": "Application plan",
"price_tag": "$0.15",
"price": {
"cents": 15,
"currency": "AUD"
},
"converted_price": {
"cents": 15,
"currency": "AUD"
}
}
]
},
{
"app_uid": "aaa.mcube.co",
"name": "An Application",
"usage": "-",
"label": "Survey",
"price_tag": "$0.123",
"price": {
"cents": 15,
"currency": "AUD"
},
"lines": [
{
"label": "Application plan",
"price_tag": "$0.123",
"price": {
"cents": 15,
"currency": "AUD"
},
"converted_price": {
"cents": 15,
"currency": "AUD"
}
}
]
}
],
"organization_id": 1
}
],
"metadata": {
"pagination": {
"count": 138266,
"skip": 0,
"limit": "1"
}
}
}Get InvoicesGET/organizations/{organization_id}/invoices
Get the list of invoices.
URI Parameters
- organization_id
string(required) Example: 1The organization ID
Invoice ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/invoices/208
Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 208,
"started_at": "2013-02-28T21:43:20Z",
"ended_at": "2013-07-25T00:00:00Z",
"created_at": "2013-07-25T01:01:08Z",
"updated_at": "2013-08-25T01:01:06Z",
"paid_at": "2013-08-25T01:01:06Z",
"slug": "201307-N43",
"tax_pips_applied": null,
"billing_address": null,
"price": {
"cents": 105,
"currency": "AUD"
},
"total_due": {
"cents": 0,
"currency": "AUD"
},
"total_payable": {
"cents": 0,
"currency": "AUD"
},
"tax_payable": {
"cents": 0,
"currency": "AUD"
},
"total_due_remaining": {
"cents": 0,
"currency": "AUD"
},
"tax_due_remaining": {
"cents": 0,
"currency": "AUD"
},
"credit_paid": {
"cents": 0,
"currency": "AUD"
},
"previous_total_due": {
"cents": 0,
"currency": "AUD"
},
"previous_total_paid": {
"cents": 0,
"currency": "AUD"
},
"billing_summary": [
{
"app_uid": "abc.mcube.co",
"name": "Another Office",
"usage": "-",
"label": "The label",
"price_tag": "$0.15",
"price": {
"cents": 15,
"currency": "AUD"
},
"lines": [
{
"label": "Application plan",
"price_tag": "$0.15",
"price": {
"cents": 15,
"currency": "AUD"
},
"converted_price": {
"cents": 15,
"currency": "AUD"
}
}
]
},
{
"app_uid": "www.mcube.co",
"name": "Lovely application",
"usage": "-",
"label": "ERO grinch",
"price_tag": "$0.15",
"price": {
"cents": 15,
"currency": "AUD"
},
"lines": [
{
"label": "Application plan",
"price_tag": "$0.15",
"price": {
"cents": 15,
"currency": "AUD"
},
"converted_price": {
"cents": 15,
"currency": "AUD"
}
}
]
},
{
"app_uid": "xad.mcube.co",
"name": "Another Application",
"usage": "-",
"label": "Configuration Management",
"price_tag": "$0.15",
"price": {
"cents": 15,
"currency": "AUD"
},
"lines": [
{
"label": "Application plan",
"price_tag": "$0.15",
"price": {
"cents": 15,
"currency": "AUD"
},
"converted_price": {
"cents": 15,
"currency": "AUD"
}
}
]
},
{
"app_uid": "xyz.mcube.co",
"name": "An Application",
"usage": "-",
"label": "Survey",
"price_tag": "$0.123",
"price": {
"cents": 15,
"currency": "AUD"
},
"lines": [
{
"label": "Application plan",
"price_tag": "$0.123",
"price": {
"cents": 15,
"currency": "AUD"
},
"converted_price": {
"cents": 15,
"currency": "AUD"
}
}
]
}
],
"organization_id": 1
}
}Headers
Content-Type: application/json; charset=utf-8Body
{
"errors": [
{
"id": "d57558c1-e6e9-0134-9e45-4d78b8e2d232",
"href": "http://maestrano.github.io/maestrano-hub/#invoices-invoice-get",
"status": "404",
"code": "resource-not-found",
"title": "Resource not found",
"detail": "Resource not found"
}
]
}Get InvoiceGET/invoices/{id}
Get a single invoice.
URI Parameters
- id
string(required) Example: 208The invoice ID
Organizations ¶
Attributes
-
id ID - read-only
-
uid UUID - read-only
-
created_at Date of creation - read-only
-
updated_at Date of last update - read-only
-
name Name of the organization
-
account_frozen Frozen status
-
soa_enabled Service-oriented architecture state
-
mails
-
logo Company’s logo url
-
latitude Geographic latitude
-
longitude Geographic longitude
-
geo_country_code Country code of the company
-
geo_state_code State of the company
-
geo_city City of the company
-
geo_tz Time zone of the company
-
geo_currency Currency of the company
-
meta_data
-
industry Industry of the company
-
size Number of employees in the company
-
billing_currency Currency prefered for billing by the company
-
external_id External Id. May be used to link the organization with an external system.
Organizations ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/organizations
Responses
Body
{
"data": [
{
"id": 3541,
"uid": "org-fx7b",
"name": "Demo Corp",
"created_at": "2015-06-01T12:11:08Z",
"updated_at": "2015-06-01T12:56:30Z",
"account_frozen": false,
"soa_enabled": true,
"mails": null,
"logo": "//cdn.maestrano.com/web/mno/assets/fallback/default_app_logo-8d2b6e49d9c3563f066dd6c664130fd6.jpg",
"latitude": 0,
"longitude": 0,
"geo_country_code": "AU",
"geo_state_code": null,
"geo_city": null,
"geo_tz": "Australia/Sydney",
"geo_currency": "AUD",
"meta_data": null,
"industry": null,
"size": null,
"has_myob_essentials_only?": false,
"billing_currency": "USD",
"current_billing": {
"cents": 8443,
"currency": "USD"
},
"current_credit": {
"cents": 0,
"currency": "USD"
},
"users": [
{
"id": 3489,
"uid": "usr-48m3",
"email": "jack.ho@maestrano.com",
"authenticatable_salt": "$2a$10$Vyn2uAs1ewwxSlLk.Sz8HO",
"reset_password_token": null,
"reset_password_sent_at": null,
"remember_created_at": null,
"sign_in_count": 242,
"current_sign_in_at": "2016-02-23T01:27:55Z",
"last_sign_in_at": "2016-02-23T01:24:07Z",
"current_sign_in_ip": "118.200.93.138",
"last_sign_in_ip": "118.200.93.138",
"confirmation_token": "19396689f7e08e5b085065b63b03a6e54b15227eb84f448384461be34de79f6c",
"confirmed_at": "2015-06-01T12:19:19Z",
"confirmation_sent_at": "2015-06-01T12:16:22Z",
"unconfirmed_email": null,
"failed_attempts": 0,
"unlock_token": null,
"locked_at": null,
"created_at": "2015-06-01T12:11:08Z",
"updated_at": "2016-02-23T01:28:36Z",
"name": "Jack",
"surname": "Ho",
"company": "Demo Corp",
"phone": "12345678",
"phone_country_code": "CA",
"geo_country_code": "AU",
"geo_state_code": "NSW",
"geo_city": "Sydney",
"website": null,
"sso_session": "a19507054d3f13da90dbc31ce603d7fa1412bd12",
"account_frozen": false,
"meta_data": {},
"admin_role": null,
"title": null,
"password_changed_at": null,
"last_active_at": null,
"role": "Super Admin"
},
{
"id": 3510,
"uid": "usr-48ju",
"email": "john.doe@maestrano.com",
"authenticatable_salt": "$2a$10$7oJnEPFMSFXfXKF3Hg16T.",
"reset_password_token": "fE4vvrbkfmCTAky1oy_2",
"reset_password_sent_at": "2015-11-02T07:35:44Z",
"remember_created_at": null,
"sign_in_count": 55,
"current_sign_in_at": "2016-02-19T04:25:38Z",
"last_sign_in_at": "2016-02-17T11:46:29Z",
"current_sign_in_ip": "118.200.93.138",
"last_sign_in_ip": "118.200.93.138",
"confirmation_token": "zLHHK7UjoyECp4P4CmdY",
"confirmed_at": "2015-06-03T01:21:48Z",
"confirmation_sent_at": "2015-06-03T01:20:56Z",
"unconfirmed_email": null,
"failed_attempts": 0,
"unlock_token": null,
"locked_at": null,
"created_at": "2015-06-03T01:20:56Z",
"updated_at": "2016-02-19T04:25:39Z",
"name": "Arthur",
"surname": "Dent",
"company": null,
"phone": null,
"phone_country_code": null,
"geo_country_code": "UK",
"geo_state_code": "",
"geo_city": "London",
"website": null,
"sso_session": "120e0b1d71b01bbd75f1634380d6aa627d7a523f",
"account_frozen": false,
"meta_data": {
"need_details_update": {
"base": true,
"others": false
},
"has_analytics_beta_access": true
},
"admin_role": "Super Admin",
"title": null,
"password_changed_at": null,
"last_active_at": null,
"role": "Member"
},
{
"id": 4098,
"uid": "usr-4kyd",
"email": "marvin.heg@maestrano.com",
"authenticatable_salt": "$2a$10$SQGUY3ILiEybMWZ92ecxjO",
"reset_password_token": null,
"reset_password_sent_at": null,
"remember_created_at": null,
"sign_in_count": 109,
"current_sign_in_at": "2016-02-18T02:05:34Z",
"last_sign_in_at": "2016-02-17T10:04:12Z",
"current_sign_in_ip": "118.200.93.138",
"last_sign_in_ip": "118.200.93.138",
"confirmation_token": "k4ENU6by2y3cVEQYapNJ",
"confirmed_at": "2015-08-11T07:30:57Z",
"confirmation_sent_at": "2015-08-11T07:29:43Z",
"unconfirmed_email": null,
"failed_attempts": 0,
"unlock_token": null,
"locked_at": null,
"created_at": "2015-08-11T07:29:43Z",
"updated_at": "2016-02-18T07:11:56Z",
"name": "Marvin",
"surname": "Heg",
"company": "H2 Corp",
"phone": "6287 5277",
"phone_country_code": "UK",
"geo_country_code": "UK",
"geo_state_code": "",
"geo_city": "London",
"website": null,
"sso_session": "19e1879ffdf2df6efc836b3c075f5fe3e9f508e4",
"account_frozen": false,
"meta_data": {},
"admin_role": null,
"title": null,
"password_changed_at": null,
"last_active_at": null,
"role": "Admin"
},
{
"id": 4440,
"uid": "usr-4kcg",
"email": "trillian.astra@maestrano.com",
"authenticatable_salt": "$2a$10$VMPG3Q1npcDoCY.QTmj8FO",
"reset_password_token": null,
"reset_password_sent_at": null,
"remember_created_at": null,
"sign_in_count": 3,
"current_sign_in_at": "2015-09-28T19:23:26Z",
"last_sign_in_at": "2015-09-28T05:26:45Z",
"current_sign_in_ip": "66.249.91.192",
"last_sign_in_ip": "150.101.126.137",
"confirmation_token": "p7EszZ83xtqbmQx4uTHm",
"confirmed_at": "2015-09-28T02:31:31Z",
"confirmation_sent_at": "2015-09-28T02:30:37Z",
"unconfirmed_email": null,
"failed_attempts": 0,
"unlock_token": null,
"locked_at": null,
"created_at": "2015-09-28T02:30:37Z",
"updated_at": "2015-09-28T19:23:26Z",
"name": "Trillian",
"surname": "Astra",
"company": null,
"phone": null,
"phone_country_code": null,
"geo_country_code": "AU",
"geo_state_code": "NSW",
"geo_city": "Sydney",
"website": null,
"sso_session": "a3536465d10d26ced41b3288740bada834d1593b",
"account_frozen": false,
"meta_data": {
"need_details_update": {
"base": true,
"others": false
},
"has_analytics_beta_access": true
},
"admin_role": null,
"title": null,
"password_changed_at": null,
"last_active_at": null,
"role": "Member"
}
],
"teams": [
{
"id": 99,
"name": "Sales & Marketing",
"created_at": "2015-06-29T10:50:51Z",
"updated_at": "2015-06-29T10:50:51Z",
"organization_id": 3541
},
{
"id": 100,
"name": "Engineering",
"created_at": "2015-06-29T10:51:04Z",
"updated_at": "2015-06-29T10:51:04Z",
"organization_id": 3541
}
],
"org_invites": []
},
{
"id": 3572,
"uid": "org-fxjy",
"name": "n20000",
"created_at": "2015-06-03T09:16:24Z",
"updated_at": "2015-06-03T09:16:24Z",
"account_frozen": false,
"soa_enabled": true,
"mails": null,
"logo": "//cdn.maestrano.com/web/mno/assets/fallback/default_app_logo-8d2b6e49d9c3563f066dd6c664130fd6.jpg",
"latitude": 0,
"longitude": 0,
"geo_country_code": null,
"geo_state_code": null,
"geo_city": null,
"geo_tz": null,
"geo_currency": null,
"meta_data": null,
"industry": null,
"size": null,
"has_myob_essentials_only?": false,
"billing_currency": "USD",
"current_billing": {
"cents": 0,
"currency": "USD"
},
"current_credit": {
"cents": 0,
"currency": "USD"
},
"users": [
{
"id": 3518,
"uid": "usr-48ja",
"email": "by_tann@hotmail.com",
"authenticatable_salt": "$2a$10$p3n32Ih0K25A6WJ/8SP9XO",
"reset_password_token": "",
"reset_password_sent_at": null,
"remember_created_at": null,
"sign_in_count": 23,
"current_sign_in_at": "2015-06-04T04:21:06Z",
"last_sign_in_at": "2015-06-04T02:38:46Z",
"current_sign_in_ip": "219.75.6.185",
"last_sign_in_ip": "219.75.6.185",
"confirmation_token": "1b7c4132b6fd545338fda39ebad9466872c0154ff2f86c0e6fd4ff605552a3a8",
"confirmed_at": "2015-06-04T02:27:47Z",
"confirmation_sent_at": "2015-06-04T02:30:04Z",
"unconfirmed_email": "by_tan@hotmail.com",
"failed_attempts": 0,
"unlock_token": null,
"locked_at": null,
"created_at": "2015-06-03T09:16:24Z",
"updated_at": "2015-06-04T04:21:47Z",
"name": "BY",
"surname": "Tan",
"company": "n20000",
"phone": "91114358",
"phone_country_code": "UK",
"geo_country_code": "UK",
"geo_state_code": "",
"geo_city": "London",
"website": null,
"sso_session": "b345312060fb42ca3e5f08c82fb5d83aae9bca75",
"account_frozen": false,
"meta_data": {},
"admin_role": null,
"title": null,
"password_changed_at": null,
"last_active_at": null,
"role": "Member"
}
],
"teams": [],
"org_invites": []
}
],
"metadata": {
"pagination": {
"count": 425,
"skip": 0,
"limit": 0
}
}
}Get OrganizationsGET/organizations
Get the list of organizations.
POST https://api-hub.maestrano.com/api/mnoe/v1/organizations
Requests
Body
{
"data": {
"name": "Sea & Surf"
},
"entity": "organizations",
"resource": {
"data": {
"name": "Sea & Surf"
}
}
}Responses
Body
{}Create New organizationsPOST/organizations
Create a new organizations.
Organization ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/organizations/42
Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 3541,
"uid": "org-fx7b",
"name": "Demo Corp",
"created_at": "2015-06-01T12:11:08Z",
"updated_at": "2015-06-01T12:56:30Z",
"account_frozen": false,
"soa_enabled": true,
"mails": null,
"logo": "//cdn.maestrano.com/web/mno/assets/fallback/default_app_logo-8d2b6e49d9c3563f066dd6c664130fd6.jpg",
"latitude": 0,
"longitude": 0,
"geo_country_code": "AU",
"geo_state_code": null,
"geo_city": null,
"geo_tz": "Australia/Sydney",
"geo_currency": "AUD",
"meta_data": null,
"industry": null,
"size": null,
"has_myob_essentials_only?": false,
"billing_currency": "USD",
"current_billing": {
"cents": 8443,
"currency": "USD"
},
"current_credit": {
"cents": 0,
"currency": "USD"
},
"users": [
{
"id": 3489,
"uid": "usr-48m3",
"email": "jack.ho@maestrano.com",
"authenticatable_salt": "$2a$10$Vyn2uAs1ewwxSlLk.Sz8HO",
"reset_password_token": null,
"reset_password_sent_at": null,
"remember_created_at": null,
"sign_in_count": 242,
"current_sign_in_at": "2016-02-23T01:27:55Z",
"last_sign_in_at": "2016-02-23T01:24:07Z",
"current_sign_in_ip": "118.200.93.138",
"last_sign_in_ip": "118.200.93.138",
"confirmation_token": "19396689f7e08e5b085065b63b03a6e54b15227eb84f448384461be34de79f6c",
"confirmed_at": "2015-06-01T12:19:19Z",
"confirmation_sent_at": "2015-06-01T12:16:22Z",
"unconfirmed_email": null,
"failed_attempts": 0,
"unlock_token": null,
"locked_at": null,
"created_at": "2015-06-01T12:11:08Z",
"updated_at": "2016-02-23T01:28:36Z",
"name": "Jack",
"surname": "Ho",
"company": "Demo Corp",
"phone": "12345678",
"phone_country_code": "CA",
"geo_country_code": "AU",
"geo_state_code": "NSW",
"geo_city": "Sydney",
"website": null,
"sso_session": "a19507054d3f13da90dbc31ce603d7fa1412bd12",
"account_frozen": false,
"meta_data": {},
"admin_role": null,
"title": null,
"password_changed_at": null,
"last_active_at": null,
"role": "Super Admin"
},
{
"id": 3510,
"uid": "usr-48ju",
"email": "john.doe@maestrano.com",
"authenticatable_salt": "$2a$10$7oJnEPFMSFXfXKF3Hg16T.",
"reset_password_token": "fE4vvrbkfmCTAky1oy_2",
"reset_password_sent_at": "2015-11-02T07:35:44Z",
"remember_created_at": null,
"sign_in_count": 55,
"current_sign_in_at": "2016-02-19T04:25:38Z",
"last_sign_in_at": "2016-02-17T11:46:29Z",
"current_sign_in_ip": "118.200.93.138",
"last_sign_in_ip": "118.200.93.138",
"confirmation_token": "zLHHK7UjoyECp4P4CmdY",
"confirmed_at": "2015-06-03T01:21:48Z",
"confirmation_sent_at": "2015-06-03T01:20:56Z",
"unconfirmed_email": null,
"failed_attempts": 0,
"unlock_token": null,
"locked_at": null,
"created_at": "2015-06-03T01:20:56Z",
"updated_at": "2016-02-19T04:25:39Z",
"name": "Arthur",
"surname": "Dent",
"company": null,
"phone": null,
"phone_country_code": null,
"geo_country_code": "UK",
"geo_state_code": "",
"geo_city": "London",
"website": null,
"sso_session": "120e0b1d71b01bbd75f1634380d6aa627d7a523f",
"account_frozen": false,
"meta_data": {
"need_details_update": {
"base": true,
"others": false
},
"has_analytics_beta_access": true
},
"admin_role": "admin",
"title": null,
"password_changed_at": null,
"last_active_at": null,
"role": "Member"
},
{
"id": 4440,
"uid": "usr-4kcg",
"email": "trillian.astra@maestrano.com",
"authenticatable_salt": "$2a$10$VMPG3Q1npcDoCY.QTmj8FO",
"reset_password_token": null,
"reset_password_sent_at": null,
"remember_created_at": null,
"sign_in_count": 3,
"current_sign_in_at": "2015-09-28T19:23:26Z",
"last_sign_in_at": "2015-09-28T05:26:45Z",
"current_sign_in_ip": "66.249.91.192",
"last_sign_in_ip": "150.101.126.137",
"confirmation_token": "p7EszZ83xtqbmQx4uTHm",
"confirmed_at": "2015-09-28T02:31:31Z",
"confirmation_sent_at": "2015-09-28T02:30:37Z",
"unconfirmed_email": null,
"failed_attempts": 0,
"unlock_token": null,
"locked_at": null,
"created_at": "2015-09-28T02:30:37Z",
"updated_at": "2015-09-28T19:23:26Z",
"name": "Trillian",
"surname": "Astra",
"company": null,
"phone": null,
"phone_country_code": null,
"geo_country_code": "AU",
"geo_state_code": "NSW",
"geo_city": "Sydney",
"website": null,
"sso_session": "a3536465d10d26ced41b3288740bada834d1593b",
"account_frozen": false,
"meta_data": {
"need_details_update": {
"base": true,
"others": false
},
"has_analytics_beta_access": true
},
"admin_role": null,
"title": null,
"password_changed_at": null,
"last_active_at": null,
"role": "Member"
}
],
"teams": [
{
"id": 99,
"name": "Sales & Marketing",
"created_at": "2015-06-29T10:50:51Z",
"updated_at": "2015-06-29T10:50:51Z",
"organization_id": 3541
},
{
"id": 100,
"name": "Engineering",
"created_at": "2015-06-29T10:51:04Z",
"updated_at": "2015-06-29T10:51:04Z",
"organization_id": 3541
}
],
"org_invites": []
}
}Get an OrganizationGET/organizations/{id}
Get a single organization.
URI Parameters
- id
integer(required) Example: 42The organization ID
PUT https://api-hub.maestrano.com/api/mnoe/v1/organizations/42
Requests
Headers
Content-Type: application/json; charset=utf-8Body
{}Responses
Body
{
"data": [
{
"id": 3541,
"uid": "org-fx7b",
"name": "Demo Corp",
"created_at": "2015-06-01T12:11:08Z",
"updated_at": "2015-06-01T12:56:30Z",
"account_frozen": false,
"soa_enabled": true,
"mails": null,
"logo": "//cdn.maestrano.com/web/mno/assets/fallback/default_app_logo-8d2b6e49d9c3563f066dd6c664130fd6.jpg",
"latitude": 0,
"longitude": 0,
"geo_country_code": "AU",
"geo_state_code": null,
"geo_city": null,
"geo_tz": "Australia/Sydney",
"geo_currency": "AUD",
"meta_data": null,
"industry": null,
"size": null,
"has_myob_essentials_only?": false,
"billing_currency": "USD",
"current_billing": {
"cents": 8443,
"currency": "USD"
},
"current_credit": {
"cents": 0,
"currency": "USD"
},
"users": [
{
"id": 3489,
"uid": "usr-48m3",
"email": "jack.ho@maestrano.com",
"authenticatable_salt": "$2a$10$Vyn2uAs1ewwxSlLk.Sz8HO",
"reset_password_token": null,
"reset_password_sent_at": null,
"remember_created_at": null,
"sign_in_count": 242,
"current_sign_in_at": "2016-02-23T01:27:55Z",
"last_sign_in_at": "2016-02-23T01:24:07Z",
"current_sign_in_ip": "118.200.93.138",
"last_sign_in_ip": "118.200.93.138",
"confirmation_token": "19396689f7e08e5b085065b63b03a6e54b15227eb84f448384461be34de79f6c",
"confirmed_at": "2015-06-01T12:19:19Z",
"confirmation_sent_at": "2015-06-01T12:16:22Z",
"unconfirmed_email": null,
"failed_attempts": 0,
"unlock_token": null,
"locked_at": null,
"created_at": "2015-06-01T12:11:08Z",
"updated_at": "2016-02-23T01:28:36Z",
"name": "Jack",
"surname": "Ho",
"company": "Demo Corp",
"phone": "12345678",
"phone_country_code": "CA",
"geo_country_code": "AU",
"geo_state_code": "NSW",
"geo_city": "Sydney",
"website": null,
"sso_session": "a19507054d3f13da90dbc31ce603d7fa1412bd12",
"account_frozen": false,
"meta_data": {},
"admin_role": null,
"title": null,
"password_changed_at": null,
"last_active_at": null,
"role": "Super Admin"
},
{
"id": 3510,
"uid": "usr-48ju",
"email": "john.doe@maestrano.com",
"authenticatable_salt": "$2a$10$7oJnEPFMSFXfXKF3Hg16T.",
"reset_password_token": "fE4vvrbkfmCTAky1oy_2",
"reset_password_sent_at": "2015-11-02T07:35:44Z",
"remember_created_at": null,
"sign_in_count": 55,
"current_sign_in_at": "2016-02-19T04:25:38Z",
"last_sign_in_at": "2016-02-17T11:46:29Z",
"current_sign_in_ip": "118.200.93.138",
"last_sign_in_ip": "118.200.93.138",
"confirmation_token": "zLHHK7UjoyECp4P4CmdY",
"confirmed_at": "2015-06-03T01:21:48Z",
"confirmation_sent_at": "2015-06-03T01:20:56Z",
"unconfirmed_email": null,
"failed_attempts": 0,
"unlock_token": null,
"locked_at": null,
"created_at": "2015-06-03T01:20:56Z",
"updated_at": "2016-02-19T04:25:39Z",
"name": "Arthur",
"surname": "Dent",
"company": null,
"phone": null,
"phone_country_code": null,
"geo_country_code": "UK",
"geo_state_code": "",
"geo_city": "London",
"website": null,
"sso_session": "120e0b1d71b01bbd75f1634380d6aa627d7a523f",
"account_frozen": false,
"meta_data": {
"need_details_update": {
"base": true,
"others": false
},
"has_analytics_beta_access": true
},
"admin_role": "Super Admin",
"title": null,
"password_changed_at": null,
"last_active_at": null,
"role": "Member"
},
{
"id": 4098,
"uid": "usr-4kyd",
"email": "marvin.heg@maestrano.com",
"authenticatable_salt": "$2a$10$SQGUY3ILiEybMWZ92ecxjO",
"reset_password_token": null,
"reset_password_sent_at": null,
"remember_created_at": null,
"sign_in_count": 109,
"current_sign_in_at": "2016-02-18T02:05:34Z",
"last_sign_in_at": "2016-02-17T10:04:12Z",
"current_sign_in_ip": "118.200.93.138",
"last_sign_in_ip": "118.200.93.138",
"confirmation_token": "k4ENU6by2y3cVEQYapNJ",
"confirmed_at": "2015-08-11T07:30:57Z",
"confirmation_sent_at": "2015-08-11T07:29:43Z",
"unconfirmed_email": null,
"failed_attempts": 0,
"unlock_token": null,
"locked_at": null,
"created_at": "2015-08-11T07:29:43Z",
"updated_at": "2016-02-18T07:11:56Z",
"name": "Marvin",
"surname": "Heg",
"company": "H2 Corp",
"phone": "6287 5277",
"phone_country_code": "UK",
"geo_country_code": "UK",
"geo_state_code": "",
"geo_city": "London",
"website": null,
"sso_session": "19e1879ffdf2df6efc836b3c075f5fe3e9f508e4",
"account_frozen": false,
"meta_data": {},
"admin_role": null,
"title": null,
"password_changed_at": null,
"last_active_at": null,
"role": "Admin"
},
{
"id": 4440,
"uid": "usr-4kcg",
"email": "trillian.astra@maestrano.com",
"authenticatable_salt": "$2a$10$VMPG3Q1npcDoCY.QTmj8FO",
"reset_password_token": null,
"reset_password_sent_at": null,
"remember_created_at": null,
"sign_in_count": 3,
"current_sign_in_at": "2015-09-28T19:23:26Z",
"last_sign_in_at": "2015-09-28T05:26:45Z",
"current_sign_in_ip": "66.249.91.192",
"last_sign_in_ip": "150.101.126.137",
"confirmation_token": "p7EszZ83xtqbmQx4uTHm",
"confirmed_at": "2015-09-28T02:31:31Z",
"confirmation_sent_at": "2015-09-28T02:30:37Z",
"unconfirmed_email": null,
"failed_attempts": 0,
"unlock_token": null,
"locked_at": null,
"created_at": "2015-09-28T02:30:37Z",
"updated_at": "2015-09-28T19:23:26Z",
"name": "Trillian",
"surname": "Astra",
"company": null,
"phone": null,
"phone_country_code": null,
"geo_country_code": "AU",
"geo_state_code": "NSW",
"geo_city": "Sydney",
"website": null,
"sso_session": "a3536465d10d26ced41b3288740bada834d1593b",
"account_frozen": false,
"meta_data": {
"need_details_update": {
"base": true,
"others": false
},
"has_analytics_beta_access": true
},
"admin_role": null,
"title": null,
"password_changed_at": null,
"last_active_at": null,
"role": "Member"
}
],
"teams": [
{
"id": 99,
"name": "Sales & Marketing",
"created_at": "2015-06-29T10:50:51Z",
"updated_at": "2015-06-29T10:50:51Z",
"organization_id": 3541
},
{
"id": 100,
"name": "Engineering",
"created_at": "2015-06-29T10:51:04Z",
"updated_at": "2015-06-29T10:51:04Z",
"organization_id": 3541
}
],
"org_invites": []
},
{
"id": 3572,
"uid": "org-fxjy",
"name": "n20000",
"created_at": "2015-06-03T09:16:24Z",
"updated_at": "2015-06-03T09:16:24Z",
"account_frozen": false,
"soa_enabled": true,
"mails": null,
"logo": "//cdn.maestrano.com/web/mno/assets/fallback/default_app_logo-8d2b6e49d9c3563f066dd6c664130fd6.jpg",
"latitude": 0,
"longitude": 0,
"geo_country_code": null,
"geo_state_code": null,
"geo_city": null,
"geo_tz": null,
"geo_currency": null,
"meta_data": null,
"industry": null,
"size": null,
"has_myob_essentials_only?": false,
"billing_currency": "USD",
"current_billing": {
"cents": 0,
"currency": "USD"
},
"current_credit": {
"cents": 0,
"currency": "USD"
},
"users": [
{
"id": 3518,
"uid": "usr-48ja",
"email": "by_tann@hotmail.com",
"authenticatable_salt": "$2a$10$p3n32Ih0K25A6WJ/8SP9XO",
"reset_password_token": "",
"reset_password_sent_at": null,
"remember_created_at": null,
"sign_in_count": 23,
"current_sign_in_at": "2015-06-04T04:21:06Z",
"last_sign_in_at": "2015-06-04T02:38:46Z",
"current_sign_in_ip": "219.75.6.185",
"last_sign_in_ip": "219.75.6.185",
"confirmation_token": "1b7c4132b6fd545338fda39ebad9466872c0154ff2f86c0e6fd4ff605552a3a8",
"confirmed_at": "2015-06-04T02:27:47Z",
"confirmation_sent_at": "2015-06-04T02:30:04Z",
"unconfirmed_email": "by_tan@hotmail.com",
"failed_attempts": 0,
"unlock_token": null,
"locked_at": null,
"created_at": "2015-06-03T09:16:24Z",
"updated_at": "2015-06-04T04:21:47Z",
"name": "BY",
"surname": "Tan",
"company": "n20000",
"phone": "91114358",
"phone_country_code": "UK",
"geo_country_code": "UK",
"geo_state_code": "",
"geo_city": "London",
"website": null,
"sso_session": "b345312060fb42ca3e5f08c82fb5d83aae9bca75",
"account_frozen": false,
"meta_data": {},
"admin_role": null,
"title": null,
"password_changed_at": null,
"last_active_at": null,
"role": "Member"
}
],
"teams": [],
"org_invites": []
}
],
"metadata": {
"pagination": {
"count": 425,
"skip": 0,
"limit": 0
}
}
}Update an OrganizationPUT/organizations/{id}
Update a single organization.
URI Parameters
- id
integer(required) Example: 42The organization ID
Organization Users ¶
These endpoints allow you to manager users inside an organization. How to add/remove them or update their roles.
Roles:
-
Super Admin: has all power within the company including access to billing management
-
Admin: can manage other members (except Super Admin users) and manage the company apps
-
Power User: can see other members and start idle company apps
-
Member: can see other members and access the company apps
GET https://api-hub.maestrano.com/api/mnoe/v1/organizations/42/users
Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": [
{
"id": 16,
"uid": "usr-4l0k",
"email": "bob.partridge@test.com",
"authenticatable_salt": "",
"reset_password_token": null,
"reset_password_sent_at": null,
"remember_created_at": null,
"sign_in_count": 0,
"current_sign_in_at": null,
"last_sign_in_at": null,
"current_sign_in_ip": null,
"last_sign_in_ip": null,
"confirmation_token": null,
"confirmed_at": null,
"confirmation_sent_at": null,
"unconfirmed_email": null,
"failed_attempts": 0,
"unlock_token": null,
"locked_at": null,
"created_at": "2016-09-13T12:45:56Z",
"updated_at": "2016-09-13T13:02:25Z",
"name": "Bob",
"surname": "Partridge",
"company": "Bob's Company",
"phone": null,
"phone_country_code": null,
"geo_country_code": null,
"geo_state_code": null,
"geo_city": null,
"website": null,
"sso_session": "b97a2908e661fffdcc29c54dd07ff52e62ce8f86",
"account_frozen": false,
"meta_data": {},
"admin_role": null,
"title": null,
"password_changed_at": "2016-09-13T12:45:56Z",
"last_active_at": null,
"role": "Member"
}
],
"metadata": {
"pagination": {
"count": 1,
"skip": 0,
"limit": 0
}
}
}Get an Organization UsersGET/organizations/{id}/users
URI Parameters
- id
integer(required) Example: 42The organization ID
POST https://api-hub.maestrano.com/api/mnoe/v1/organizations/42/users
Requests
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 9,
"role": "Power User"
}
}Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 3489,
"uid": "usr-48m3",
"email": "jack.ho@maestrano.com",
"authenticatable_salt": "$2a$10$Vyn2uAs1ewwxSlLk.Sz8HO",
"reset_password_token": null,
"reset_password_sent_at": null,
"remember_created_at": null,
"sign_in_count": 242,
"current_sign_in_at": "2016-02-23T01:27:55Z",
"last_sign_in_at": "2016-02-23T01:24:07Z",
"current_sign_in_ip": "118.200.93.138",
"last_sign_in_ip": "118.200.93.138",
"confirmation_token": "19396689f7e08e5b085065b63b03a6e54b15227eb84f448384461be34de79f6c",
"confirmed_at": "2015-06-01T12:19:19Z",
"confirmation_sent_at": "2015-06-01T12:16:22Z",
"unconfirmed_email": null,
"failed_attempts": 0,
"unlock_token": null,
"locked_at": null,
"created_at": "2015-06-01T12:11:08Z",
"updated_at": "2016-02-23T01:28:36Z",
"name": "Jack",
"surname": "Ho",
"company": "Demo Corp",
"phone": "12345678",
"phone_country_code": "CA",
"geo_country_code": "AU",
"geo_state_code": "NSW",
"geo_city": "Sydney",
"website": null,
"sso_session": "a19507054d3f13da90dbc31ce603d7fa1412bd12",
"account_frozen": false,
"meta_data": {},
"admin_role": null,
"title": null,
"password_changed_at": null,
"last_active_at": null,
"deletion_request": null
}
}Add a User to an OrganizationPOST/organizations/{id}/users
URI Parameters
- id
integer(required) Example: 42The organization ID
Organization User ¶
PUT https://api-hub.maestrano.com/api/mnoe/v1/organizations/42/users/2
Requests
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 9,
"role": "Member"
}
}Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 3489,
"uid": "usr-48m3",
"email": "jack.ho@maestrano.com",
"authenticatable_salt": "$2a$10$Vyn2uAs1ewwxSlLk.Sz8HO",
"reset_password_token": null,
"reset_password_sent_at": null,
"remember_created_at": null,
"sign_in_count": 242,
"current_sign_in_at": "2016-02-23T01:27:55Z",
"last_sign_in_at": "2016-02-23T01:24:07Z",
"current_sign_in_ip": "118.200.93.138",
"last_sign_in_ip": "118.200.93.138",
"confirmation_token": "19396689f7e08e5b085065b63b03a6e54b15227eb84f448384461be34de79f6c",
"confirmed_at": "2015-06-01T12:19:19Z",
"confirmation_sent_at": "2015-06-01T12:16:22Z",
"unconfirmed_email": null,
"failed_attempts": 0,
"unlock_token": null,
"locked_at": null,
"created_at": "2015-06-01T12:11:08Z",
"updated_at": "2016-02-23T01:28:36Z",
"name": "Jack",
"surname": "Ho",
"company": "Demo Corp",
"phone": "12345678",
"phone_country_code": "CA",
"geo_country_code": "AU",
"geo_state_code": "NSW",
"geo_city": "Sydney",
"website": null,
"sso_session": "a19507054d3f13da90dbc31ce603d7fa1412bd12",
"account_frozen": false,
"meta_data": {},
"admin_role": null,
"title": null,
"password_changed_at": null,
"last_active_at": null,
"deletion_request": null
}
}Update User role in an OrganizationPUT/organizations/{id}/users/{user_id}
URI Parameters
- id
integer(required) Example: 42The organization ID
- user_id
integer(required) Example: 2The User ID
DELETE https://api-hub.maestrano.com/api/mnoe/v1/organizations/42/users/42
Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 3489,
"uid": "usr-48m3",
"email": "jack.ho@maestrano.com",
"authenticatable_salt": "$2a$10$Vyn2uAs1ewwxSlLk.Sz8HO",
"reset_password_token": null,
"reset_password_sent_at": null,
"remember_created_at": null,
"sign_in_count": 242,
"current_sign_in_at": "2016-02-23T01:27:55Z",
"last_sign_in_at": "2016-02-23T01:24:07Z",
"current_sign_in_ip": "118.200.93.138",
"last_sign_in_ip": "118.200.93.138",
"confirmation_token": "19396689f7e08e5b085065b63b03a6e54b15227eb84f448384461be34de79f6c",
"confirmed_at": "2015-06-01T12:19:19Z",
"confirmation_sent_at": "2015-06-01T12:16:22Z",
"unconfirmed_email": null,
"failed_attempts": 0,
"unlock_token": null,
"locked_at": null,
"created_at": "2015-06-01T12:11:08Z",
"updated_at": "2016-02-23T01:28:36Z",
"name": "Jack",
"surname": "Ho",
"company": "Demo Corp",
"phone": "12345678",
"phone_country_code": "CA",
"geo_country_code": "AU",
"geo_state_code": "NSW",
"geo_city": "Sydney",
"website": null,
"sso_session": "a19507054d3f13da90dbc31ce603d7fa1412bd12",
"account_frozen": false,
"meta_data": {},
"admin_role": null,
"title": null,
"password_changed_at": null,
"last_active_at": null,
"deletion_request": null
}
}Remove a User from an OrganizationDELETE/organizations/{id}/users/{user_id}
Remove a user from an organization.
Important: A user may be removed from the organization only if he is not the last. The last user cannot be removed from an organization.
URI Parameters
- id
integer(required) Example: 42The organization ID
- user_id
integer(required) Example: 42The user ID
Teams ¶
Attributes
-
id ID - read-only
-
created_at Date of creation - read-only
-
updated_at Date of last update - read-only
-
organization_id Id of the organization the team belongs to
Teams List ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/teams
Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 99,
"name": "Sales & Marketing",
"created_at": "2015-06-29T10:50:51Z",
"updated_at": "2015-06-29T10:50:51Z",
"organization_id": 3541
}
}Get TeamsGET/teams
Get the list of teams.
POST https://api-hub.maestrano.com/api/mnoe/v1/teams
Requests
Body
{
"data": {
"name": "Engineers"
},
"parent_entity": "organizations",
"parent_id": "3",
"entity": "teams",
"resource": {
"data": {
"name": "Engineers"
}
}
}Responses
Create New teamPOST/teams
Create a new team.
Organization Teams List ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/organizations/1/teams
Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 99,
"name": "Sales & Marketing",
"created_at": "2015-06-29T10:50:51Z",
"updated_at": "2015-06-29T10:50:51Z",
"organization_id": 3541
}
}Get Organization TeamsGET/organizations/{organization_id}/teams
Get the list of teams.
URI Parameters
- organization_id
string(required) Example: 1The organization ID
POST https://api-hub.maestrano.com/api/mnoe/v1/organizations/1/teams
Requests
Body
{
"data": {
"name": "Engineers"
},
"parent_entity": "organizations",
"parent_id": "3",
"entity": "teams",
"resource": {
"data": {
"name": "Engineers"
}
}
}Responses
Create New Organization TeamPOST/organizations/{organization_id}/teams
Create a new team.
URI Parameters
- organization_id
string(required) Example: 1The organization ID
Teams ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/teams/42
Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 99,
"name": "Sales & Marketing",
"created_at": "2015-06-29T10:50:51Z",
"updated_at": "2015-06-29T10:50:51Z",
"organization_id": 3541
}
}PUT https://api-hub.maestrano.com/api/mnoe/v1/teams/42
Requests
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"name": "Engineers"
},
"parent_entity": "organizations",
"parent_id": "3",
"entity": "teams",
"resource": {
"data": {
"name": "Engineers"
}
}
}Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 99,
"name": "Sales & Marketing",
"created_at": "2015-06-29T10:50:51Z",
"updated_at": "2015-06-29T10:50:51Z",
"organization_id": 3541
}
}Update a TeamPUT/teams/{id}
Update a single team.
URI Parameters
- id
integer(required) Example: 42The team ID
Organization Teams ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/organizations/42/teams/42
Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 99,
"name": "Sales & Marketing",
"created_at": "2015-06-29T10:50:51Z",
"updated_at": "2015-06-29T10:50:51Z",
"organization_id": 3541
}
}Get Organization TeamGET/organizations/{organization_id}/teams/{id}
Get a single teams.
URI Parameters
- organization_id
integer(required) Example: 42The ID of the organization the team belongs to
- id
integer(required) Example: 42The team ID
PUT https://api-hub.maestrano.com/api/mnoe/v1/organizations/42/teams/42
Requests
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"name": "Engineers"
},
"parent_entity": "organizations",
"parent_id": "3",
"entity": "teams",
"resource": {
"data": {
"name": "Engineers"
}
}
}Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 99,
"name": "Sales & Marketing",
"created_at": "2015-06-29T10:50:51Z",
"updated_at": "2015-06-29T10:50:51Z",
"organization_id": 3541
}
}Update an Organization TeamPUT/organizations/{organization_id}/teams/{id}
Update a single team.
URI Parameters
- organization_id
integer(required) Example: 42The ID of the organization the team belongs to
- id
integer(required) Example: 42The team ID
Tenant ¶
Attributes
-
last_customers_invoicing_amount
-
last_customers_outstanding_amount
-
last_portfolio_amount
-
last_commission_amount
-
user_metrics
-
organizations_count
Tenant ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/tenant
Responses
Body
{
"data": {
"last_customers_invoicing_amount": {
"cents": 0,
"currency": "USD"
},
"last_customers_outstanding_amount": {
"cents": 0,
"currency": "USD"
},
"last_portfolio_amount": {
"cents": 0,
"currency": "USD"
},
"last_commission_amount": {
"cents": 0,
"currency": "USD"
},
"user_metrics": {
"total_count": 2,
"new_month_count": 2,
"monthly_churn_rate": 2
},
"organizations_count": {
"total_count": 3,
"with_cc_count": 1
}
},
"metadata": {
"pagination": {
"count": 1,
"skip": 0,
"limit": 0
}
}
}Get TenantGET/tenant
Get information about the tenant
Users ¶
How to add a user to an organization
Regarding roles
There is two fields that define a user role. You may either set the value coming from your system directly, or use the values needed by the MNOE Framework.
-
admin_role: defined on the user level. This value defines a role on the platform level. The value can be any arbitrary string. In the MNOE framework, the value accepted are “admin”, or “nil” depending if the user is an admin or not.
-
role: defines the role of a user inside an organization. This value is set up when you add a user to an organization. See Add User to an organization In the MNOE framework, the value accepted are “Super Admin”, “Admin”, “Power User” and “Member” see Organizations Users
Attributes
-
id ID - read-only
-
uid UUID - read-only
-
created_at Date of creation - read-only
-
updated_at Date of last update - read-only
-
password_changed_at Date of last password update - read-only
-
password User Password - write-only
-
email Email of the user
-
sign_in_count Number of times the user signed in
-
current_sign_in_at Date when the user current session was created
-
last_sign_in_at Date of the user last sign in
-
current_sign_in_ip Current ip on wich the user is signed in
-
last_sign_in_ip Last ip the user signed in from
-
confirmation_token User creation token used to confirm it’s signup
-
confirmed_at Date the user was confirmed
-
confirmation_sent_at Date the confirmation mail was sent
-
unconfirmed_email Pending mail for the user until he confirms it
-
failed_attempts Account logins failed attemps
-
unlock_token Token to unlock the user account after too many tries
-
locked_at Date of user account unlock
-
name Name of the user
-
surname Surname of the user
-
company Company associated with the user
-
orga_on_create Create an organization linked to the User when the user is created
-
phone Phone number of the user
-
phone_country_code Country code of the user phone number
-
geo_country_code Country code of the localization of the user
-
geo_state_code State of the localization of the user
-
geo_city City of the localization of the user
-
account_frozen Frozen status of the user account
-
meta_data Additional user informations
-
admin_role Admin status of the user
-
title Title of the user
-
external_id External Id. May be used to link the user with an external system. Limited to 255 characters.
Regarding external_id
external_id can be any string value up to 255 characters. It gives a way to identify the user by an external id. This id is not unique, therefore the unicity checks needs to be done externally.
Find a User by external_id: “XDE 48”
GET /users?filter[external_id]=XDE%2048Users ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/users
Responses
Body
{
"data": [
{
"id": 3489,
"uid": "usr-48m3",
"email": "jack.ho@maestrano.com",
"authenticatable_salt": "$2a$10$Vyn2uAs1ewwxSlLk.Sz8HO",
"reset_password_token": null,
"reset_password_sent_at": null,
"remember_created_at": null,
"sign_in_count": 242,
"current_sign_in_at": "2016-02-23T01:27:55Z",
"last_sign_in_at": "2016-02-23T01:24:07Z",
"current_sign_in_ip": "118.200.93.138",
"last_sign_in_ip": "118.200.93.138",
"confirmation_token": "19396689f7e08e5b085065b63b03a6e54b15227eb84f448384461be34de79f6c",
"confirmed_at": "2015-06-01T12:19:19Z",
"confirmation_sent_at": "2015-06-01T12:16:22Z",
"unconfirmed_email": null,
"failed_attempts": 0,
"unlock_token": null,
"locked_at": null,
"created_at": "2015-06-01T12:11:08Z",
"updated_at": "2016-02-23T01:28:36Z",
"name": "Jack",
"surname": "Ho",
"company": "Demo Corp",
"phone": "12345678",
"phone_country_code": "CA",
"geo_country_code": "AU",
"geo_state_code": "NSW",
"geo_city": "Sydney",
"website": null,
"sso_session": "a19507054d3f13da90dbc31ce603d7fa1412bd12",
"account_frozen": false,
"meta_data": {},
"admin_role": null,
"title": null,
"password_changed_at": null,
"last_active_at": null,
"deletion_request": null
}
],
"metadata": {
"pagination": {
"count": 487,
"skip": 0,
"limit": 0
}
}
}Get UsersGET/users
Get the list of users.
POST https://api-hub.maestrano.com/api/mnoe/v1/users
Requests
Body
{
"data": {
"name": "Bob",
"surname": "Partridge",
"email": "bob.partridge@test.com"
}
}Responses
Create New usersPOST/users
Create a new user.
User ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/users/42
Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 3489,
"uid": "usr-48m3",
"email": "jack.ho@maestrano.com",
"authenticatable_salt": "$2a$10$Vyn2uAs1ewwxSlLk.Sz8HO",
"reset_password_token": null,
"reset_password_sent_at": null,
"remember_created_at": null,
"sign_in_count": 242,
"current_sign_in_at": "2016-02-23T01:27:55Z",
"last_sign_in_at": "2016-02-23T01:24:07Z",
"current_sign_in_ip": "118.200.93.138",
"last_sign_in_ip": "118.200.93.138",
"confirmation_token": "19396689f7e08e5b085065b63b03a6e54b15227eb84f448384461be34de79f6c",
"confirmed_at": "2015-06-01T12:19:19Z",
"confirmation_sent_at": "2015-06-01T12:16:22Z",
"unconfirmed_email": null,
"failed_attempts": 0,
"unlock_token": null,
"locked_at": null,
"created_at": "2015-06-01T12:11:08Z",
"updated_at": "2016-02-23T01:28:36Z",
"name": "Jack",
"surname": "Ho",
"company": "Demo Corp",
"phone": "12345678",
"phone_country_code": "CA",
"geo_country_code": "AU",
"geo_state_code": "NSW",
"geo_city": "Sydney",
"website": null,
"sso_session": "a19507054d3f13da90dbc31ce603d7fa1412bd12",
"account_frozen": false,
"meta_data": {},
"admin_role": null,
"title": null,
"password_changed_at": null,
"last_active_at": null,
"deletion_request": null
}
}PUT https://api-hub.maestrano.com/api/mnoe/v1/users/42
Requests
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 3489,
"uid": "usr-48m3",
"email": "jack.ho@maestrano.com",
"authenticatable_salt": "$2a$10$Vyn2uAs1ewwxSlLk.Sz8HO",
"reset_password_token": null,
"reset_password_sent_at": null,
"remember_created_at": null,
"sign_in_count": 242,
"current_sign_in_at": "2016-02-23T01:27:55Z",
"last_sign_in_at": "2016-02-23T01:24:07Z",
"current_sign_in_ip": "118.200.93.138",
"last_sign_in_ip": "118.200.93.138",
"confirmation_token": "19396689f7e08e5b085065b63b03a6e54b15227eb84f448384461be34de79f6c",
"confirmed_at": "2015-06-01T12:19:19Z",
"confirmation_sent_at": "2015-06-01T12:16:22Z",
"unconfirmed_email": null,
"failed_attempts": 0,
"unlock_token": null,
"locked_at": null,
"created_at": "2015-06-01T12:11:08Z",
"updated_at": "2016-02-23T01:28:36Z",
"name": "Jack",
"surname": "Ho",
"company": "Demo Corp",
"phone": "12345678",
"phone_country_code": "CA",
"geo_country_code": "AU",
"geo_state_code": "NSW",
"geo_city": "Sydney",
"website": null,
"sso_session": "a19507054d3f13da90dbc31ce603d7fa1412bd12",
"account_frozen": false,
"meta_data": {},
"admin_role": null,
"title": null,
"password_changed_at": null,
"last_active_at": null,
"deletion_request": null
}
}Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 3489,
"uid": "usr-48m3",
"email": "jack.ho@maestrano.com",
"authenticatable_salt": "$2a$10$Vyn2uAs1ewwxSlLk.Sz8HO",
"reset_password_token": null,
"reset_password_sent_at": null,
"remember_created_at": null,
"sign_in_count": 242,
"current_sign_in_at": "2016-02-23T01:27:55Z",
"last_sign_in_at": "2016-02-23T01:24:07Z",
"current_sign_in_ip": "118.200.93.138",
"last_sign_in_ip": "118.200.93.138",
"confirmation_token": "19396689f7e08e5b085065b63b03a6e54b15227eb84f448384461be34de79f6c",
"confirmed_at": "2015-06-01T12:19:19Z",
"confirmation_sent_at": "2015-06-01T12:16:22Z",
"unconfirmed_email": null,
"failed_attempts": 0,
"unlock_token": null,
"locked_at": null,
"created_at": "2015-06-01T12:11:08Z",
"updated_at": "2016-02-23T01:28:36Z",
"name": "Jack",
"surname": "Ho",
"company": "Demo Corp",
"phone": "12345678",
"phone_country_code": "CA",
"geo_country_code": "AU",
"geo_state_code": "NSW",
"geo_city": "Sydney",
"website": null,
"sso_session": "a19507054d3f13da90dbc31ce603d7fa1412bd12",
"account_frozen": false,
"meta_data": {},
"admin_role": null,
"title": null,
"password_changed_at": null,
"last_active_at": null,
"deletion_request": null
}
}Update an UserPUT/users/{id}
Update a single user.
URI Parameters
- id
integer(required) Example: 42The user ID
DELETE https://api-hub.maestrano.com/api/mnoe/v1/users/42
Requests
Headers
Content-Type: application/json; charset=utf-8Responses
Delete a UserDELETE/users/{id}
Delete a single user.
URI Parameters
- id
integer(required) Example: 42The user ID
Widgets ¶
Attributes
-
id ID - read-only
-
dashboard - linked Dashboard
-
name - Widget name string
-
width - Widget width integer
-
widget_category - Widget Category
-
settings - Widget metadata hash for storing settings
Widgets List ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/organizations/1/widgets
Get WidgetsGET/organizations/{organization_id}/widgets
Get the list of widgets.
URI Parameters
- organization_id
string(required) Example: 1The organization ID
POST https://api-hub.maestrano.com/api/mnoe/v1/organizations/1/widgets
Create New widgetPOST/organizations/{organization_id}/widgets
Create a new widget.
URI Parameters
- organization_id
string(required) Example: 1The organization ID
Widgets ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/organizations/42/widgets/42
Get WidgetGET/organizations/{organization_id}/widgets/{id}
Get a single widgets.
URI Parameters
- organization_id
integer(required) Example: 42The ID of the organization the widget belongs to
- id
integer(required) Example: 42The widget ID
PUT https://api-hub.maestrano.com/api/mnoe/v1/organizations/42/widgets/42
Update a WidgetPUT/organizations/{organization_id}/widgets/{id}
Update a single widget.
URI Parameters
- organization_id
integer(required) Example: 42The ID of the organization the widget belongs to
- id
integer(required) Example: 42The widget ID
Alerts ¶
Attributes
-
id - ID read-only
-
recipients - Linked Recipients (Users).
-
impac_kpi_id - ID of the linked KPI
-
title - Alert title
-
webhook - A webhook url string
-
service - Type of Alert: “inapp”, “email”
-
sent - Alert sent status: true, false
-
settings - Alert metadata hash for storing settings
Alerts ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/users/16/alerts
Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": [
{
"id": 134,
"impac_kpi_id": 155,
"recipients": [
{
"id": 16,
"email": "john.smith@maestrano.com"
}
],
"title": null,
"webhook": null,
"service": "email",
"sent": false,
"settings": {}
}
]
}User Alerts ListGET/users/{user_id}/alerts
Retrieve all the Alerts that a User is a recipient of.
KPI Alerts are only retrievable if your tenant is ‘KPI enabled’.
URI Parameters
- user_id
integer(required) Example: 16The ID of the User whose Alerts are to be retrieved.
Create Alert ¶
POST https://api-hub.maestrano.com/api/mnoe/v1/alerts
Requests
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"impac_kpi_id": 155,
"recipients": [
{
"id": 16
},
{
"email": "davo.rads@maestrano.com"
}
],
"title": "My Alert",
"webhook": null,
"service": "email",
"sent": false,
"settings": {}
}
}Responses
Body
{
"data": {
"id": 200,
"impac_kpi_id": 155,
"recipients": [
{
"id": 16,
"email": "john.smith@maestrano.com"
},
{
"id": 17,
"email": "davo.rads@maestrano.com"
}
],
"title": "My Alert",
"webhook": null,
"service": "email",
"sent": false,
"settings": {}
}
}Create AlertPOST/alerts
Create an Alert.
-
“recipients” associate Maestrano Users as Alert Recipients by ID or Email
-
“service” is required to be set as “inapp” or “email”
When an Alert is associated to a KPI (key performance indicator), when the KPIs targets have been met, Impac! will notify all Alert recipients of the event.
Alert ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/alerts/134
Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 134,
"impac_kpi_id": 155,
"recipients": [
{
"id": 16,
"email": "john.smith@maestrano.com"
}
],
"title": null,
"webhook": null,
"service": "email",
"sent": false,
"settings": {}
}
}Get AlertGET/alerts/{id}
Get an Alert.
URI Parameters
- id
integer(required) Example: 134The ID of the Alert.
PUT https://api-hub.maestrano.com/api/mnoe/v1/alerts/134
Requests
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"impac_kpi_id": 155,
"recipients": [],
"title": null,
"webhook": null,
"service": "email",
"sent": false,
"settings": {}
}
}Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 134,
"impac_kpi_id": 155,
"recipients": [
{
"id": 16,
"email": "john.smith@maestrano.com"
}
],
"title": null,
"webhook": null,
"service": "email",
"sent": false,
"settings": {}
}
}Update AlertPUT/alerts/{id}
Update an Alert. At least 1 or more recipients must be given for recipients to be updated.
URI Parameters
- id
integer(required) Example: 134The ID of the Alert.
DELETE https://api-hub.maestrano.com/api/mnoe/v1/alerts/134
Requests
Headers
Content-Type: application/json; charset=utf-8Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 134,
"impac_kpi_id": 155,
"recipients": [
{
"id": 16,
"email": "john.smith@maestrano.com"
}
],
"title": null,
"webhook": null,
"service": "email",
"sent": false,
"settings": {}
}
}Delete AlertDELETE/alerts/{id}
Delete an Alert.
URI Parameters
- id
integer(required) Example: 134The ID of the Alert.
App Reviews ¶
App reviews is the endpoint to retrieve all kinds of Applications reviews: questions, answers, feedbacks, and comments.
-
App Feedback User’s Feedback on an application. It contains a description and a rating (number).
-
App Comment Comment given on a feedback. A feedback contains multiple comments.
-
App Question Question asked on an Application.
-
App Answer Answer to the question. A question contains multiple answers.
Attributes
-
id ID - read-only
-
created_at Date of creation - read-only
-
updated_at Date of last update - read-only
-
rating Number - (apply to Feedbacks) Rating given to the application, can be any value, 1 to 5 in the MNOE framework
-
description Text associated to the review, either the question asked or the answer given for example
-
status Current status of the review, can be either approved or rejected
-
app_id App id on which the review was made
-
app_name App name on which the review was made
-
user_id Id of the user that made the review
-
user_name Name of the user that made the review
-
user_admin_role Admin role of the user that made the review
-
organization_id Organization id from which the user made the review
-
organization_name Organization name from which the user made the review
-
type Type of the review, can be either “Question”, “Answer”, “Feedback” or and “Comment”
-
parent_id Only apply to Comments and Answers
- Comments: Id of the feedback being commented
- Answers: Id of the question being answered
-
edited Boolean, True if edited since creation
-
edited_by_id Id of the user that made the last edit
-
edited_by_admin_role Admin Role of the user that made the last edit
-
edited_by_name Name of the user that made the last edit
-
versions Array containing the different versions of the review. This field only appear when a review is fetched by its id. It contains:
- id ID of the version
- created_at Date of the creation of the version
- description Description of the review for that version
- event Event description that led to the creation of the version, may be create or update
- author Id of the user that created change that created the version
App Reviews ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/app_reviews
Responses
Body
{
"data": [
{
"id": 47,
"rating": 5,
"description": "What a nice application",
"status": "rejected",
"app_id": 15,
"app_name": "vtiger",
"user_id": 9,
"user_name": "John MacGonagle",
"user_admin_role": "",
"organization_id": 3,
"organization_name": "Poudlard associate",
"type": "Feedback",
"parent_id": null,
"created_at": "2017-01-24T12:25:29.000Z",
"updated_at": "2017-02-01T18:08:33.000Z",
"edited": true,
"edited_by_name": null,
"edited_by_admin_role": null,
"edited_by_id": null
}
],
"metadata": {
"pagination": {
"count": 1,
"skip": 0,
"limit": 0
}
}
}Get App ReviewsGET/app_reviews
Get the list of app reviews.
POST https://api-hub.maestrano.com/api/mnoe/v1/app_reviews
Requests
Body
{
"data": {
"user_id": 9,
"organization_id": 3,
"app_id": 43,
"rating": 5,
"description": "This is my answer",
"type": "Answer",
"parent_id": 25
}
Responses
Body
{
"data": {
"id": 58,
"rating": 5,
"description": "super",
"status": "approved",
"app_id": 48,
"app_name": "DemoApp Java",
"user_id": 9,
"user_name": "John MacGonagle",
"user_admin_role": "",
"organization_id": 3,
"organization_name": "Poudlard associate",
"type": "Feedback",
"parent_id": null,
"created_at": "2017-03-17T11:44:39.000Z",
"updated_at": "2017-03-17T11:44:39.000Z",
"edited": false,
"edited_by_name": null,
"edited_by_admin_role": null,
"edited_by_id": null,
"versions": [
{
"id": 52,
"created_at": "2017-03-17T11:44:39.000Z",
"description": null,
"event": "create",
"author": null
}
]
}
}Create New App ReviewPOST/app_reviews
Create a new app review. It will create a Feedback by default.
Change the type attribute in order to create a Question, an Answer or a Comment.
Warning, if you create an Answer or a Comment, you will need to set as parent_id the the respective Question or Feedback they are associated to.
App Review ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/app_reviews/42
Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 58,
"rating": 5,
"description": "super",
"status": "approved",
"app_id": 48,
"app_name": "DemoApp Java",
"user_id": 9,
"user_name": "John MacGonagle",
"user_admin_role": "",
"organization_id": 3,
"organization_name": "Poudlard associate",
"type": "Feedback",
"parent_id": null,
"created_at": "2017-03-17T11:44:39.000Z",
"updated_at": "2017-03-17T11:44:39.000Z",
"edited": false,
"edited_by_name": null,
"edited_by_admin_role": null,
"edited_by_id": null,
"versions": [
{
"id": 52,
"created_at": "2017-03-17T11:44:39.000Z",
"description": null,
"event": "create",
"author": null
}
]
}
}Get App ReviewGET/app_reviews/{id}
Get a single app review.
URI Parameters
- id
integer(required) Example: 42The app review ID
PUT https://api-hub.maestrano.com/api/mnoe/v1/app_reviews/42
Requests
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 58,
"rating": 5,
"description": "super",
"status": "approved",
"app_id": 48,
"app_name": "DemoApp Java",
"user_id": 9,
"user_name": "John MacGonagle",
"user_admin_role": "",
"organization_id": 3,
"organization_name": "Poudlard associate",
"type": "Feedback",
"parent_id": null,
"created_at": "2017-03-17T11:44:39.000Z",
"updated_at": "2017-03-17T11:44:39.000Z",
"edited": false,
"edited_by_name": null,
"edited_by_admin_role": null,
"edited_by_id": null,
"versions": [
{
"id": 52,
"created_at": "2017-03-17T11:44:39.000Z",
"description": null,
"event": "create",
"author": null
}
]
}
}Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 58,
"rating": 5,
"description": "super",
"status": "approved",
"app_id": 48,
"app_name": "DemoApp Java",
"user_id": 9,
"user_name": "John MacGonagle",
"user_admin_role": "",
"organization_id": 3,
"organization_name": "Poudlard associate",
"type": "Feedback",
"parent_id": null,
"created_at": "2017-03-17T11:44:39.000Z",
"updated_at": "2017-03-17T11:44:39.000Z",
"edited": false,
"edited_by_name": null,
"edited_by_admin_role": null,
"edited_by_id": null,
"versions": [
{
"id": 52,
"created_at": "2017-03-17T11:44:39.000Z",
"description": null,
"event": "create",
"author": null
}
]
}
}Update an App ReviewPUT/app_reviews/{id}
Update a single app review.
URI Parameters
- id
integer(required) Example: 42The app review ID
DELETE https://api-hub.maestrano.com/api/mnoe/v1/app_reviews/42
Requests
Headers
Content-Type: application/json; charset=utf-8Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 58,
"rating": 5,
"description": "super",
"status": "approved",
"app_id": 48,
"app_name": "DemoApp Java",
"user_id": 9,
"user_name": "John MacGonagle",
"user_admin_role": "",
"organization_id": 3,
"organization_name": "Poudlard associate",
"type": "Feedback",
"parent_id": null,
"created_at": "2017-03-17T11:44:39.000Z",
"updated_at": "2017-03-17T11:44:39.000Z",
"edited": false,
"edited_by_name": null,
"edited_by_admin_role": null,
"edited_by_id": null,
"versions": [
{
"id": 52,
"created_at": "2017-03-17T11:44:39.000Z",
"description": null,
"event": "create",
"author": null
}
]
}
}Delete an App ReviewDELETE/app_reviews/{id}
Delete a single app review.
URI Parameters
- id
integer(required) Example: 42The app review ID
App Feedbacks ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/app_feedbacks
Responses
Body
{
"data": [
{
"id": 65,
"rating": 5,
"description": "super",
"status": "approved",
"app_id": 48,
"app_name": "DemoApp Java",
"user_id": 9,
"user_name": "John MacGonagle",
"user_admin_role": "",
"organization_id": 3,
"organization_name": "Poudlard associate",
"type": "Feedback",
"parent_id": null,
"created_at": "2017-03-17T15:30:55.000Z",
"updated_at": "2017-03-17T15:30:55.000Z",
"edited": false,
"edited_by_name": null,
"edited_by_admin_role": null,
"edited_by_id": null,
"comments": [
{
"id": 66,
"rating": null,
"description": "This is a comment",
"status": "approved",
"app_id": 48,
"app_name": "DemoApp Java",
"user_id": 9,
"user_name": "John MacGonagle",
"user_admin_role": "",
"organization_id": 3,
"organization_name": "Poudlard associate",
"type": "Comment",
"parent_id": 65,
"created_at": "2017-03-17T15:31:23.000Z",
"updated_at": "2017-03-17T15:31:23.000Z",
"edited": false,
"edited_by_name": null,
"edited_by_admin_role": null,
"edited_by_id": null
}
]
}
],
"metadata": {
"pagination": {
"count": 1,
"skip": 0,
"limit": 0
}
}
}Get App FeedbacksGET/app_feedbacks
Get the list of app feedbacks.
POST https://api-hub.maestrano.com/api/mnoe/v1/app_feedbacks
Requests
Body
{
"data": {
"user_id": 9,
"organization_id": 3,
"app_id": 43,
"rating": 5,
"description": "Awesome application"
}
Responses
Body
{
"data": {
"id": 58,
"rating": 5,
"description": "super",
"status": "approved",
"app_id": 48,
"app_name": "DemoApp Java",
"user_id": 9,
"user_name": "John MacGonagle",
"user_admin_role": "",
"organization_id": 3,
"organization_name": "Poudlard associate",
"type": "Feedback",
"parent_id": null,
"created_at": "2017-03-17T11:44:39.000Z",
"updated_at": "2017-03-17T11:44:39.000Z",
"edited": false,
"edited_by_name": null,
"edited_by_admin_role": null,
"edited_by_id": null,
"versions": [
{
"id": 52,
"created_at": "2017-03-17T11:44:39.000Z",
"description": null,
"event": "create",
"author": null
}
]
}
}Create New App FeedbackPOST/app_feedbacks
Create a new app feedback.
App Feedback ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/app_feedbacks/42
Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 58,
"rating": 5,
"description": "super",
"status": "approved",
"app_id": 48,
"app_name": "DemoApp Java",
"user_id": 9,
"user_name": "John MacGonagle",
"user_admin_role": "",
"organization_id": 3,
"organization_name": "Poudlard associate",
"type": "Feedback",
"parent_id": null,
"created_at": "2017-03-17T11:44:39.000Z",
"updated_at": "2017-03-17T11:44:39.000Z",
"edited": false,
"edited_by_name": null,
"edited_by_admin_role": null,
"edited_by_id": null,
"versions": [
{
"id": 52,
"created_at": "2017-03-17T11:44:39.000Z",
"description": null,
"event": "create",
"author": null
}
]
}
}Get App FeedbackGET/app_feedbacks/{id}
Get a single app feedback.
URI Parameters
- id
integer(required) Example: 42The app feedback ID
PUT https://api-hub.maestrano.com/api/mnoe/v1/app_feedbacks/42
Requests
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"description": "Updated"
}
}Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 58,
"rating": 5,
"description": "super",
"status": "approved",
"app_id": 48,
"app_name": "DemoApp Java",
"user_id": 9,
"user_name": "John MacGonagle",
"user_admin_role": "",
"organization_id": 3,
"organization_name": "Poudlard associate",
"type": "Feedback",
"parent_id": null,
"created_at": "2017-03-17T11:44:39.000Z",
"updated_at": "2017-03-17T11:44:39.000Z",
"edited": false,
"edited_by_name": null,
"edited_by_admin_role": null,
"edited_by_id": null,
"versions": [
{
"id": 52,
"created_at": "2017-03-17T11:44:39.000Z",
"description": null,
"event": "create",
"author": null
}
]
}
}Update an App FeedbackPUT/app_feedbacks/{id}
Update a single app feedback.
URI Parameters
- id
integer(required) Example: 42The app feedback ID
DELETE https://api-hub.maestrano.com/api/mnoe/v1/app_feedbacks/42
Requests
Headers
Content-Type: application/json; charset=utf-8Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 58,
"rating": 5,
"description": "super",
"status": "approved",
"app_id": 48,
"app_name": "DemoApp Java",
"user_id": 9,
"user_name": "John MacGonagle",
"user_admin_role": "",
"organization_id": 3,
"organization_name": "Poudlard associate",
"type": "Feedback",
"parent_id": null,
"created_at": "2017-03-17T11:44:39.000Z",
"updated_at": "2017-03-17T11:44:39.000Z",
"edited": false,
"edited_by_name": null,
"edited_by_admin_role": null,
"edited_by_id": null,
"versions": [
{
"id": 52,
"created_at": "2017-03-17T11:44:39.000Z",
"description": null,
"event": "create",
"author": null
}
]
}
}Delete an App FeedbackDELETE/app_feedbacks/{id}
Delete a single app feedback.
URI Parameters
- id
integer(required) Example: 42The app feedback ID
App Comments ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/app_comments
Responses
Body
{
"data": [
{
"id": 47,
"rating": 5,
"description": "What a nice application",
"status": "rejected",
"app_id": 15,
"app_name": "vtiger",
"user_id": 9,
"user_name": "John MacGonagle",
"user_admin_role": "",
"organization_id": 3,
"organization_name": "Poudlard associate",
"type": "Comment",
"parent_id": null,
"created_at": "2017-01-24T12:25:29.000Z",
"updated_at": "2017-02-01T18:08:33.000Z",
"edited": true,
"edited_by_name": null,
"edited_by_admin_role": null,
"edited_by_id": null
}
],
"metadata": {
"pagination": {
"count": 1,
"skip": 0,
"limit": 0
}
}
}Get App CommentsGET/app_comments
Get the list of app comments.
POST https://api-hub.maestrano.com/api/mnoe/v1/app_comments
Requests
Body
{
"data": {
"user_id": 9,
"organization_id": 3,
"app_id": 43,
"description": "This is my comment",
"feedback_id":1
}
Responses
Body
{
"data": {
"id": 58,
"rating": 5,
"description": "super",
"status": "approved",
"app_id": 48,
"app_name": "DemoApp Java",
"user_id": 9,
"user_name": "John MacGonagle",
"user_admin_role": "",
"organization_id": 3,
"organization_name": "Poudlard associate",
"type": "Comment",
"parent_id": null,
"created_at": "2017-03-17T11:44:39.000Z",
"updated_at": "2017-03-17T11:44:39.000Z",
"edited": false,
"edited_by_name": null,
"edited_by_admin_role": null,
"edited_by_id": null,
"versions": [
{
"id": 52,
"created_at": "2017-03-17T11:44:39.000Z",
"description": null,
"event": "create",
"author": null
}
]
}
}Create New App CommentPOST/app_comments
Create a new app comment.
App Comment ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/app_comments/42
Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 58,
"rating": 5,
"description": "super",
"status": "approved",
"app_id": 48,
"app_name": "DemoApp Java",
"user_id": 9,
"user_name": "John MacGonagle",
"user_admin_role": "",
"organization_id": 3,
"organization_name": "Poudlard associate",
"type": "Comment",
"parent_id": null,
"created_at": "2017-03-17T11:44:39.000Z",
"updated_at": "2017-03-17T11:44:39.000Z",
"edited": false,
"edited_by_name": null,
"edited_by_admin_role": null,
"edited_by_id": null,
"versions": [
{
"id": 52,
"created_at": "2017-03-17T11:44:39.000Z",
"description": null,
"event": "create",
"author": null
}
]
}
}Get App CommentGET/app_comments/{id}
Get a single app comment.
URI Parameters
- id
integer(required) Example: 42The app comment ID
PUT https://api-hub.maestrano.com/api/mnoe/v1/app_comments/42
Requests
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"description": "Updated"
}
}Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 58,
"rating": 5,
"description": "super",
"status": "approved",
"app_id": 48,
"app_name": "DemoApp Java",
"user_id": 9,
"user_name": "John MacGonagle",
"user_admin_role": "",
"organization_id": 3,
"organization_name": "Poudlard associate",
"type": "Comment",
"parent_id": null,
"created_at": "2017-03-17T11:44:39.000Z",
"updated_at": "2017-03-17T11:44:39.000Z",
"edited": false,
"edited_by_name": null,
"edited_by_admin_role": null,
"edited_by_id": null,
"versions": [
{
"id": 52,
"created_at": "2017-03-17T11:44:39.000Z",
"description": null,
"event": "create",
"author": null
}
]
}
}Update an App CommentPUT/app_comments/{id}
Update a single app comment.
URI Parameters
- id
integer(required) Example: 42The app comment ID
DELETE https://api-hub.maestrano.com/api/mnoe/v1/app_comments/42
Requests
Headers
Content-Type: application/json; charset=utf-8Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 58,
"rating": 5,
"description": "super",
"status": "approved",
"app_id": 48,
"app_name": "DemoApp Java",
"user_id": 9,
"user_name": "John MacGonagle",
"user_admin_role": "",
"organization_id": 3,
"organization_name": "Poudlard associate",
"type": "Comment",
"parent_id": null,
"created_at": "2017-03-17T11:44:39.000Z",
"updated_at": "2017-03-17T11:44:39.000Z",
"edited": false,
"edited_by_name": null,
"edited_by_admin_role": null,
"edited_by_id": null,
"versions": [
{
"id": 52,
"created_at": "2017-03-17T11:44:39.000Z",
"description": null,
"event": "create",
"author": null
}
]
}
}Delete an App CommentDELETE/app_comments/{id}
Delete a single app comment.
URI Parameters
- id
integer(required) Example: 42The app comment ID
App Questions ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/app_questions
Responses
Body
{
"data": {
"id": 67,
"rating": 5,
"description": "This is question. Why ?",
"status": "approved",
"app_id": 48,
"app_name": "DemoApp Java",
"user_id": 9,
"user_name": "John MacGonagle",
"user_admin_role": "",
"organization_id": 3,
"organization_name": "Poudlard associate",
"type": "Question",
"parent_id": null,
"created_at": "2017-03-17T15:33:45.000Z",
"updated_at": "2017-03-17T15:33:45.000Z",
"edited": false,
"edited_by_name": null,
"edited_by_admin_role": null,
"edited_by_id": null,
"versions": [
{
"id": 64,
"created_at": "2017-03-17T15:33:45.000Z",
"description": null,
"event": "create",
"author": null
}
],
"answers": [
{
"id": 68,
"rating": null,
"description": "This is my answer: Because!",
"status": "approved",
"app_id": 48,
"app_name": "DemoApp Java",
"user_id": 9,
"user_name": "John MacGonagle",
"user_admin_role": "",
"organization_id": 3,
"organization_name": "Poudlard associate",
"type": "Answer",
"parent_id": 67,
"created_at": "2017-03-17T15:35:15.000Z",
"updated_at": "2017-03-17T15:35:15.000Z",
"edited": false,
"edited_by_name": null,
"edited_by_admin_role": null,
"edited_by_id": null
}
]
}
}Get App QuestionsGET/app_questions
Get the list of app questions.
POST https://api-hub.maestrano.com/api/mnoe/v1/app_questions
Requests
Body
{
"data": {
"user_id": 9,
"organization_id": 3,
"app_id": 48,
"description": "This is question. Why ?"
}
}Responses
Body
{
"data": {
"id": 67,
"rating": 5,
"description": "This is question. Why ?",
"status": "approved",
"app_id": 48,
"app_name": "DemoApp Java",
"user_id": 9,
"user_name": "John MacGonagle",
"user_admin_role": "",
"organization_id": 3,
"organization_name": "Poudlard associate",
"type": "Question",
"parent_id": null,
"created_at": "2017-03-17T15:33:45.000Z",
"updated_at": "2017-03-17T15:33:45.000Z",
"edited": false,
"edited_by_name": null,
"edited_by_admin_role": null,
"edited_by_id": null,
"versions": [
{
"id": 64,
"created_at": "2017-03-17T15:33:45.000Z",
"description": null,
"event": "create",
"author": null
}
],
"answers": []
}
}Create New App QuestionPOST/app_questions
Create a new app question.
App Question ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/app_questions/42
Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 58,
"rating": 5,
"description": "super",
"status": "approved",
"app_id": 48,
"app_name": "DemoApp Java",
"user_id": 9,
"user_name": "John MacGonagle",
"user_admin_role": "",
"organization_id": 3,
"organization_name": "Poudlard associate",
"type": "Question",
"parent_id": null,
"created_at": "2017-03-17T11:44:39.000Z",
"updated_at": "2017-03-17T11:44:39.000Z",
"edited": false,
"edited_by_name": null,
"edited_by_admin_role": null,
"edited_by_id": null,
"versions": [
{
"id": 52,
"created_at": "2017-03-17T11:44:39.000Z",
"description": null,
"event": "create",
"author": null
}
]
}
}Get App QuestionGET/app_questions/{id}
Get a single app question.
URI Parameters
- id
integer(required) Example: 42The app question ID
PUT https://api-hub.maestrano.com/api/mnoe/v1/app_questions/42
Requests
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"description": "Updated"
}
}Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 58,
"rating": 5,
"description": "super",
"status": "approved",
"app_id": 48,
"app_name": "DemoApp Java",
"user_id": 9,
"user_name": "John MacGonagle",
"user_admin_role": "",
"organization_id": 3,
"organization_name": "Poudlard associate",
"type": "Question",
"parent_id": null,
"created_at": "2017-03-17T11:44:39.000Z",
"updated_at": "2017-03-17T11:44:39.000Z",
"edited": false,
"edited_by_name": null,
"edited_by_admin_role": null,
"edited_by_id": null,
"versions": [
{
"id": 52,
"created_at": "2017-03-17T11:44:39.000Z",
"description": null,
"event": "create",
"author": null
}
]
}
}Update an App QuestionPUT/app_questions/{id}
Update a single app question.
URI Parameters
- id
integer(required) Example: 42The app question ID
DELETE https://api-hub.maestrano.com/api/mnoe/v1/app_questions/42
Requests
Headers
Content-Type: application/json; charset=utf-8Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 58,
"rating": 5,
"description": "super",
"status": "approved",
"app_id": 48,
"app_name": "DemoApp Java",
"user_id": 9,
"user_name": "John MacGonagle",
"user_admin_role": "",
"organization_id": 3,
"organization_name": "Poudlard associate",
"type": "Question",
"parent_id": null,
"created_at": "2017-03-17T11:44:39.000Z",
"updated_at": "2017-03-17T11:44:39.000Z",
"edited": false,
"edited_by_name": null,
"edited_by_admin_role": null,
"edited_by_id": null,
"versions": [
{
"id": 52,
"created_at": "2017-03-17T11:44:39.000Z",
"description": null,
"event": "create",
"author": null
}
]
}
}Delete an App QuestionDELETE/app_questions/{id}
Delete a single app question.
URI Parameters
- id
integer(required) Example: 42The app question ID
App Answers ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/app_answers
Responses
Body
{
"data": [
{
"id": 60,
"rating": 5,
"description": "super",
"status": "approved",
"app_id": 48,
"app_name": "DemoApp Java",
"user_id": 9,
"user_name": "John MacGonagle",
"user_admin_role": "",
"organization_id": 3,
"organization_name": "Poudlard associate",
"type": "Answer",
"parent_id": null,
"created_at": "2017-03-17T14:32:18.000Z",
"updated_at": "2017-03-17T14:32:18.000Z",
"edited": false,
"edited_by_name": null,
"edited_by_admin_role": null,
"edited_by_id": null
}
],
"metadata": {
"pagination": {
"count": 1,
"skip": 0,
"limit": 0
}
}
}Get App AnswersGET/app_answers
Get the list of app answers.
POST https://api-hub.maestrano.com/api/mnoe/v1/app_answers
Requests
Body
{
"data": {
"user_id": 9,
"organization_id": 3,
"app_id": 43,
"description": "This is my answer",
"question_id":1
}
Responses
Body
{
"data": {
"id": 63,
"rating": null,
"description": "created by me",
"status": "approved",
"app_id": 48,
"app_name": "DemoApp Java",
"user_id": 9,
"user_name": "John MacGonagle",
"user_admin_role": "",
"organization_id": 3,
"organization_name": "Poudlard associate",
"type": "Answer",
"parent_id": 59,
"created_at": "2017-03-17T15:15:45.000Z",
"updated_at": "2017-03-17T15:15:45.000Z",
"edited": false,
"edited_by_name": null,
"edited_by_admin_role": null,
"edited_by_id": null,
"versions": [
{
"id": 59,
"created_at": "2017-03-17T15:15:45.000Z",
"description": null,
"event": "create",
"author": null
}
]
}
}Create New App AnswerPOST/app_answers
Create a new app answer.
App Answer ¶
GET https://api-hub.maestrano.com/api/mnoe/v1/app_answers/42
Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 63,
"rating": null,
"description": "created by me",
"status": "approved",
"app_id": 48,
"app_name": "DemoApp Java",
"user_id": 9,
"user_name": "John MacGonagle",
"user_admin_role": "",
"organization_id": 3,
"organization_name": "Poudlard associate",
"type": "Answer",
"parent_id": 59,
"created_at": "2017-03-17T15:15:45.000Z",
"updated_at": "2017-03-17T15:15:45.000Z",
"edited": false,
"edited_by_name": null,
"edited_by_admin_role": null,
"edited_by_id": null,
"versions": [
{
"id": 59,
"created_at": "2017-03-17T15:15:45.000Z",
"description": null,
"event": "create",
"author": null
}
]
}
}Get App AnswerGET/app_answers/{id}
Get a single app answer.
URI Parameters
- id
integer(required) Example: 42The app answer ID
PUT https://api-hub.maestrano.com/api/mnoe/v1/app_answers/42
Requests
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"description": "Edited Answer"
}
}Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 63,
"rating": null,
"description": "created by me",
"status": "approved",
"app_id": 48,
"app_name": "DemoApp Java",
"user_id": 9,
"user_name": "John MacGonagle",
"user_admin_role": "",
"organization_id": 3,
"organization_name": "Poudlard associate",
"type": "Answer",
"parent_id": 59,
"created_at": "2017-03-17T15:15:45.000Z",
"updated_at": "2017-03-17T15:15:45.000Z",
"edited": false,
"edited_by_name": null,
"edited_by_admin_role": null,
"edited_by_id": null,
"versions": [
{
"id": 59,
"created_at": "2017-03-17T15:15:45.000Z",
"description": null,
"event": "create",
"author": null
}
]
}
}Update an App AnswerPUT/app_answers/{id}
Update a single app answer.
URI Parameters
- id
integer(required) Example: 42The app answer ID
DELETE https://api-hub.maestrano.com/api/mnoe/v1/app_answers/42
Requests
Headers
Content-Type: application/json; charset=utf-8Responses
Headers
Content-Type: application/json; charset=utf-8Body
{
"data": {
"id": 63,
"rating": null,
"description": "created by me",
"status": "approved",
"app_id": 48,
"app_name": "DemoApp Java",
"user_id": 9,
"user_name": "John MacGonagle",
"user_admin_role": "",
"organization_id": 3,
"organization_name": "Poudlard associate",
"type": "Answer",
"parent_id": 59,
"created_at": "2017-03-17T15:15:45.000Z",
"updated_at": "2017-03-17T15:15:45.000Z",
"edited": false,
"edited_by_name": null,
"edited_by_admin_role": null,
"edited_by_id": null,
"versions": [
{
"id": 59,
"created_at": "2017-03-17T15:15:45.000Z",
"description": null,
"event": "create",
"author": null
}
]
}
}Delete an App AnswerDELETE/app_answers/{id}
Delete a single app answer.
URI Parameters
- id
integer(required) Example: 42The app answer ID
Generated by aglio on 21 Sep 2018