Check Login
Request Token
Explore Api
Dashboards
Dashboard
List dashboard roles - shared accounts
List all Resources on Dashboard
List of Resource instances on dashboard
Dashboard Resource
Resource Instances
Resource Instance
My Account
Account Profile Image
Account Partner
Account Application instances
Resource Instances Personal
Resource Instances Shared With Me
Resource Instances Shared With Me Company
Account Resource instance
My Account's Resources
Account Resource
Account Two-Factor Authentication
Two-factor Authentication recovery codes
Change Password
Account's Authorized Apps
Me Authorized Apps ID
Account Logs
Template Resources
Single Resource
Switch Resource
Resource's Log
Resource's Subscribers
Resource's Track Events
Notifications
Accounts
Account
Share Accounts
Companies
Create Company
Company
Company Transfer Token
Company Resources
Company OrgUnits
Company OrgUnit
Company OrgUnit Resources
Company OrgUnit Roles
Company Domains
Company Domain
Verify Company Domain
Company Billing Credit Card
Company Billing Public Key
Company Billing Subscription
Company Billing Invoice List
Company Billing Invoice Upcoming
Company Billing Invoice Send
Company Log Events
Company Log
Company Directory Roles
Company Directory Role
Company Directory Role Resources
Company Directory Role Can Be Manage
Company Directory Role Change Password
Company Directory Role Notification
Company Directory Role Two Factor Authentication
Company Directory Role Import
Company Directory Role Log
Company Directory Role Org Units
Available Integrations
Available Integration
Active Integrations
Single Active Integration
PSO Active Integration
PSO Appsco Active Integration
Active Integration Recipes
Single Active Integration Recipe
Single Active Integration Recipe Run
Active Integration Web Hooks
Single Active Integration Web Hook
Company Directory Invitation
Company Directory Resend Invitation
Company Directory Invitation
Company Settings
Company Branding
Company Logo
Company Signup
Confirm Company Signup Request
Delete Company Signup Request
Company Labels
Company Label
Label Company Roles
Label Company Role
Label Company Resources
Label Company Resource
Company Statistics Two Factor
Company Statistics Licences
Company Statistics User Password Scores
Company Contacts
Company Contact
Company Contact Convert to User
Company Contact Applications
Import Company Contacts
Company Groups
Company Group
Delete Company Group Role
Company Groups Role
Company Groups Contacts
Company Contact
Company Groups Applications
Company Groups Applications
Company Contact Groups
Company Roles Groups
Company Applications Groups
Company Oauth Applications
Company Oauth Authorizations Count
Single Oauth Application
Oauth Application Certificate
Remove Oauth Application Certificate
Customers List
Customer
Customer Log
Export Customers
Import Customers
Import Resources
Customer Partner Admins
Single Customer Partner Admin
Customer Licences
Customer Exists

AppsCo


AppsCo helps you securely manage all your private applications access and digital confidential information from any device.

How to use AppsCo api

Appsco API supports OAuth protocol. OAuth Request code in order to retrieve token for loggedin user. Use client id and scope in order to request equivalent token. Redirect uri can be used for redirect response. System will return code which you can later use to retrieve access_token.

Dashboard

Dashboard represents holder for application instances. Its content will be presented to user. User can have only one dashboard, but many dashboards can be shared to user. Sharing a dashboard is creating specific role for that user. This role is used to log all user interactions in the system.

Account

Account in AppsCo represents user identity. Identity can be used to interact with other software. All actions that are preformed by the identity or in the name of the identity are loggeed in the system.

Application Template

Applicaiton Template represents import from application catalog list. These applications are used by user in order to setup application credentials. AppsCo uses them in order to perform login. Application catalog is a separate system that AppsCo uses in order to provide as many applications as possible to the user. This list also holds methods of authentication. Supported authentication methods

  • Form Fill

  • Auto Login

  • SAML

  • JWT

Application

Application is an instance of application template and is further used for configuring credentials. Application is used to store all user interactions with the resource credentials, login user, share credentials with other users. Shared Application represents instance of application that is assigned to the user.

Application instance (Application Icon)

Application instance represents instance of application and it is unique for the user. Each interaction with application icon is logged in the application it self. If application is removed all coresponding application icons will be also removed.

AppsCo Log

  • Create Resource

  • Resource Claims Update

  • Resource Update

  • Resource remove from org unit

  • Resource removed

  • Resource icon removed

  • Resource shared

  • Resource icon claims updated

  • Subscription update

  • Cancel subscription

  • Send invoice to email

  • Create credit card - change payment method

  • Remove company role

  • Promote company role to admin

  • Remove admin role from company member

  • Company admin updated company memeber

  • Company admin changed company memeber password

  • Company member added

  • Company members imported from csv

  • Company member removed from orgunit

  • Organization unit create

  • Update organization unit

  • Remove organization unit

  • Add resource to organization unit

  • Add account to organization unit

  • Application remove from organization unit

  • Company settings updated

  • Company logo changed

  • Account attemted login

  • Account updated profile

  • Account updated profile image

  • Account generated partner token

  • Account enabled 2fa

  • Account disabled 2fa

  • Account chnaged password

  • Account authorized application

  • Account revoked application authorization

Company OrgUnits

Company represents something to write…

OrgUnit - Resource - Account policy

OrgUnit is something something

Check Login

Login check.

Login check

REQUEST

RESPONSE

Headers
Content-Type application/json
Request Token

In order to retrieve token user should first perform OAuth request which will provide code. Code is used after that to retrieve token. To retrieve token use code and basic authentication using your app credentials (client_id, client_secret).

Exchange code and resource credentials for token

REQUEST

Headers
Authorization Basic base64

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "token": "7hw0fqyydegws8sg40s40wgco04sgoog404oookk4ooccgsws2pxjq4rkeccg0co0wsk8skccoccsg00cwocwwc80skss04kkwc"
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "description": "Requested user's token"
    }
  }
}
                      
Explore Api

This link can be used to retrieve list of all available resources. In order to access this list user first need to authenticate.

Retrieve api resources

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type applicaiton/json
200 applicaiton/json
                        {
  "versions": {
    "v2": {
      "dashboards": "https://www.appsco.com/api/v2/dashboards",
      "me": "https://www.appsco.com/api/v2/me",
      "application": "https://www.appsco.com/api/v2/applications",
      "notifications": "https://www.appsco.com/api/v2/notifications",
      "accounts": "https://www.appsco.com/api/v2/accounts",
      "devices": "https://www.appsco.com/api/v2/devices",
      "vault-cc": "https://www.appsco.com/api/v2/vault-cc",
      "vault-identity": "https://www.appsco.com/api/v2/vault-identity",
      "vault-login": "https://www.appsco.com/api/v2/vault",
      "vault-passport": "https://www.appsco.com/api/v2/vault-passport",
      "vault-secure-note": "https://www.appsco.com/api/v2/vault-secure-note",
      "vault-software-licence": "https://www.appsco.com/api/v2/vault-software-licence"
    }
  }
}

                      
                        
                      
Dashboards

List all dashboards that user has right to access.

Retrieve Dashboards

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "dashboards": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "dashboards": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
Dashboard

Returns dashboard details.

Retrieve Dashboard

REQUEST

Parameters
dashboardRole number 551

ID of the Dashboard Role

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "dashboard": {
    "role_id": 0,
    "alias": 0,
    "title": "",
    "roles": {
      "OWNER": "",
      "ADMIN": "",
      "SHARED": ""
    },
    "default_dashboard": false,
    "logo": "",
    "self": ""
  },
  "meta": {
    "icons": {
      "icons": [],
      "count": 0,
      "self": ""
    },
    "accounts": "",
    "applications": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "dashboard": {
      "type": "object",
      "properties": {
        "role_id": {
          "type": "number",
          "description": "Dashboard Role id"
        },
        "alias": {
          "type": "number",
          "description": "Dashboard Role alias"
        },
        "title": {
          "type": "string",
          "description": "Dashboard Name"
        },
        "roles": {
          "type": "object",
          "properties": {
            "OWNER": {
              "type": "string"
            },
            "ADMIN": {
              "type": "string"
            },
            "SHARED": {
              "type": "string"
            }
          },
          "required": [
            "OWNER",
            "ADMIN",
            "SHARED"
          ],
          "additionalProperties": false
        },
        "default_dashboard": {
          "type": "boolean",
          "description": "Is this dashboard your default dashboard"
        },
        "logo": {
          "type": "string",
          "description": "Dashboard Logo"
        },
        "self": {
          "type": "string",
          "description": "Resource location"
        }
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "icons": {
          "type": "object",
          "properties": {
            "icons": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "count": {
              "type": "number",
              "description": "Number of icons"
            },
            "self": {
              "type": "string",
              "description": "Application instances resource"
            }
          }
        },
        "accounts": {
          "type": "string",
          "description": "Dashboard roles that belong to dashboard"
        },
        "applications": {
          "type": "string",
          "description": "Dashboard applications"
        }
      }
    }
  }
}
                      
List dashboard roles - shared accounts

List all accounts that have shared application on the dashboard.

Retrieve dashboard accounts

REQUEST

Parameters
dashboardRole number 551

ID of the Dashboard Role

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "accounts": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "accounts": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
List all Resources on Dashboard

Return all dashboard resources.

Retrieve dashboard resources

REQUEST

Parameters
dashboardRole number 551

ID of the Dashboard Role

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "applications": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "applications": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
List of Resource instances on dashboard

Returns all available resource instances (icons) of the specific dashboard role.

Retrieve icons

REQUEST

Parameters
dashboardRole number 551

ID of the Dashboard Role

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "icons": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "icons": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      

Create resource instance

This call will also fire Modify resource instance claims [PATCH] if you add username, password or note.

REQUEST

Parameters
dashboardRole number 551

ID of the Dashboard Role

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "icon": {
    "application": "",
    "alias": 0,
    "title": "",
    "auth_type": "",
    "is_configured": false,
    "url_editable": false,
    "icon_url": "",
    "url": "",
    "images": [],
    "owner": false,
    "self": "",
    "security": {
      "password_strength": 0,
      "info": {
        "upper_case": false,
        "lower_case": false,
        "digits": false,
        "special_chars": false,
        "length8": false,
        "length16": false,
        "entropy": 0
      },
      "last_update": "",
      "score": 0
    },
    "claims": {
      "username": "",
      "password": "",
      "note": ""
    },
    "meta": {
      "log": "",
      "autologin": "",
      "subscribers": "",
      "application-remove": "",
      "plugin_go": ""
    }
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "icon": {
      "type": "object",
      "properties": {
        "application": {
          "type": "string",
          "description": "Resource location of the application template"
        },
        "alias": {
          "type": "number",
          "description": "Application icon alias"
        },
        "title": {
          "type": "string",
          "description": "Application title"
        },
        "auth_type": {
          "type": "string",
          "description": "Authentication type"
        },
        "is_configured": {
          "type": "boolean",
          "description": "Is Application icon configured"
        },
        "url_editable": {
          "type": "boolean",
          "description": "Can you edit application icon uri"
        },
        "icon_url": {
          "type": "string",
          "description": "Application icon"
        },
        "url": {
          "type": "string",
          "description": "Application url"
        },
        "images": {
          "type": "array",
          "description": "List of application icons"
        },
        "owner": {
          "type": "boolean",
          "description": "Do you own this application?"
        },
        "self": {
          "type": "string",
          "description": "Resource location to it self"
        },
        "security": {
          "type": "object",
          "properties": {
            "password_strength": {
              "type": "number",
              "description": "How strong is the password from 0 to 100"
            },
            "info": {
              "type": "object",
              "properties": {
                "upper_case": {
                  "type": "boolean",
                  "description": "Does it contain upper case letters"
                },
                "lower_case": {
                  "type": "boolean",
                  "description": "Does it contain lower case letters"
                },
                "digits": {
                  "type": "boolean",
                  "description": "Does it contain digits"
                },
                "special_chars": {
                  "type": "boolean",
                  "description": "Does it contain special characters"
                },
                "length8": {
                  "type": "boolean",
                  "description": "Is length greater then 8 characters"
                },
                "length16": {
                  "type": "boolean",
                  "description": "Is length greater then 16 characters"
                },
                "entropy": {
                  "type": "number",
                  "description": "What is the entropy"
                }
              },
              "description": "Additional info"
            },
            "last_update": {
              "type": "string",
              "description": "When is it last updated"
            },
            "score": {
              "type": "number",
              "description": "Overall score"
            }
          },
          "description": "Application icon security based on policies"
        },
        "claims": {
          "type": "object",
          "properties": {
            "username": {
              "type": "string",
              "description": "User's username for application"
            },
            "password": {
              "type": "string",
              "description": "User's password for application"
            },
            "note": {
              "type": "string",
              "description": "User's note for application"
            }
          },
          "description": "Claims based on auth type"
        },
        "meta": {
          "type": "object",
          "properties": {
            "log": {
              "type": "string",
              "description": "Log of all the actions on application"
            },
            "autologin": {
              "type": "string",
              "description": "Switch authentication types between form fill and autologin"
            },
            "subscribers": {
              "type": "string",
              "description": "Accounts that this application is shared to"
            },
            "application-remove": {
              "type": "string",
              "description": "Remove application"
            },
            "plugin_go": {
              "type": "string",
              "description": "Attempt login"
            }
          }
        }
      }
    }
  }
}
                      
Dashboard Resource

Modify resource instance claims

REQUEST

Parameters
dashboard number 551

ID of the Dashboard in the form of an integer

icon number 247155

ID of the Icon in the form of an integer

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "icon": {
    "application": "",
    "alias": 0,
    "title": "",
    "auth_type": "",
    "is_configured": false,
    "url_editable": false,
    "icon_url": "",
    "url": "",
    "images": [],
    "owner": false,
    "self": "",
    "security": {
      "password_strength": 0,
      "info": {
        "upper_case": false,
        "lower_case": false,
        "digits": false,
        "special_chars": false,
        "length8": false,
        "length16": false,
        "entropy": 0
      },
      "last_update": "",
      "score": 0
    },
    "claims": {
      "username": "",
      "password": "",
      "note": ""
    },
    "meta": {
      "log": "",
      "autologin": "",
      "subscribers": "",
      "application-remove": "",
      "plugin_go": ""
    }
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "icon": {
      "type": "object",
      "properties": {
        "application": {
          "type": "string",
          "description": "Resource location of the application template"
        },
        "alias": {
          "type": "number",
          "description": "Application icon alias"
        },
        "title": {
          "type": "string",
          "description": "Application title"
        },
        "auth_type": {
          "type": "string",
          "description": "Authentication type"
        },
        "is_configured": {
          "type": "boolean",
          "description": "Is Application icon configured"
        },
        "url_editable": {
          "type": "boolean",
          "description": "Can you edit application icon uri"
        },
        "icon_url": {
          "type": "string",
          "description": "Application icon"
        },
        "url": {
          "type": "string",
          "description": "Application url"
        },
        "images": {
          "type": "array",
          "description": "List of application icons"
        },
        "owner": {
          "type": "boolean",
          "description": "Do you own this application?"
        },
        "self": {
          "type": "string",
          "description": "Resource location to it self"
        },
        "security": {
          "type": "object",
          "properties": {
            "password_strength": {
              "type": "number",
              "description": "How strong is the password from 0 to 100"
            },
            "info": {
              "type": "object",
              "properties": {
                "upper_case": {
                  "type": "boolean",
                  "description": "Does it contain upper case letters"
                },
                "lower_case": {
                  "type": "boolean",
                  "description": "Does it contain lower case letters"
                },
                "digits": {
                  "type": "boolean",
                  "description": "Does it contain digits"
                },
                "special_chars": {
                  "type": "boolean",
                  "description": "Does it contain special characters"
                },
                "length8": {
                  "type": "boolean",
                  "description": "Is length greater then 8 characters"
                },
                "length16": {
                  "type": "boolean",
                  "description": "Is length greater then 16 characters"
                },
                "entropy": {
                  "type": "number",
                  "description": "What is the entropy"
                }
              },
              "description": "Additional info"
            },
            "last_update": {
              "type": "string",
              "description": "When is it last updated"
            },
            "score": {
              "type": "number",
              "description": "Overall score"
            }
          },
          "description": "Application icon security based on policies"
        },
        "claims": {
          "type": "object",
          "properties": {
            "username": {
              "type": "string",
              "description": "User's username for application"
            },
            "password": {
              "type": "string",
              "description": "User's password for application"
            },
            "note": {
              "type": "string",
              "description": "User's note for application"
            }
          },
          "description": "Claims based on auth type"
        },
        "meta": {
          "type": "object",
          "properties": {
            "log": {
              "type": "string",
              "description": "Log of all the actions on application"
            },
            "autologin": {
              "type": "string",
              "description": "Switch authentication types between form fill and autologin"
            },
            "subscribers": {
              "type": "string",
              "description": "Accounts that this application is shared to"
            },
            "application-remove": {
              "type": "string",
              "description": "Remove application"
            },
            "plugin_go": {
              "type": "string",
              "description": "Attempt login"
            }
          }
        }
      }
    }
  }
}
                      
Resource Instances

Return and update resource instance for the current dashboard user.

Retrieve resource instances

REQUEST

Parameters
dashboard number 551

ID of the Dashboard in the form of an integer

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "icons": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "icons": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
Resource Instance
Return and update resource instance for the current dashboard user.

Retrieve resource instance

REQUEST

Parameters
dashboard number 551

ID of the Dashboard in the form of an integer

icon number 247155

ID of the Icon in the form of an integer

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "icon": {
    "application": "",
    "alias": 0,
    "title": "",
    "auth_type": "",
    "is_configured": false,
    "url_editable": false,
    "icon_url": "",
    "url": "",
    "images": [],
    "owner": false,
    "self": "",
    "security": {
      "password_strength": 0,
      "info": {
        "upper_case": false,
        "lower_case": false,
        "digits": false,
        "special_chars": false,
        "length8": false,
        "length16": false,
        "entropy": 0
      },
      "last_update": "",
      "score": 0
    },
    "claims": {
      "username": "",
      "password": "",
      "note": ""
    },
    "meta": {
      "log": "",
      "autologin": "",
      "subscribers": "",
      "application-remove": "",
      "plugin_go": ""
    }
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "icon": {
      "type": "object",
      "properties": {
        "application": {
          "type": "string",
          "description": "Resource location of the application template"
        },
        "alias": {
          "type": "number",
          "description": "Application icon alias"
        },
        "title": {
          "type": "string",
          "description": "Application title"
        },
        "auth_type": {
          "type": "string",
          "description": "Authentication type"
        },
        "is_configured": {
          "type": "boolean",
          "description": "Is Application icon configured"
        },
        "url_editable": {
          "type": "boolean",
          "description": "Can you edit application icon uri"
        },
        "icon_url": {
          "type": "string",
          "description": "Application icon"
        },
        "url": {
          "type": "string",
          "description": "Application url"
        },
        "images": {
          "type": "array",
          "description": "List of application icons"
        },
        "owner": {
          "type": "boolean",
          "description": "Do you own this application?"
        },
        "self": {
          "type": "string",
          "description": "Resource location to it self"
        },
        "security": {
          "type": "object",
          "properties": {
            "password_strength": {
              "type": "number",
              "description": "How strong is the password from 0 to 100"
            },
            "info": {
              "type": "object",
              "properties": {
                "upper_case": {
                  "type": "boolean",
                  "description": "Does it contain upper case letters"
                },
                "lower_case": {
                  "type": "boolean",
                  "description": "Does it contain lower case letters"
                },
                "digits": {
                  "type": "boolean",
                  "description": "Does it contain digits"
                },
                "special_chars": {
                  "type": "boolean",
                  "description": "Does it contain special characters"
                },
                "length8": {
                  "type": "boolean",
                  "description": "Is length greater then 8 characters"
                },
                "length16": {
                  "type": "boolean",
                  "description": "Is length greater then 16 characters"
                },
                "entropy": {
                  "type": "number",
                  "description": "What is the entropy"
                }
              },
              "description": "Additional info"
            },
            "last_update": {
              "type": "string",
              "description": "When is it last updated"
            },
            "score": {
              "type": "number",
              "description": "Overall score"
            }
          },
          "description": "Application icon security based on policies"
        },
        "claims": {
          "type": "object",
          "properties": {
            "username": {
              "type": "string",
              "description": "User's username for application"
            },
            "password": {
              "type": "string",
              "description": "User's password for application"
            },
            "note": {
              "type": "string",
              "description": "User's note for application"
            }
          },
          "description": "Claims based on auth type"
        },
        "meta": {
          "type": "object",
          "properties": {
            "log": {
              "type": "string",
              "description": "Log of all the actions on application"
            },
            "autologin": {
              "type": "string",
              "description": "Switch authentication types between form fill and autologin"
            },
            "subscribers": {
              "type": "string",
              "description": "Accounts that this application is shared to"
            },
            "application-remove": {
              "type": "string",
              "description": "Remove application"
            },
            "plugin_go": {
              "type": "string",
              "description": "Attempt login"
            }
          }
        }
      }
    }
  }
}
                      

Modify resource instance claims

REQUEST

Parameters
dashboard number 551

ID of the Dashboard in the form of an integer

icon number 247155

ID of the Icon in the form of an integer

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "icon": {
    "application": "",
    "alias": 0,
    "title": "",
    "auth_type": "",
    "is_configured": false,
    "url_editable": false,
    "icon_url": "",
    "url": "",
    "images": [],
    "owner": false,
    "self": "",
    "security": {
      "password_strength": 0,
      "info": {
        "upper_case": false,
        "lower_case": false,
        "digits": false,
        "special_chars": false,
        "length8": false,
        "length16": false,
        "entropy": 0
      },
      "last_update": "",
      "score": 0
    },
    "claims": {
      "username": "",
      "password": "",
      "note": ""
    },
    "meta": {
      "log": "",
      "autologin": "",
      "subscribers": "",
      "application-remove": "",
      "plugin_go": ""
    }
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "icon": {
      "type": "object",
      "properties": {
        "application": {
          "type": "string",
          "description": "Resource location of the application template"
        },
        "alias": {
          "type": "number",
          "description": "Application icon alias"
        },
        "title": {
          "type": "string",
          "description": "Application title"
        },
        "auth_type": {
          "type": "string",
          "description": "Authentication type"
        },
        "is_configured": {
          "type": "boolean",
          "description": "Is Application icon configured"
        },
        "url_editable": {
          "type": "boolean",
          "description": "Can you edit application icon uri"
        },
        "icon_url": {
          "type": "string",
          "description": "Application icon"
        },
        "url": {
          "type": "string",
          "description": "Application url"
        },
        "images": {
          "type": "array",
          "description": "List of application icons"
        },
        "owner": {
          "type": "boolean",
          "description": "Do you own this application?"
        },
        "self": {
          "type": "string",
          "description": "Resource location to it self"
        },
        "security": {
          "type": "object",
          "properties": {
            "password_strength": {
              "type": "number",
              "description": "How strong is the password from 0 to 100"
            },
            "info": {
              "type": "object",
              "properties": {
                "upper_case": {
                  "type": "boolean",
                  "description": "Does it contain upper case letters"
                },
                "lower_case": {
                  "type": "boolean",
                  "description": "Does it contain lower case letters"
                },
                "digits": {
                  "type": "boolean",
                  "description": "Does it contain digits"
                },
                "special_chars": {
                  "type": "boolean",
                  "description": "Does it contain special characters"
                },
                "length8": {
                  "type": "boolean",
                  "description": "Is length greater then 8 characters"
                },
                "length16": {
                  "type": "boolean",
                  "description": "Is length greater then 16 characters"
                },
                "entropy": {
                  "type": "number",
                  "description": "What is the entropy"
                }
              },
              "description": "Additional info"
            },
            "last_update": {
              "type": "string",
              "description": "When is it last updated"
            },
            "score": {
              "type": "number",
              "description": "Overall score"
            }
          },
          "description": "Application icon security based on policies"
        },
        "claims": {
          "type": "object",
          "properties": {
            "username": {
              "type": "string",
              "description": "User's username for application"
            },
            "password": {
              "type": "string",
              "description": "User's password for application"
            },
            "note": {
              "type": "string",
              "description": "User's note for application"
            }
          },
          "description": "Claims based on auth type"
        },
        "meta": {
          "type": "object",
          "properties": {
            "log": {
              "type": "string",
              "description": "Log of all the actions on application"
            },
            "autologin": {
              "type": "string",
              "description": "Switch authentication types between form fill and autologin"
            },
            "subscribers": {
              "type": "string",
              "description": "Accounts that this application is shared to"
            },
            "application-remove": {
              "type": "string",
              "description": "Remove application"
            },
            "plugin_go": {
              "type": "string",
              "description": "Attempt login"
            }
          }
        }
      }
    }
  }
}
                      

Remove resource instance from the dashboard

This call will also log the user changes for the Resource.

REQUEST

Parameters
dashboard number 551

ID of the Dashboard in the form of an integer

icon number 247155

ID of the Icon in the form of an integer

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "Response": {
    "message": "",
    "code": 0
  },
  "meta": {
    "icons": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "Response": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string"
        },
        "code": {
          "type": "number"
        }
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "icons": {
          "type": "string",
          "description": "List all dashboard role resource instances"
        }
      }
    }
  }
}
                      
My Account

Return AppsCo user account information.

Retrieve user account information

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "account": {
    "id": 0,
    "dashboardRole": {},
    "email": "",
    "timezone": "",
    "country": "",
    "created_at": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "name": "",
    "enabled": false,
    "first_name": "",
    "last_name": "",
    "gender": "",
    "last_login": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "locale": "",
    "phone": "",
    "picture_url": "",
    "username": "",
    "roles": [],
    "display_name": "",
    "org_units": [],
    "company": {
      "alias": 0,
      "name": "",
      "contact_email": "",
      "domain": "",
      "intranet_website": "",
      "remaining_trial_period": 0,
      "trial_period": 0,
      "image": "",
      "primary_color": "",
      "secondary_color": "",
      "self": "",
      "meta": {
        "applications": "",
        "settings": "",
        "logo": ""
      }
    },
    "meta": {
      "share": ""
    },
    "self": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "account": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Id of the identity"
        },
        "dashboardRole": {
          "type": "object",
          "properties": {},
          "description": "List of dashboard roles"
        },
        "email": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "created_at": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "name": {
          "type": "string",
          "description": "Concat First name and Last name, if not present then email"
        },
        "enabled": {
          "type": "boolean"
        },
        "first_name": {
          "type": "string"
        },
        "last_name": {
          "type": "string"
        },
        "gender": {
          "type": "string"
        },
        "last_login": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "locale": {
          "type": "string"
        },
        "phone": {
          "type": "string"
        },
        "picture_url": {
          "type": "string"
        },
        "username": {
          "type": "string"
        },
        "roles": {
          "type": "array"
        },
        "display_name": {
          "type": "string"
        },
        "org_units": {},
        "company": {
          "type": "object",
          "properties": {
            "alias": {
              "type": "number"
            },
            "name": {
              "type": "string",
              "description": "Company Name"
            },
            "contact_email": {
              "type": "string",
              "description": "Contact email"
            },
            "domain": {
              "type": "string",
              "description": "Company domain"
            },
            "intranet_website": {
              "type": "string",
              "description": "Company internal website on mosaic"
            },
            "remaining_trial_period": {
              "type": "number",
              "description": "Remaining trial period for AppsCo Business package"
            },
            "trial_period": {
              "type": "number",
              "description": "How big is the trial period"
            },
            "image": {
              "type": "string",
              "description": "Company logo"
            },
            "primary_color": {
              "type": "string"
            },
            "secondary_color": {
              "type": "string"
            },
            "self": {
              "type": "string",
              "description": "Company self resource"
            },
            "meta": {
              "type": "object",
              "properties": {
                "applications": {
                  "type": "string",
                  "description": "Company applications"
                },
                "settings": {
                  "type": "string",
                  "description": "Company settings"
                },
                "logo": {
                  "type": "string",
                  "description": "Create Company logo"
                }
              }
            }
          }
        },
        "meta": {
          "type": "object",
          "properties": {
            "share": {
              "type": "string",
              "description": "Resource link for sharing application to account"
            }
          }
        },
        "self": {
          "type": "string"
        }
      }
    }
  }
}
                      

Update account

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "account": {
    "id": 0,
    "dashboardRole": {},
    "email": "",
    "timezone": "",
    "country": "",
    "created_at": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "name": "",
    "enabled": false,
    "first_name": "",
    "last_name": "",
    "gender": "",
    "last_login": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "locale": "",
    "phone": "",
    "picture_url": "",
    "username": "",
    "roles": [],
    "display_name": "",
    "org_units": [],
    "company": {
      "alias": 0,
      "name": "",
      "contact_email": "",
      "domain": "",
      "intranet_website": "",
      "remaining_trial_period": 0,
      "trial_period": 0,
      "image": "",
      "primary_color": "",
      "secondary_color": "",
      "self": "",
      "meta": {
        "applications": "",
        "settings": "",
        "logo": ""
      }
    },
    "meta": {
      "share": ""
    },
    "self": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "account": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Id of the identity"
        },
        "dashboardRole": {
          "type": "object",
          "properties": {},
          "description": "List of dashboard roles"
        },
        "email": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "created_at": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "name": {
          "type": "string",
          "description": "Concat First name and Last name, if not present then email"
        },
        "enabled": {
          "type": "boolean"
        },
        "first_name": {
          "type": "string"
        },
        "last_name": {
          "type": "string"
        },
        "gender": {
          "type": "string"
        },
        "last_login": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "locale": {
          "type": "string"
        },
        "phone": {
          "type": "string"
        },
        "picture_url": {
          "type": "string"
        },
        "username": {
          "type": "string"
        },
        "roles": {
          "type": "array"
        },
        "display_name": {
          "type": "string"
        },
        "org_units": {},
        "company": {
          "type": "object",
          "properties": {
            "alias": {
              "type": "number"
            },
            "name": {
              "type": "string",
              "description": "Company Name"
            },
            "contact_email": {
              "type": "string",
              "description": "Contact email"
            },
            "domain": {
              "type": "string",
              "description": "Company domain"
            },
            "intranet_website": {
              "type": "string",
              "description": "Company internal website on mosaic"
            },
            "remaining_trial_period": {
              "type": "number",
              "description": "Remaining trial period for AppsCo Business package"
            },
            "trial_period": {
              "type": "number",
              "description": "How big is the trial period"
            },
            "image": {
              "type": "string",
              "description": "Company logo"
            },
            "primary_color": {
              "type": "string"
            },
            "secondary_color": {
              "type": "string"
            },
            "self": {
              "type": "string",
              "description": "Company self resource"
            },
            "meta": {
              "type": "object",
              "properties": {
                "applications": {
                  "type": "string",
                  "description": "Company applications"
                },
                "settings": {
                  "type": "string",
                  "description": "Company settings"
                },
                "logo": {
                  "type": "string",
                  "description": "Create Company logo"
                }
              }
            }
          }
        },
        "meta": {
          "type": "object",
          "properties": {
            "share": {
              "type": "string",
              "description": "Resource link for sharing application to account"
            }
          }
        },
        "self": {
          "type": "string"
        }
      }
    }
  }
}
                      
Account Profile Image

Return profile image of currently logged in user.

Setup account profile image

REQUEST

Headers
Content-Type multipart/form-data
Authorization token absdef12345
multipart/form-data
                          -----BOUNDARY
    Content-Disposition: form-data; name="file"; filename="image.jpg"
    Content-Type: image/jpeg
-----BOUNDARY

                        
                          
                        

RESPONSE

Headers
Content-Type application/json
200 application/json
                        []
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      
Account Partner

Information regarding AppsCo Partner.

Retrieve partner information

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "address": "",
  "company_name": "",
  "company_number": "",
  "contact_email": "",
  "company_logo": "",
  "account": {
    "id": 0,
    "email": "",
    "first_name": "",
    "last_name": "",
    "timezone": "",
    "gender": [],
    "country": [],
    "phone": "",
    "picture_url": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "address": {
      "type": "string",
      "description": "Partner address"
    },
    "company_name": {
      "type": "string",
      "description": "Partner name"
    },
    "company_number": {
      "type": "string",
      "description": "Partner phone"
    },
    "contact_email": {
      "type": "string",
      "description": "Parner email"
    },
    "company_logo": {
      "type": "string",
      "description": "Partner logo"
    },
    "account": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Owner's ID"
        },
        "email": {
          "type": "string",
          "description": "Emaile of account's owner"
        },
        "first_name": {
          "type": "string",
          "description": "First name of account's owner"
        },
        "last_name": {
          "type": "string",
          "description": "Last name of account's owner"
        },
        "timezone": {
          "type": "string",
          "description": "Available timezones"
        },
        "gender": {
          "description": "Gender"
        },
        "country": {
          "description": "Available countries"
        },
        "phone": {
          "type": "string",
          "description": "Phone number of account's owner"
        },
        "picture_url": {
          "type": "string",
          "description": "Picture url of account's owner"
        }
      }
    }
  }
}
                      
Account Application instances

Returns AppsCo account application instances of currently logged in user, regardles of the dashboard.

Retrieve all application instances/icons

REQUEST

Headers
Authorization Token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "icons": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "icons": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
Resource Instances Personal

Returns AppsCo account resource personal instances/icons currently logged in user

Retrieve personal resource instances/icons

REQUEST

Headers
Authorization Token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "icons": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "icons": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
Resource Instances Shared With Me

Returns AppsCo account resource instances shared with company

Retrieve all resource instances/icons

REQUEST

Headers
Authorization Token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "icons": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "icons": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
Resource Instances Shared With Me Company

Returns AppsCo account resource instances shared with currently logged in user, regardles of the dashboard.

Retrieve resource instances/icons shared with company

REQUEST

Headers
Authorization Token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "icons": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "icons": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
Account Resource instance

Returns AppsCo account resource instance of currently logged in user.

Retrieve resource instance

REQUEST

Parameters
applicationIcon number 247155

ID of the Resource Icon in the form of an integer

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "icon": {
    "application": "",
    "alias": 0,
    "title": "",
    "auth_type": "",
    "is_configured": false,
    "url_editable": false,
    "icon_url": "",
    "url": "",
    "images": [],
    "owner": false,
    "self": "",
    "security": {
      "password_strength": 0,
      "info": {
        "upper_case": false,
        "lower_case": false,
        "digits": false,
        "special_chars": false,
        "length8": false,
        "length16": false,
        "entropy": 0
      },
      "last_update": "",
      "score": 0
    },
    "claims": {
      "username": "",
      "password": "",
      "note": ""
    },
    "meta": {
      "log": "",
      "autologin": "",
      "subscribers": "",
      "application-remove": "",
      "plugin_go": ""
    }
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "icon": {
      "type": "object",
      "properties": {
        "application": {
          "type": "string",
          "description": "Resource location of the application template"
        },
        "alias": {
          "type": "number",
          "description": "Application icon alias"
        },
        "title": {
          "type": "string",
          "description": "Application title"
        },
        "auth_type": {
          "type": "string",
          "description": "Authentication type"
        },
        "is_configured": {
          "type": "boolean",
          "description": "Is Application icon configured"
        },
        "url_editable": {
          "type": "boolean",
          "description": "Can you edit application icon uri"
        },
        "icon_url": {
          "type": "string",
          "description": "Application icon"
        },
        "url": {
          "type": "string",
          "description": "Application url"
        },
        "images": {
          "type": "array",
          "description": "List of application icons"
        },
        "owner": {
          "type": "boolean",
          "description": "Do you own this application?"
        },
        "self": {
          "type": "string",
          "description": "Resource location to it self"
        },
        "security": {
          "type": "object",
          "properties": {
            "password_strength": {
              "type": "number",
              "description": "How strong is the password from 0 to 100"
            },
            "info": {
              "type": "object",
              "properties": {
                "upper_case": {
                  "type": "boolean",
                  "description": "Does it contain upper case letters"
                },
                "lower_case": {
                  "type": "boolean",
                  "description": "Does it contain lower case letters"
                },
                "digits": {
                  "type": "boolean",
                  "description": "Does it contain digits"
                },
                "special_chars": {
                  "type": "boolean",
                  "description": "Does it contain special characters"
                },
                "length8": {
                  "type": "boolean",
                  "description": "Is length greater then 8 characters"
                },
                "length16": {
                  "type": "boolean",
                  "description": "Is length greater then 16 characters"
                },
                "entropy": {
                  "type": "number",
                  "description": "What is the entropy"
                }
              },
              "description": "Additional info"
            },
            "last_update": {
              "type": "string",
              "description": "When is it last updated"
            },
            "score": {
              "type": "number",
              "description": "Overall score"
            }
          },
          "description": "Application icon security based on policies"
        },
        "claims": {
          "type": "object",
          "properties": {
            "username": {
              "type": "string",
              "description": "User's username for application"
            },
            "password": {
              "type": "string",
              "description": "User's password for application"
            },
            "note": {
              "type": "string",
              "description": "User's note for application"
            }
          },
          "description": "Claims based on auth type"
        },
        "meta": {
          "type": "object",
          "properties": {
            "log": {
              "type": "string",
              "description": "Log of all the actions on application"
            },
            "autologin": {
              "type": "string",
              "description": "Switch authentication types between form fill and autologin"
            },
            "subscribers": {
              "type": "string",
              "description": "Accounts that this application is shared to"
            },
            "application-remove": {
              "type": "string",
              "description": "Remove application"
            },
            "plugin_go": {
              "type": "string",
              "description": "Attempt login"
            }
          }
        }
      }
    }
  }
}
                      
My Account's Resources

Returns AppsCo account resources of currently logged in user.

Retrieve resources of my account

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "applications": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "applications": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
Account Resource

Returns AppsCo account resource of currently logged in user.

Retrieve specific resource's information

REQUEST

Parameters
applicationIcon number 247155

ID of the Resource Icon in the form of an integer

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "application": "",
  "title": "",
  "auth_types": [
    "unpw",
    "none",
    "item"
  ],
  "url_editable": false,
  "application_url": "",
  "url": "",
  "images": []
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "application": {
      "type": "string",
      "description": "Application route"
    },
    "title": {
      "type": "string",
      "description": "Application name"
    },
    "auth_types": {
      "type": "array",
      "description": "Application authorization type"
    },
    "url_editable": {
      "type": "boolean"
    },
    "application_url": {
      "type": "string",
      "description": "Application icon"
    },
    "url": {
      "type": "string",
      "description": "Application url"
    },
    "images": {
      "type": "array"
    }
  }
}
                      
Account Two-Factor Authentication

Is two-factor authentication turned on or off.

Two-factor authentication status

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "enabled": false
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    }
  }
}
                      

Setup two factor authentication

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "enabled": true
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    }
  }
}
                      

Turn off two factor authentication

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "enabled": true
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    }
  }
}
                      
Two-factor Authentication recovery codes

Returns AppsCo account two factor authentication recovery codes of currently logged in user

Retrieve two-factor recovery codes

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        []
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      
Change Password

AppsCo account change password of currently logged in user.

Setup new password for my account

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "enabled": false
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    }
  }
}
                      
Account's Authorized Apps

Return AppsCo account two-factor authorized applications of currently logged in user.

Retrieve authorization's information

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "authorizations": [
    {
      "created": {
        "date": "",
        "timezone_type": 0,
        "timezone": ""
      },
      "scopes": "",
      "title": "",
      "description": "",
      "icon_url": "",
      "active": false,
      "website": "",
      "revoke": ""
    }
  ],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "authorizations": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
Me Authorized Apps ID

Delete AppsCo account oauth application of currently logged in user.

Remove authorization of application

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "success": true
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    }
  }
}
                      
Account Logs

Return account logs of currently logged in user.

Retrieve logs

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "log": [
    {
      "account": {
        "display_name": "",
        "email": "",
        "image": ""
      },
      "created_at": {
        "date": "",
        "timezone_type": "",
        "timezone": ""
      },
      "ip": "",
      "user_agent": "",
      "type": "",
      "data": []
    }
  ],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "log": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
Template Resources

Return all available template resources.

Retrieve all template resources

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "applications": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "applications": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
Single Resource

Return Appsco resource information on the user’s dashboard.

Retrieve all information about resource

REQUEST

Parameters
application number 2

ID of the Resource in the form of an integer

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "application": {
    "id": 0,
    "title": "",
    "url": "",
    "url_editable": false,
    "icon_url": "",
    "auth_types": []
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "application": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Id of application"
        },
        "title": {
          "type": "string",
          "description": "Name of application"
        },
        "url": {
          "type": "string",
          "description": "Url of application"
        },
        "url_editable": {
          "type": "boolean",
          "description": "If url of applications is editable"
        },
        "icon_url": {
          "type": "string",
          "description": "Url of application's icon"
        },
        "auth_types": {
          "description": "Application authorization type"
        }
      }
    }
  }
}
                      

Remove single resource from dashboard

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "Response": {
    "message": "",
    "code": 0
  },
  "meta": {
    "icons": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "Response": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string"
        },
        "code": {
          "type": "number",
          "description": "Response code"
        }
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "icons": {
          "type": "string",
          "description": "Application icon route"
        }
      }
    }
  }
}
                      
Switch Resource

Autologin sign-in process automation switch is only available if the designated application supports both UN/PW and Item as Auth types.

Switch resource login type

REQUEST

Parameters
application number 2

ID of the Resource in the form of an integer

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "Response": {
    "message": "",
    "code": 0
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "Response": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string"
        },
        "code": {
          "type": "number",
          "description": "Response code"
        }
      }
    }
  }
}
                      
Resource's Log

Return AppsCo resource logs.

Retrieve logs for resource

REQUEST

Parameters
application number 2

ID of the Resource in the form of an integer

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "log": [
    {
      "account": {
        "display_name": "",
        "email": "",
        "image": ""
      },
      "created_at": {
        "date": "",
        "timezone_type": "",
        "timezone": ""
      },
      "ip": "",
      "user_agent": "",
      "type": "",
      "data": []
    }
  ],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "log": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
Resource's Subscribers

Return AppsCo resource subscribers for a currently loged user.

Retrieve subscribers for resource

REQUEST

Parameters
application number 2

ID of the Resource in the form of an integer

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "accounts": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "accounts": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      

Delete specific subscriber

REQUEST

Parameters
application number 2

ID of the Resource in the form of an integer

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "Response": {
    "message": "",
    "code": 0
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "Response": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string"
        },
        "code": {
          "type": "number",
          "description": "Response code"
        }
      }
    }
  }
}
                      
Resource's Track Events

AppsCo resource track events for a currently loged user.

Retrieve resource track event

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "message": "",
  "code": 0
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "code": {
      "type": "number",
      "description": "Response code"
    }
  }
}
                      
Notifications

Return AppsCo notifications for a currently loged in user.

Retrieve notifications

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "id": 0,
    "body": "",
    "imageUrl": "",
    "createdAt": ""
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      
Accounts

Return AppsCo accounts.

Retrieve accounts

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "accounts": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "accounts": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
Account

Return AppsCo account information.

Retrieve account

REQUEST

Parameters
accountId number 41

ID of the Account in the form of an integer

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "account": {
    "id": 0,
    "dashboardRole": {},
    "email": "",
    "timezone": "",
    "country": "",
    "created_at": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "name": "",
    "enabled": false,
    "first_name": "",
    "last_name": "",
    "gender": "",
    "last_login": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "locale": "",
    "phone": "",
    "picture_url": "",
    "username": "",
    "roles": [],
    "display_name": "",
    "org_units": [],
    "company": {
      "alias": 0,
      "name": "",
      "contact_email": "",
      "domain": "",
      "intranet_website": "",
      "remaining_trial_period": 0,
      "trial_period": 0,
      "image": "",
      "primary_color": "",
      "secondary_color": "",
      "self": "",
      "meta": {
        "applications": "",
        "settings": "",
        "logo": ""
      }
    },
    "meta": {
      "share": ""
    },
    "self": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "account": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Id of the identity"
        },
        "dashboardRole": {
          "type": "object",
          "properties": {},
          "description": "List of dashboard roles"
        },
        "email": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "created_at": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "name": {
          "type": "string",
          "description": "Concat First name and Last name, if not present then email"
        },
        "enabled": {
          "type": "boolean"
        },
        "first_name": {
          "type": "string"
        },
        "last_name": {
          "type": "string"
        },
        "gender": {
          "type": "string"
        },
        "last_login": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "locale": {
          "type": "string"
        },
        "phone": {
          "type": "string"
        },
        "picture_url": {
          "type": "string"
        },
        "username": {
          "type": "string"
        },
        "roles": {
          "type": "array"
        },
        "display_name": {
          "type": "string"
        },
        "org_units": {},
        "company": {
          "type": "object",
          "properties": {
            "alias": {
              "type": "number"
            },
            "name": {
              "type": "string",
              "description": "Company Name"
            },
            "contact_email": {
              "type": "string",
              "description": "Contact email"
            },
            "domain": {
              "type": "string",
              "description": "Company domain"
            },
            "intranet_website": {
              "type": "string",
              "description": "Company internal website on mosaic"
            },
            "remaining_trial_period": {
              "type": "number",
              "description": "Remaining trial period for AppsCo Business package"
            },
            "trial_period": {
              "type": "number",
              "description": "How big is the trial period"
            },
            "image": {
              "type": "string",
              "description": "Company logo"
            },
            "primary_color": {
              "type": "string"
            },
            "secondary_color": {
              "type": "string"
            },
            "self": {
              "type": "string",
              "description": "Company self resource"
            },
            "meta": {
              "type": "object",
              "properties": {
                "applications": {
                  "type": "string",
                  "description": "Company applications"
                },
                "settings": {
                  "type": "string",
                  "description": "Company settings"
                },
                "logo": {
                  "type": "string",
                  "description": "Create Company logo"
                }
              }
            }
          }
        },
        "meta": {
          "type": "object",
          "properties": {
            "share": {
              "type": "string",
              "description": "Resource link for sharing application to account"
            }
          }
        },
        "self": {
          "type": "string"
        }
      }
    }
  }
}
                      
Share Accounts

Share AppsCo account.

Share account instance

REQUEST

Parameters
accountId number 41

ID of the Account in the form of an integer

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "Response": {
    "message": "",
    "code": 0
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "Response": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string"
        },
        "code": {
          "type": "number",
          "description": "Response code"
        }
      }
    }
  }
}
                      
Companies
Return AppsCo companies for current user.

Retrieve companies

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "companies": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "companies": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
Create Company
Create AppsCo Company for current user.

Create company

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "account": {
    "id": 0,
    "uuid": "",
    "dashboard_roles": [],
    "email": "",
    "timezone": "",
    "country": "",
    "created_at": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "name": "",
    "enabled": false,
    "first_name": "",
    "last_name": "",
    "gender": "",
    "last_login": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "locale": "",
    "phone": "",
    "picture_url": "",
    "username": "",
    "roles": {
      "OWNER": "",
      "ADMIN": "",
      "SHARED": ""
    },
    "display_name": "",
    "profile_options": {
      "public": false
    },
    "partner": false,
    "companies": {
      "company": [
        {
          "alias": 0,
          "name": "",
          "contact_email": "",
          "billing_email": "",
          "domain": "",
          "intranet_website": "",
          "remaining_trial_period": 0,
          "trial_period": 0,
          "image": "",
          "primary_color": "",
          "secondary_color": "",
          "self": "",
          "meta": {
            "applications": "",
            "settings": "",
            "logo": ""
          }
        }
      ],
      "icons": "",
      "company_admin": false
    },
    "meta": {
      "share": "",
      "self": ""
    }
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "account": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "uuid": {
          "type": "string"
        },
        "dashboard_roles": {},
        "email": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "created_at": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "name": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "first_name": {
          "type": "string"
        },
        "last_name": {
          "type": "string"
        },
        "gender": {
          "type": "string"
        },
        "last_login": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "locale": {
          "type": "string"
        },
        "phone": {
          "type": "string"
        },
        "picture_url": {
          "type": "string"
        },
        "username": {
          "type": "string"
        },
        "roles": {
          "type": "object",
          "properties": {
            "OWNER": {
              "type": "string"
            },
            "ADMIN": {
              "type": "string"
            },
            "SHARED": {
              "type": "string"
            }
          },
          "required": [
            "OWNER",
            "ADMIN",
            "SHARED"
          ],
          "additionalProperties": false
        },
        "display_name": {
          "type": "string"
        },
        "profile_options": {
          "type": "object",
          "properties": {
            "public": {
              "type": "boolean"
            }
          }
        },
        "partner": {
          "type": "boolean"
        },
        "companies": {
          "type": "object",
          "properties": {
            "company": {
              "type": "array"
            },
            "icons": {
              "type": "string"
            },
            "company_admin": {
              "type": "boolean"
            }
          }
        },
        "meta": {
          "type": "object",
          "properties": {
            "share": {
              "type": "string"
            },
            "self": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
                      
Company
Return AppsCo Company information for currently logged in user.

Retrieve company

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "alias": 0,
  "name": "",
  "contact_email": "",
  "billing_email": "",
  "domain": "",
  "intranet_website": "",
  "remaining_trial_period": 0,
  "trial_period": 0,
  "image": "",
  "primary_color": "",
  "secondary_color": "",
  "self": "",
  "meta": {
    "applications": "",
    "settings": "",
    "logo": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "alias": {
      "type": "number"
    },
    "name": {
      "type": "string",
      "description": "Name of company"
    },
    "contact_email": {
      "type": "string",
      "description": "Contact email"
    },
    "billing_email": {
      "type": "string",
      "description": "Billing email"
    },
    "domain": {
      "type": "string",
      "description": "Domain of company"
    },
    "intranet_website": {
      "type": "string",
      "description": "Intranet website of company"
    },
    "remaining_trial_period": {
      "type": "number",
      "description": "Remaining trial period"
    },
    "trial_period": {
      "type": "number",
      "description": "Trial period"
    },
    "image": {
      "type": "string",
      "description": "Image route"
    },
    "primary_color": {
      "type": "string"
    },
    "secondary_color": {
      "type": "string"
    },
    "self": {
      "type": "string",
      "description": "Company route"
    },
    "meta": {
      "type": "object",
      "properties": {
        "applications": {
          "type": "string",
          "description": "Company applications route"
        },
        "settings": {
          "type": "string",
          "description": "Company settings route"
        },
        "logo": {
          "type": "string",
          "description": "Company logo route"
        }
      }
    }
  }
}
                      
Company Transfer Token
Get AppsCo Company transfer token.

Retrieve company transfer token

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "transfer_token": "",
  "expiration": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "transfer_token": {
      "type": "string"
    },
    "expiration": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    }
  }
}
                      
Company Resources
Return AppsCo Company information for currently logged in user.

Retrieve company resources

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "applications": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "applications": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      

Add company resource to organization unit

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "application_template": {
    "title": "",
    "supported_auth_types": [
      "unpw",
      "none",
      "item"
    ],
    "icon_url": "",
    "url": "",
    "url_editable": false,
    "self": ""
  },
  "title": "",
  "alias": 0,
  "claim_type": "",
  "auth_type": "",
  "url_editable": false,
  "url": "",
  "images": [],
  "added_by": {
    "id": 0,
    "uuid": "",
    "dashboard_roles": [],
    "email": "",
    "timezone": "",
    "country": "",
    "created_at": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "name": "",
    "enabled": false,
    "first_name": "",
    "last_name": "",
    "gender": "",
    "last_login": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "locale": "",
    "phone": "",
    "picture_url": "",
    "username": "",
    "roles": {
      "OWNER": "",
      "ADMIN": "",
      "SHARED": ""
    },
    "display_name": "",
    "profile_options": {
      "public": false
    },
    "partner": false,
    "companies": {
      "company": [
        {
          "alias": 0,
          "name": "",
          "contact_email": "",
          "billing_email": "",
          "domain": "",
          "intranet_website": "",
          "remaining_trial_period": 0,
          "trial_period": 0,
          "image": "",
          "primary_color": "",
          "secondary_color": "",
          "self": "",
          "meta": {
            "applications": "",
            "settings": "",
            "logo": ""
          }
        }
      ],
      "icons": "",
      "company_admin": false
    },
    "meta": {
      "share": "",
      "self": ""
    }
  },
  "security": {
    "info": {
      "not_configured": 0,
      "configured": 0,
      "lowest_score": 0
    },
    "score": 0
  },
  "last_login": "",
  "claims": [
    "username",
    "password"
  ],
  "org_units": [
    {
      "name": "",
      "description": "",
      "alias": 0,
      "meta": {
        "remove": ""
      }
    }
  ],
  "last_modified": {
    "account": "",
    "date": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    }
  },
  "daily_usage": 0,
  "application_url": "",
  "company": "",
  "meta": {
    "log": "",
    "subscribers": "",
    "update_claims": "",
    "update": "",
    "account_claims": "",
    "account_icon": ""
  },
  "self": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "application_template": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string",
          "description": "Title of application"
        },
        "supported_auth_types": {
          "type": "array"
        },
        "icon_url": {
          "type": "string",
          "description": "Icon url"
        },
        "url": {
          "type": "string",
          "description": "Application  url"
        },
        "url_editable": {
          "type": "boolean"
        },
        "self": {
          "type": "string",
          "description": "Application route"
        }
      },
      "description": "Application template"
    },
    "title": {
      "type": "string",
      "description": "Title of application"
    },
    "alias": {
      "type": "number"
    },
    "claim_type": {
      "type": "string",
      "description": "Claim type"
    },
    "auth_type": {
      "type": "string",
      "description": "Auth type"
    },
    "url_editable": {
      "type": "boolean",
      "description": "Url editable"
    },
    "url": {
      "type": "string",
      "description": "Url route"
    },
    "images": {
      "type": "array",
      "description": "Images"
    },
    "added_by": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "uuid": {
          "type": "string"
        },
        "dashboard_roles": {},
        "email": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "created_at": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "name": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "first_name": {
          "type": "string"
        },
        "last_name": {
          "type": "string"
        },
        "gender": {
          "type": "string"
        },
        "last_login": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "locale": {
          "type": "string"
        },
        "phone": {
          "type": "string"
        },
        "picture_url": {
          "type": "string"
        },
        "username": {
          "type": "string"
        },
        "roles": {
          "type": "object",
          "properties": {
            "OWNER": {
              "type": "string"
            },
            "ADMIN": {
              "type": "string"
            },
            "SHARED": {
              "type": "string"
            }
          },
          "required": [
            "OWNER",
            "ADMIN",
            "SHARED"
          ],
          "additionalProperties": false
        },
        "display_name": {
          "type": "string"
        },
        "profile_options": {
          "type": "object",
          "properties": {
            "public": {
              "type": "boolean"
            }
          }
        },
        "partner": {
          "type": "boolean"
        },
        "companies": {
          "type": "object",
          "properties": {
            "company": {
              "type": "array"
            },
            "icons": {
              "type": "string"
            },
            "company_admin": {
              "type": "boolean"
            }
          }
        },
        "meta": {
          "type": "object",
          "properties": {
            "share": {
              "type": "string"
            },
            "self": {
              "type": "string"
            }
          }
        }
      }
    },
    "security": {
      "type": "object",
      "properties": {
        "info": {
          "type": "object",
          "properties": {
            "not_configured": {
              "type": "number"
            },
            "configured": {
              "type": "number"
            },
            "lowest_score": {
              "type": "number"
            }
          }
        },
        "score": {
          "type": "number"
        }
      }
    },
    "last_login": {
      "type": "string",
      "description": "Who was last logged in"
    },
    "claims": {
      "type": "array"
    },
    "org_units": {
      "type": "array"
    },
    "last_modified": {
      "type": "object",
      "properties": {
        "account": {
          "type": "string",
          "description": "Name of account user"
        },
        "date": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        }
      }
    },
    "daily_usage": {
      "type": "number"
    },
    "application_url": {
      "type": "string"
    },
    "company": {
      "type": "string"
    },
    "meta": {
      "type": "object",
      "properties": {
        "log": {
          "type": "string",
          "description": "Application log route"
        },
        "subscribers": {
          "type": "string",
          "description": "Application subscribers route"
        },
        "update_claims": {
          "type": "string",
          "description": "Application claims route"
        },
        "update": {
          "type": "string",
          "description": "Update"
        },
        "account_claims": {
          "type": "string",
          "description": "Application account claims route"
        },
        "account_icon": {
          "type": "string"
        }
      }
    },
    "self": {
      "type": "string"
    }
  }
}
                      
Company OrgUnits

Return AppsCo Company OrgUnits for currently logged in user.

Retrieve company orgunits

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "orgunits": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "orgunits": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
Company OrgUnit

Return AppsCo Company OrgUnits for currently logged in user.

Retrieve company orgunit

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "item": {
    "name": "",
    "alias": 0,
    "description": "",
    "parent": "",
    "self": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "item": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of OrgUnit"
        },
        "alias": {
          "type": "number",
          "description": "Alias"
        },
        "description": {
          "type": "string",
          "description": "Description of OrgUnit"
        },
        "parent": {
          "type": "string",
          "description": "Parent route of OrgUnit"
        },
        "self": {
          "type": "string",
          "description": "OrgUnit route"
        }
      }
    }
  }
}
                      

Add new organization unit

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "orgunit": {
    "name": "",
    "alias": 0,
    "description": "",
    "parent": "",
    "self": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "orgunit": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of OrgUnit"
        },
        "alias": {
          "type": "number",
          "description": "Alias"
        },
        "description": {
          "type": "string",
          "description": "Description of OrgUnit"
        },
        "parent": {
          "type": "string",
          "description": "Parent route of OrgUnit"
        },
        "self": {
          "type": "string",
          "description": "OrgUnit route"
        }
      }
    }
  }
}
                      

Update organization unit

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "orgunit": {
    "name": "",
    "alias": 0,
    "description": "",
    "parent": "",
    "self": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "orgunit": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of OrgUnit"
        },
        "alias": {
          "type": "number",
          "description": "Alias"
        },
        "description": {
          "type": "string",
          "description": "Description of OrgUnit"
        },
        "parent": {
          "type": "string",
          "description": "Parent route of OrgUnit"
        },
        "self": {
          "type": "string",
          "description": "OrgUnit route"
        }
      }
    }
  }
}
                      

Remove organization unit

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "dashboard_roles": [],
  "email": "",
  "timezone": "",
  "country": "",
  "created_at": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "name": "",
  "enabled": false,
  "first_name": "",
  "last_name": "",
  "gender": "",
  "last_login": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "locale": "",
  "phone": "",
  "picture_url": "",
  "username": "",
  "roles": {
    "OWNER": "",
    "ADMIN": "",
    "SHARED": ""
  },
  "display_name": "",
  "profile_options": {
    "public": false
  },
  "partner": false,
  "companies": {
    "company": [
      {
        "alias": 0,
        "name": "",
        "contact_email": "",
        "billing_email": "",
        "domain": "",
        "intranet_website": "",
        "remaining_trial_period": 0,
        "trial_period": 0,
        "image": "",
        "primary_color": "",
        "secondary_color": "",
        "self": "",
        "meta": {
          "applications": "",
          "settings": "",
          "logo": ""
        }
      }
    ],
    "icons": "",
    "company_admin": false
  },
  "org_units": [
    {
      "name": "",
      "description": "",
      "alias": 0,
      "meta": {
        "remove": ""
      }
    }
  ],
  "meta": {
    "share": ""
  },
  "self": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "dashboard_roles": {},
    "email": {
      "type": "string"
    },
    "timezone": {
      "type": "string"
    },
    "country": {
      "type": "string"
    },
    "created_at": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "name": {
      "type": "string"
    },
    "enabled": {
      "type": "boolean"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "gender": {
      "type": "string"
    },
    "last_login": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "locale": {
      "type": "string"
    },
    "phone": {
      "type": "string"
    },
    "picture_url": {
      "type": "string"
    },
    "username": {
      "type": "string"
    },
    "roles": {
      "type": "object",
      "properties": {
        "OWNER": {
          "type": "string"
        },
        "ADMIN": {
          "type": "string"
        },
        "SHARED": {
          "type": "string"
        }
      },
      "required": [
        "OWNER",
        "ADMIN",
        "SHARED"
      ],
      "additionalProperties": false
    },
    "display_name": {
      "type": "string"
    },
    "profile_options": {
      "type": "object",
      "properties": {
        "public": {
          "type": "boolean"
        }
      }
    },
    "partner": {
      "type": "boolean"
    },
    "companies": {
      "type": "object",
      "properties": {
        "company": {
          "type": "array"
        },
        "icons": {
          "type": "string"
        },
        "company_admin": {
          "type": "boolean"
        }
      }
    },
    "org_units": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "share": {
          "type": "string"
        }
      }
    },
    "self": {
      "type": "string"
    }
  }
}
                      
Company OrgUnit Resources

Return AppsCo Company OrgUnits resources for currently logged in user.

Add resource company orgunit

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "applications": []
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "applications": {
      "type": "array"
    }
  }
}
                      
Company OrgUnit Roles

Return AppsCo Company OrgUnits accounts for currently logged in user.

Add accounts company orgunit

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "company_roles": []
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "company_roles": {
      "type": "array"
    }
  }
}
                      
Company Domains
Return AppsCo Company domains for currently logged in user.

Retrieve company domains

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "domains": [],
  "verified": 0,
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "domains": {
      "type": "array"
    },
    "verified": {
      "type": "number"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      

Add company domain

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "domains": [],
  "verified": 0,
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "domains": {
      "type": "array"
    },
    "verified": {
      "type": "number"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
Company Domain
Return AppsCo Company domain for currently logged in user.

Retrieve company domain

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "alias": 0,
  "domain": "",
  "crated_at": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "verified_at": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "verification_code": "",
  "company": "",
  "self": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "alias": {
      "type": "number",
      "description": "ID of domain"
    },
    "domain": {
      "type": "string"
    },
    "crated_at": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "verified_at": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "verification_code": {
      "type": "string",
      "description": "Code for verification"
    },
    "company": {
      "type": "string",
      "description": "Company of domain"
    },
    "self": {
      "type": "string"
    }
  }
}
                      

Remove domain

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "alias": 0,
  "domain": "",
  "crated_at": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "verified_at": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "verification_code": "",
  "company": "",
  "self": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "alias": {
      "type": "number",
      "description": "ID of domain"
    },
    "domain": {
      "type": "string"
    },
    "crated_at": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "verified_at": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "verification_code": {
      "type": "string",
      "description": "Code for verification"
    },
    "company": {
      "type": "string",
      "description": "Company of domain"
    },
    "self": {
      "type": "string"
    }
  }
}
                      
Verify Company Domain
Verify AppsCo Company domain for currently logged in user.

Verify company domain

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "alias": 0,
  "domain": "",
  "crated_at": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "verified_at": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "verification_code": "",
  "company": "",
  "self": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "alias": {
      "type": "number",
      "description": "ID of domain"
    },
    "domain": {
      "type": "string"
    },
    "crated_at": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "verified_at": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "verification_code": {
      "type": "string",
      "description": "Code for verification"
    },
    "company": {
      "type": "string",
      "description": "Company of domain"
    },
    "self": {
      "type": "string"
    }
  }
}
                      
Company Billing Credit Card
Return AppsCo Company credit card information for currently logged in user.

Retrieve company credit card

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "object": "",
  "address_city": "",
  "address_country": "",
  "address_line1": "",
  "address_line1_check": "",
  "address_line2": "",
  "address_state": "",
  "address_zip": "",
  "address_zip_check": "",
  "brand": "",
  "country": "",
  "customer": "",
  "cvc_check": "",
  "dynamic_last4": "",
  "exp_month": 0,
  "exp_year": 0,
  "fingerprint": "",
  "funding": "",
  "last4": 0,
  "metadata": [],
  "name": "",
  "tokenization_method": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "object": {
      "type": "string"
    },
    "address_city": {
      "type": "string"
    },
    "address_country": {
      "type": "string"
    },
    "address_line1": {
      "type": "string"
    },
    "address_line1_check": {
      "type": "string"
    },
    "address_line2": {
      "type": "string"
    },
    "address_state": {
      "type": "string"
    },
    "address_zip": {
      "type": "string"
    },
    "address_zip_check": {
      "type": "string"
    },
    "brand": {
      "type": "string"
    },
    "country": {
      "type": "string"
    },
    "customer": {
      "type": "string"
    },
    "cvc_check": {
      "type": "string"
    },
    "dynamic_last4": {
      "type": "string"
    },
    "exp_month": {
      "type": "number"
    },
    "exp_year": {
      "type": "number"
    },
    "fingerprint": {
      "type": "string"
    },
    "funding": {
      "type": "string"
    },
    "last4": {
      "type": "number"
    },
    "metadata": {},
    "name": {
      "type": "string"
    },
    "tokenization_method": {
      "type": "string"
    }
  }
}
                      

Add company credit card

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "application_template": {
    "title": "",
    "supported_auth_types": [
      "unpw",
      "none",
      "item"
    ],
    "icon_url": "",
    "url": "",
    "url_editable": false,
    "self": ""
  },
  "title": "",
  "alias": 0,
  "claim_type": "",
  "auth_type": "",
  "url_editable": false,
  "url": "",
  "images": [],
  "added_by": {
    "id": 0,
    "uuid": "",
    "dashboard_roles": [],
    "email": "",
    "timezone": "",
    "country": "",
    "created_at": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "name": "",
    "enabled": false,
    "first_name": "",
    "last_name": "",
    "gender": "",
    "last_login": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "locale": "",
    "phone": "",
    "picture_url": "",
    "username": "",
    "roles": {
      "OWNER": "",
      "ADMIN": "",
      "SHARED": ""
    },
    "display_name": "",
    "profile_options": {
      "public": false
    },
    "partner": false,
    "companies": {
      "company": [
        {
          "alias": 0,
          "name": "",
          "contact_email": "",
          "billing_email": "",
          "domain": "",
          "intranet_website": "",
          "remaining_trial_period": 0,
          "trial_period": 0,
          "image": "",
          "primary_color": "",
          "secondary_color": "",
          "self": "",
          "meta": {
            "applications": "",
            "settings": "",
            "logo": ""
          }
        }
      ],
      "icons": "",
      "company_admin": false
    },
    "meta": {
      "share": "",
      "self": ""
    }
  },
  "security": {
    "info": {
      "not_configured": 0,
      "configured": 0,
      "lowest_score": 0
    },
    "score": 0
  },
  "last_login": "",
  "claims": [
    "username",
    "password"
  ],
  "org_units": [
    {
      "name": "",
      "description": "",
      "alias": 0,
      "meta": {
        "remove": ""
      }
    }
  ],
  "last_modified": {
    "account": "",
    "date": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    }
  },
  "daily_usage": 0,
  "application_url": "",
  "company": "",
  "meta": {
    "log": "",
    "subscribers": "",
    "update_claims": "",
    "update": "",
    "account_claims": "",
    "account_icon": ""
  },
  "self": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "application_template": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string",
          "description": "Title of application"
        },
        "supported_auth_types": {
          "type": "array"
        },
        "icon_url": {
          "type": "string",
          "description": "Icon url"
        },
        "url": {
          "type": "string",
          "description": "Application  url"
        },
        "url_editable": {
          "type": "boolean"
        },
        "self": {
          "type": "string",
          "description": "Application route"
        }
      },
      "description": "Application template"
    },
    "title": {
      "type": "string",
      "description": "Title of application"
    },
    "alias": {
      "type": "number"
    },
    "claim_type": {
      "type": "string",
      "description": "Claim type"
    },
    "auth_type": {
      "type": "string",
      "description": "Auth type"
    },
    "url_editable": {
      "type": "boolean",
      "description": "Url editable"
    },
    "url": {
      "type": "string",
      "description": "Url route"
    },
    "images": {
      "type": "array",
      "description": "Images"
    },
    "added_by": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "uuid": {
          "type": "string"
        },
        "dashboard_roles": {},
        "email": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "created_at": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "name": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "first_name": {
          "type": "string"
        },
        "last_name": {
          "type": "string"
        },
        "gender": {
          "type": "string"
        },
        "last_login": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "locale": {
          "type": "string"
        },
        "phone": {
          "type": "string"
        },
        "picture_url": {
          "type": "string"
        },
        "username": {
          "type": "string"
        },
        "roles": {
          "type": "object",
          "properties": {
            "OWNER": {
              "type": "string"
            },
            "ADMIN": {
              "type": "string"
            },
            "SHARED": {
              "type": "string"
            }
          },
          "required": [
            "OWNER",
            "ADMIN",
            "SHARED"
          ],
          "additionalProperties": false
        },
        "display_name": {
          "type": "string"
        },
        "profile_options": {
          "type": "object",
          "properties": {
            "public": {
              "type": "boolean"
            }
          }
        },
        "partner": {
          "type": "boolean"
        },
        "companies": {
          "type": "object",
          "properties": {
            "company": {
              "type": "array"
            },
            "icons": {
              "type": "string"
            },
            "company_admin": {
              "type": "boolean"
            }
          }
        },
        "meta": {
          "type": "object",
          "properties": {
            "share": {
              "type": "string"
            },
            "self": {
              "type": "string"
            }
          }
        }
      }
    },
    "security": {
      "type": "object",
      "properties": {
        "info": {
          "type": "object",
          "properties": {
            "not_configured": {
              "type": "number"
            },
            "configured": {
              "type": "number"
            },
            "lowest_score": {
              "type": "number"
            }
          }
        },
        "score": {
          "type": "number"
        }
      }
    },
    "last_login": {
      "type": "string",
      "description": "Who was last logged in"
    },
    "claims": {
      "type": "array"
    },
    "org_units": {
      "type": "array"
    },
    "last_modified": {
      "type": "object",
      "properties": {
        "account": {
          "type": "string",
          "description": "Name of account user"
        },
        "date": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        }
      }
    },
    "daily_usage": {
      "type": "number"
    },
    "application_url": {
      "type": "string"
    },
    "company": {
      "type": "string"
    },
    "meta": {
      "type": "object",
      "properties": {
        "log": {
          "type": "string",
          "description": "Application log route"
        },
        "subscribers": {
          "type": "string",
          "description": "Application subscribers route"
        },
        "update_claims": {
          "type": "string",
          "description": "Application claims route"
        },
        "update": {
          "type": "string",
          "description": "Update"
        },
        "account_claims": {
          "type": "string",
          "description": "Application account claims route"
        },
        "account_icon": {
          "type": "string"
        }
      }
    },
    "self": {
      "type": "string"
    }
  }
}
                      
Company Billing Public Key
Return AppsCo Company public key.

Retrieve company public key

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "stripePublicKey": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "stripePublicKey": {
      "type": "string"
    }
  }
}
                      
Company Billing Subscription
Return AppsCo Company subscription information for currently logged in user.

Retrieve company subscription

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "currentPeriodStart": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "currentPeriodEnd": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "startedAt": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "plan": {
    "id": "",
    "display_text": "",
    "interval": "",
    "interval_count": 0,
    "amount": 0,
    "currency": ""
  },
  "quantity": 0,
  "status": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "currentPeriodStart": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "currentPeriodEnd": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "startedAt": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "plan": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "display_text": {
          "type": "string"
        },
        "interval": {
          "type": "string"
        },
        "interval_count": {
          "type": "number"
        },
        "amount": {
          "type": "number"
        },
        "currency": {
          "type": "string"
        }
      }
    },
    "quantity": {
      "type": "number"
    },
    "status": {
      "type": "string"
    }
  }
}
                      

Add company subscription

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "currentPeriodStart": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "currentPeriodEnd": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "startedAt": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "plan": {
    "id": "",
    "display_text": "",
    "interval": "",
    "interval_count": 0,
    "amount": 0,
    "currency": ""
  },
  "quantity": 0,
  "status": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "currentPeriodStart": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "currentPeriodEnd": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "startedAt": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "plan": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "display_text": {
          "type": "string"
        },
        "interval": {
          "type": "string"
        },
        "interval_count": {
          "type": "number"
        },
        "amount": {
          "type": "number"
        },
        "currency": {
          "type": "string"
        }
      }
    },
    "quantity": {
      "type": "number"
    },
    "status": {
      "type": "string"
    }
  }
}
                      

Delete company subscription

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "currentPeriodStart": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "currentPeriodEnd": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "startedAt": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "plan": {
    "id": "",
    "display_text": "",
    "interval": "",
    "interval_count": 0,
    "amount": 0,
    "currency": ""
  },
  "quantity": 0,
  "status": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "currentPeriodStart": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "currentPeriodEnd": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "startedAt": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "plan": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "display_text": {
          "type": "string"
        },
        "interval": {
          "type": "string"
        },
        "interval_count": {
          "type": "number"
        },
        "amount": {
          "type": "number"
        },
        "currency": {
          "type": "string"
        }
      }
    },
    "quantity": {
      "type": "number"
    },
    "status": {
      "type": "string"
    }
  }
}
                      
Company Billing Invoice List
Return AppsCo Company inovoice list information for currently logged in user.

Retrieve company invoice list

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "currency": "",
    "date": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "total": 0,
    "nextPaymentAttempt": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "description": "",
    "items": [
      {
        "id": "",
        "quantity": 0,
        "amount": 0,
        "currency": "",
        "description": "",
        "plan": {
          "id": "",
          "display_text": "",
          "interval": "",
          "interval_count": 0,
          "amount": 0,
          "currency": ""
        },
        "date": {
          "date": "",
          "timezone_type": 0,
          "timezone": ""
        }
      }
    ]
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      
Company Billing Invoice Upcoming
Return AppsCo Company inovoice upcoming information for currently logged in user.

Retrieve company invoice upcoming

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "currency": "",
  "date": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "total": 0,
  "nextPaymentAttempt": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "description": "",
  "items": [
    {
      "id": "",
      "quantity": 0,
      "amount": 0,
      "currency": "",
      "description": "",
      "plan": {
        "id": "",
        "display_text": "",
        "interval": "",
        "interval_count": 0,
        "amount": 0,
        "currency": ""
      },
      "date": {
        "date": "",
        "timezone_type": 0,
        "timezone": ""
      }
    }
  ]
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "currency": {
      "type": "string"
    },
    "date": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "total": {
      "type": "number"
    },
    "nextPaymentAttempt": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "description": {
      "type": "string"
    },
    "items": {
      "type": "array"
    }
  }
}
                      
Company Billing Invoice Send
Send AppsCo Company inovoice.

Send billing invoice

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
Company Log Events
Return AppsCo Company log events for currently logged in user.

Retrieve company log events

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "application_created": "",
    "application_claims_updated": "",
    "application_updated": "",
    "application_remove_from_orgunit": "",
    "application_removed": "",
    "application_icon_removed": "",
    "application_shared": "",
    "application_icon_claims_updated": "",
    "subscription_updated": "",
    "subscription_canceled": "",
    "invoice_sent": "",
    "credit_card_created": "",
    "company_role_removed": "",
    "company_role_promoted_to_admin": "",
    "company_role_demoted_from_admin": "",
    "company_role_account_updated": "",
    "company_role_account_password_changed": "",
    "company_role_added": "",
    "company_roles_imported": "",
    "company_role_removed_from_orgunit": "",
    "orgunit_created": "",
    "orgunit_updated": "",
    "org_unit_removed": "",
    "application_added_to_orgunit": "",
    "account_added_to_orgunit": "",
    "company_settings_updated": "",
    "company_logo_updated": "",
    "account_login_attempt": "",
    "account_update_profile": "",
    "account_updated_profile_image": "",
    "account_generated_partner_token": "",
    "account_enabled_two_fa": "",
    "account_disabled_two_fa": "",
    "account_changed_password": "",
    "account_authorized_application": "",
    "account_revoked_authorization": ""
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      
Company Log
Return AppsCo Company logs for currently logged in user.

Retrieve company logs

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "created_at": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "type": "",
    "ip": "",
    "user_agent": "",
    "data": {
      "contact_email": "",
      "from": "",
      "to": ""
    },
    "company": {
      "alias": 0,
      "name": "",
      "contact_email": "",
      "billing_email": "",
      "domain": "",
      "intranet_website": "",
      "remaining_trial_period": 0,
      "trial_period": 0,
      "image": "",
      "primary_color": "",
      "secondary_color": "",
      "self": "",
      "meta": {
        "applications": "",
        "settings": "",
        "logo": ""
      }
    },
    "initiatior_display_name": "",
    "initiatior_email": "",
    "initiatior_image": "",
    "affected_account_display_name": "",
    "affected_account_email": "",
    "affected_account_image": ""
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      
Company Directory Roles
Return AppsCo Company directory roles for currently logged in user.

Retrieve company directory roles

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "company_roles": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "company_roles": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      

Delete company directory roles

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "company_roles": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "company_roles": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
Company Directory Role
Return AppsCo Company directory role for currently logged in user.

Retrieve company directory role

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {}
}
                      

Update company directory role

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "company_roles": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "company_roles": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
Company Directory Role Resources
Return AppsCo Company directory role resources for currently logged in user.

Retrieve company directory role resources

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "applications": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "applications": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
Company Directory Role Can Be Manage
Return AppsCo Company directory role can be managed for currently logged in user.

Can company directory role be managed

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "success": false
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    }
  }
}
                      
Company Directory Role Change Password
Change password AppsCo Company directory role for currently logged in user.

Company directory role change password

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "success": false
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    }
  }
}
                      
Company Directory Role Notification
Return AppsCo Company directory role notifications for currently logged in user.

Company directory role notifications

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        [
  {
    "id": 0,
    "body": "",
    "imageUrl": "",
    "createdAt": ""
  }
]
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
                      
Company Directory Role Two Factor Authentication
Return AppsCo Company directory role two factor authentication for currently logged in user.

Two factor authentication

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "enabled": false
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    }
  }
}
                      

Reset two factor authentication

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "success": false
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    }
  }
}
                      
Company Directory Role Import

Import company directory roles

REQUEST

Headers
Content-Type multipart/form-data
Authorization token absdef12345
multipart/form-data
                          -----WebKitFormBoundary7Lk1ieut0jQaBl3L
    Content-Disposition: form-data; name="file"; filename="example_import.csv"
    Content-Type: text/csv
-----WebKitFormBoundary7Lk1ieut0jQaBl3L--

                        
                          
                        

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "total": 0,
  "numberOfInvitations": 0,
  "numberOfRoles": 0,
  "numberOfFailed": 0,
  "maxSubscriptionSizeReached": false
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "total": {
      "type": "number"
    },
    "numberOfInvitations": {
      "type": "number"
    },
    "numberOfRoles": {
      "type": "number"
    },
    "numberOfFailed": {
      "type": "number"
    },
    "maxSubscriptionSizeReached": {
      "type": "boolean"
    }
  }
}
                      
Company Directory Role Log
Return AppsCo Company directory role log for currently logged in user.

Company directory role logs

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "log": [
    {
      "account": {
        "display_name": "",
        "email": "",
        "image": ""
      },
      "created_at": {
        "date": "",
        "timezone_type": 0,
        "timezone": ""
      },
      "ip": "",
      "user_agent": "",
      "type": "",
      "data": {}
    }
  ]
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "log": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "account": {
            "type": "object",
            "properties": {
              "display_name": {
                "type": "string",
                "enum": [
                  ""
                ]
              },
              "email": {
                "type": "string",
                "enum": [
                  ""
                ]
              },
              "image": {
                "type": "string",
                "enum": [
                  ""
                ]
              }
            },
            "required": [
              "display_name",
              "email",
              "image"
            ],
            "additionalProperties": false
          },
          "created_at": {
            "type": "object",
            "properties": {
              "date": {
                "type": "string",
                "enum": [
                  ""
                ],
                "description": "Date time in iso"
              },
              "timezone_type": {
                "type": "number",
                "enum": [
                  0
                ]
              },
              "timezone": {
                "type": "string",
                "enum": [
                  ""
                ]
              }
            },
            "required": [
              "date",
              "timezone_type",
              "timezone"
            ],
            "additionalProperties": false
          },
          "ip": {
            "type": "string",
            "enum": [
              ""
            ]
          },
          "user_agent": {
            "type": "string",
            "enum": [
              ""
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              ""
            ]
          },
          "data": {
            "type": "object",
            "properties": {},
            "additionalProperties": false
          }
        },
        "required": [
          "account",
          "created_at",
          "ip",
          "user_agent",
          "type",
          "data"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "log"
  ]
}
                      
Company Directory Role Org Units
Return AppsCo Company directory role log for currently logged in user.

Remove company directory org unit

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "account": {
    "id": 0,
    "dashboard_roles": [],
    "email": "",
    "timezone": "",
    "country": "",
    "created_at": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "name": "",
    "enabled": false,
    "first_name": "",
    "last_name": "",
    "gender": "",
    "last_login": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "locale": "",
    "phone": "",
    "picture_url": "",
    "username": "",
    "display_name": "",
    "profile_options": {
      "public": false
    },
    "partner": false,
    "companies": [
      {
        "alias": 0,
        "name": "",
        "contact_email": "",
        "billing_email": "",
        "domain": "",
        "intranet_website": "",
        "remaining_trial_period": 0,
        "trial_period": 0,
        "image": "",
        "primary_color": "",
        "secondary_color": "",
        "self": "",
        "meta": {
          "applications": "",
          "settings": "",
          "logo": ""
        }
      }
    ],
    "icons": "",
    "company_admin": false,
    "org_units": [
      {
        "name": "",
        "description": "",
        "alias": 0,
        "meta": {
          "remove": ""
        }
      }
    ],
    "company": {
      "alias": 0,
      "name": "",
      "contact_email": "",
      "billing_email": "",
      "domain": "",
      "intranet_website": "",
      "remaining_trial_period": 0,
      "trial_period": 0,
      "image": "",
      "primary_color": "",
      "secondary_color": "",
      "self": "",
      "meta": {
        "applications": "",
        "settings": "",
        "logo": ""
      }
    },
    "roles": {
      "COMPANY_ROLE_EMPLOYEE": "",
      "COMPANY_ROLE_ADMIN": ""
    },
    "alias": 0,
    "security": {
      "application_score": 0,
      "two_factor": false
    },
    "self": "",
    "meta": {
      "log": "",
      "applications": ""
    }
  },
  "company": {
    "alias": 0,
    "name": "",
    "contact_email": "",
    "domain": "",
    "intranet_website": "",
    "remaining_trial_period": 0,
    "trial_period": 0,
    "image": "",
    "primary_color": "",
    "secondary_color": "",
    "self": "",
    "meta": {
      "applications": "",
      "settings": "",
      "logo": ""
    }
  },
  "roles": [],
  "alias": 0,
  "security": {
    "application_score": "",
    "two_factor": false
  },
  "self": "",
  "meta": {
    "log": "",
    "applications": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "account": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "dashboard_roles": {},
        "email": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "created_at": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "name": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "first_name": {
          "type": "string"
        },
        "last_name": {
          "type": "string"
        },
        "gender": {
          "type": "string"
        },
        "last_login": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "locale": {
          "type": "string"
        },
        "phone": {
          "type": "string"
        },
        "picture_url": {
          "type": "string"
        },
        "username": {
          "type": "string"
        },
        "display_name": {
          "type": "string"
        },
        "profile_options": {
          "type": "object",
          "properties": {
            "public": {
              "type": "boolean"
            }
          }
        },
        "partner": {
          "type": "boolean"
        },
        "companies": {
          "type": "array"
        },
        "icons": {
          "type": "string"
        },
        "company_admin": {
          "type": "boolean"
        },
        "org_units": {
          "type": "array"
        },
        "company": {
          "type": "object",
          "properties": {
            "alias": {
              "type": "number"
            },
            "name": {
              "type": "string",
              "description": "Name of company"
            },
            "contact_email": {
              "type": "string",
              "description": "Contact email"
            },
            "billing_email": {
              "type": "string",
              "description": "Billing email"
            },
            "domain": {
              "type": "string",
              "description": "Domain of company"
            },
            "intranet_website": {
              "type": "string",
              "description": "Intranet website of company"
            },
            "remaining_trial_period": {
              "type": "number",
              "description": "Remaining trial period"
            },
            "trial_period": {
              "type": "number",
              "description": "Trial period"
            },
            "image": {
              "type": "string",
              "description": "Image route"
            },
            "primary_color": {
              "type": "string"
            },
            "secondary_color": {
              "type": "string"
            },
            "self": {
              "type": "string",
              "description": "Company route"
            },
            "meta": {
              "type": "object",
              "properties": {
                "applications": {
                  "type": "string",
                  "description": "Company applications route"
                },
                "settings": {
                  "type": "string",
                  "description": "Company settings route"
                },
                "logo": {
                  "type": "string",
                  "description": "Company logo route"
                }
              }
            }
          }
        },
        "roles": {
          "type": "object",
          "properties": {
            "COMPANY_ROLE_EMPLOYEE": {
              "type": "string"
            },
            "COMPANY_ROLE_ADMIN": {
              "type": "string"
            }
          }
        },
        "alias": {
          "type": "number"
        },
        "security": {
          "type": "object",
          "properties": {
            "application_score": {
              "type": "number"
            },
            "two_factor": {
              "type": "boolean"
            }
          }
        },
        "self": {
          "type": "string"
        },
        "meta": {
          "type": "object",
          "properties": {
            "log": {
              "type": "string"
            },
            "applications": {
              "type": "string"
            }
          }
        }
      }
    },
    "company": {
      "type": "object",
      "properties": {
        "alias": {
          "type": "number"
        },
        "name": {
          "type": "string",
          "description": "Company Name"
        },
        "contact_email": {
          "type": "string",
          "description": "Contact email"
        },
        "domain": {
          "type": "string",
          "description": "Company domain"
        },
        "intranet_website": {
          "type": "string",
          "description": "Company internal website on mosaic"
        },
        "remaining_trial_period": {
          "type": "number",
          "description": "Remaining trial period for AppsCo Business package"
        },
        "trial_period": {
          "type": "number",
          "description": "How big is the trial period"
        },
        "image": {
          "type": "string",
          "description": "Company logo"
        },
        "primary_color": {
          "type": "string"
        },
        "secondary_color": {
          "type": "string"
        },
        "self": {
          "type": "string",
          "description": "Company self resource"
        },
        "meta": {
          "type": "object",
          "properties": {
            "applications": {
              "type": "string",
              "description": "Company applications"
            },
            "settings": {
              "type": "string",
              "description": "Company settings"
            },
            "logo": {
              "type": "string",
              "description": "Create Company logo"
            }
          }
        }
      }
    },
    "roles": {},
    "alias": {
      "type": "number"
    },
    "security": {
      "type": "object",
      "properties": {
        "application_score": {
          "type": "string"
        },
        "two_factor": {
          "type": "boolean"
        }
      }
    },
    "self": {
      "type": "string"
    },
    "meta": {
      "type": "object",
      "properties": {
        "log": {
          "type": "string"
        },
        "applications": {
          "type": "string"
        }
      }
    }
  }
}
                      
Available Integrations
Return available AppsCo Company directory integrations for currently logged in user.

Available company integrations

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "available_integrations": [
    {
      "title": "",
      "image": "",
      "website": "",
      "self": "",
      "alias": 0
    }
  ],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "available_integrations": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
Available Integration
Return available AppsCo Company available integrations for currently logged in user.

Return company integration

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "title": "",
  "image": "",
  "website": "",
  "self": "",
  "alias": 0
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "title": {
      "type": "string"
    },
    "image": {
      "type": "string"
    },
    "website": {
      "type": "string"
    },
    "self": {
      "type": "string"
    },
    "alias": {
      "type": "number"
    }
  }
}
                      

Activate company integration

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "authorization_url": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "authorization_url": {
      "type": "string"
    }
  }
}
                      
Active Integrations
Return active AppsCo Company active integrations for currently logged in user.

Return active company integrations

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "active_integrations": [
    {
      "self": "",
      "integration": {
        "title": "",
        "image": "",
        "website": "",
        "self": "",
        "alias": 0
      },
      "domains": {
        "companyName": {
          "name": "",
          "primary": false,
          "synced": false
        }
      },
      "kind": "",
      "meta": {
        "mappings": "",
        "recipes": "",
        "webHooks": "",
        "registerWatcher": "",
        "watcher": ""
      }
    }
  ],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "active_integrations": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
Single Active Integration
Return active AppsCo Company active integration for currently logged in user.

Return active company integration

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "integration_active": {
    "self": "",
    "integration": {
      "title": "",
      "image": "",
      "website": "",
      "self": "",
      "alias": 0
    },
    "domains": {
      "companyName": {
        "name": "",
        "primary": false,
        "synced": false
      }
    },
    "kind": "",
    "meta": {
      "mappings": "",
      "recipes": "",
      "webHooks": "",
      "registerWatcher": "",
      "watcher": ""
    }
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "integration_active": {
      "type": "object",
      "properties": {
        "self": {
          "type": "string"
        },
        "integration": {
          "type": "object",
          "properties": {
            "title": {
              "type": "string"
            },
            "image": {
              "type": "string"
            },
            "website": {
              "type": "string"
            },
            "self": {
              "type": "string"
            },
            "alias": {
              "type": "number"
            }
          }
        },
        "domains": {
          "type": "object",
          "properties": {
            "companyName": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "primary": {
                  "type": "boolean"
                },
                "synced": {
                  "type": "boolean"
                }
              }
            }
          }
        },
        "kind": {
          "type": "string"
        },
        "meta": {
          "type": "object",
          "properties": {
            "mappings": {
              "type": "string"
            },
            "recipes": {
              "type": "string"
            },
            "webHooks": {
              "type": "string"
            },
            "registerWatcher": {
              "type": "string"
            },
            "watcher": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
                      

Update active company integration

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "integration_active": {
    "self": "",
    "integration": {
      "title": "",
      "image": "",
      "website": "",
      "self": "",
      "alias": 0
    },
    "domains": {
      "companyName": {
        "name": "",
        "primary": false,
        "synced": false
      }
    },
    "kind": "",
    "meta": {
      "mappings": "",
      "recipes": "",
      "webHooks": "",
      "registerWatcher": "",
      "watcher": ""
    }
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "integration_active": {
      "type": "object",
      "properties": {
        "self": {
          "type": "string"
        },
        "integration": {
          "type": "object",
          "properties": {
            "title": {
              "type": "string"
            },
            "image": {
              "type": "string"
            },
            "website": {
              "type": "string"
            },
            "self": {
              "type": "string"
            },
            "alias": {
              "type": "number"
            }
          }
        },
        "domains": {
          "type": "object",
          "properties": {
            "companyName": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "primary": {
                  "type": "boolean"
                },
                "synced": {
                  "type": "boolean"
                }
              }
            }
          }
        },
        "kind": {
          "type": "string"
        },
        "meta": {
          "type": "object",
          "properties": {
            "mappings": {
              "type": "string"
            },
            "recipes": {
              "type": "string"
            },
            "webHooks": {
              "type": "string"
            },
            "registerWatcher": {
              "type": "string"
            },
            "watcher": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
                      

Remove active company integration

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "integration_active": {
    "self": "",
    "integration": {
      "title": "",
      "image": "",
      "website": "",
      "self": "",
      "alias": 0
    },
    "domains": {
      "companyName": {
        "name": "",
        "primary": false,
        "synced": false
      }
    },
    "kind": "",
    "meta": {
      "mappings": "",
      "recipes": "",
      "webHooks": "",
      "registerWatcher": "",
      "watcher": ""
    }
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "integration_active": {
      "type": "object",
      "properties": {
        "self": {
          "type": "string"
        },
        "integration": {
          "type": "object",
          "properties": {
            "title": {
              "type": "string"
            },
            "image": {
              "type": "string"
            },
            "website": {
              "type": "string"
            },
            "self": {
              "type": "string"
            },
            "alias": {
              "type": "number"
            }
          }
        },
        "domains": {
          "type": "object",
          "properties": {
            "companyName": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "primary": {
                  "type": "boolean"
                },
                "synced": {
                  "type": "boolean"
                }
              }
            }
          }
        },
        "kind": {
          "type": "string"
        },
        "meta": {
          "type": "object",
          "properties": {
            "mappings": {
              "type": "string"
            },
            "recipes": {
              "type": "string"
            },
            "webHooks": {
              "type": "string"
            },
            "registerWatcher": {
              "type": "string"
            },
            "watcher": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
                      
PSO Active Integration
Return active Company integration PSO for currently logged in user.

Return PSO list

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "psos": [
    {
      "key": "",
      "value": "",
      "conditions": [],
      "params": []
    }
  ]
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "psos": {
      "type": "array"
    }
  }
}
                      
PSO Appsco Active Integration
Return active AppsCo Company active integration PSO for currently logged in user.

Return PSO appsco

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "psos": [
    {
      "key": "",
      "value": "",
      "conditions": [],
      "params": []
    }
  ]
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "psos": {
      "type": "array"
    }
  }
}
                      
Active Integration Recipes
Return active integration recipes for currently logged in user.

Return integration recipes

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "integration-recipes": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "integration-recipes": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      

Create integration recipe

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "name": "",
  "fromMethod": "",
  "fromPSO": "",
  "fromCondition": [],
  "toMethod": "",
  "toPSO": "",
  "toField": [],
  "active": false,
  "integration": "",
  "self": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "fromMethod": {
      "type": "string"
    },
    "fromPSO": {
      "type": "string"
    },
    "fromCondition": {
      "type": "array"
    },
    "toMethod": {
      "type": "string"
    },
    "toPSO": {
      "type": "string"
    },
    "toField": {
      "type": "array"
    },
    "active": {
      "type": "boolean"
    },
    "integration": {
      "type": "string"
    },
    "self": {
      "type": "string"
    }
  }
}
                      

Update integration recipe

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "name": "",
  "fromMethod": "",
  "fromPSO": "",
  "fromCondition": [],
  "toMethod": "",
  "toPSO": "",
  "toField": [],
  "active": false,
  "integration": "",
  "self": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "fromMethod": {
      "type": "string"
    },
    "fromPSO": {
      "type": "string"
    },
    "fromCondition": {
      "type": "array"
    },
    "toMethod": {
      "type": "string"
    },
    "toPSO": {
      "type": "string"
    },
    "toField": {
      "type": "array"
    },
    "active": {
      "type": "boolean"
    },
    "integration": {
      "type": "string"
    },
    "self": {
      "type": "string"
    }
  }
}
                      

Remove integration recipe

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "name": "",
  "fromMethod": "",
  "fromPSO": "",
  "fromCondition": [],
  "toMethod": "",
  "toPSO": "",
  "toField": [],
  "active": false,
  "integration": "",
  "self": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "fromMethod": {
      "type": "string"
    },
    "fromPSO": {
      "type": "string"
    },
    "fromCondition": {
      "type": "array"
    },
    "toMethod": {
      "type": "string"
    },
    "toPSO": {
      "type": "string"
    },
    "toField": {
      "type": "array"
    },
    "active": {
      "type": "boolean"
    },
    "integration": {
      "type": "string"
    },
    "self": {
      "type": "string"
    }
  }
}
                      
Single Active Integration Recipe
Return active integration recipes for currently logged in user.

Return single integration recipe

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "name": "",
  "fromMethod": "",
  "fromPSO": "",
  "fromCondition": [],
  "toMethod": "",
  "toPSO": "",
  "toField": [],
  "active": false,
  "integration": "",
  "self": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "fromMethod": {
      "type": "string"
    },
    "fromPSO": {
      "type": "string"
    },
    "fromCondition": {
      "type": "array"
    },
    "toMethod": {
      "type": "string"
    },
    "toPSO": {
      "type": "string"
    },
    "toField": {
      "type": "array"
    },
    "active": {
      "type": "boolean"
    },
    "integration": {
      "type": "string"
    },
    "self": {
      "type": "string"
    }
  }
}
                      
Single Active Integration Recipe Run
Return active integration recipes run for currently logged in user.

Run single integration recipe

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "array[Company Role Account]": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "array[Company Role Account]": {
      "type": "string"
    }
  }
}
                      
Active Integration Web Hooks
Return active integration web hooks for currently logged in user.

Retrieve integration web hooks

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "web_hooks": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "web_hooks": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
Single Active Integration Web Hook
Return active integration web hooks for currently logged in user.

Retrieve integration web hooks

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "title": "",
  "action": "",
  "alias": "",
  "fromMethod": "",
  "self": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "title": {
      "type": "string"
    },
    "action": {
      "type": "string"
    },
    "alias": {
      "type": "string"
    },
    "fromMethod": {
      "type": "string"
    },
    "self": {
      "type": "string"
    }
  }
}
                      
Company Directory Invitation
Return AppsCo Company invitation for currently logged in user.

Return company invitation

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "alias": "",
  "company": {
    "alias": 0,
    "name": "",
    "contact_email": "",
    "billing_email": "",
    "domain": "",
    "intranet_website": "",
    "remaining_trial_period": 0,
    "trial_period": 0,
    "image": "",
    "primary_color": "",
    "secondary_color": "",
    "self": "",
    "meta": {
      "applications": "",
      "settings": "",
      "logo": ""
    }
  },
  "email": "",
  "first_name": "",
  "last_name": "",
  "created_at": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "resent_at": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "resent_count": 0,
  "self": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "alias": {
      "type": "string"
    },
    "company": {
      "type": "object",
      "properties": {
        "alias": {
          "type": "number"
        },
        "name": {
          "type": "string",
          "description": "Name of company"
        },
        "contact_email": {
          "type": "string",
          "description": "Contact email"
        },
        "billing_email": {
          "type": "string",
          "description": "Billing email"
        },
        "domain": {
          "type": "string",
          "description": "Domain of company"
        },
        "intranet_website": {
          "type": "string",
          "description": "Intranet website of company"
        },
        "remaining_trial_period": {
          "type": "number",
          "description": "Remaining trial period"
        },
        "trial_period": {
          "type": "number",
          "description": "Trial period"
        },
        "image": {
          "type": "string",
          "description": "Image route"
        },
        "primary_color": {
          "type": "string"
        },
        "secondary_color": {
          "type": "string"
        },
        "self": {
          "type": "string",
          "description": "Company route"
        },
        "meta": {
          "type": "object",
          "properties": {
            "applications": {
              "type": "string",
              "description": "Company applications route"
            },
            "settings": {
              "type": "string",
              "description": "Company settings route"
            },
            "logo": {
              "type": "string",
              "description": "Company logo route"
            }
          }
        }
      }
    },
    "email": {
      "type": "string"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "created_at": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "resent_at": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "resent_count": {
      "type": "number"
    },
    "self": {
      "type": "string"
    }
  }
}
                      

Remove company invitation

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "alias": "",
  "company": {
    "alias": 0,
    "name": "",
    "contact_email": "",
    "billing_email": "",
    "domain": "",
    "intranet_website": "",
    "remaining_trial_period": 0,
    "trial_period": 0,
    "image": "",
    "primary_color": "",
    "secondary_color": "",
    "self": "",
    "meta": {
      "applications": "",
      "settings": "",
      "logo": ""
    }
  },
  "email": "",
  "first_name": "",
  "last_name": "",
  "created_at": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "resent_at": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "resent_count": 0,
  "self": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "alias": {
      "type": "string"
    },
    "company": {
      "type": "object",
      "properties": {
        "alias": {
          "type": "number"
        },
        "name": {
          "type": "string",
          "description": "Name of company"
        },
        "contact_email": {
          "type": "string",
          "description": "Contact email"
        },
        "billing_email": {
          "type": "string",
          "description": "Billing email"
        },
        "domain": {
          "type": "string",
          "description": "Domain of company"
        },
        "intranet_website": {
          "type": "string",
          "description": "Intranet website of company"
        },
        "remaining_trial_period": {
          "type": "number",
          "description": "Remaining trial period"
        },
        "trial_period": {
          "type": "number",
          "description": "Trial period"
        },
        "image": {
          "type": "string",
          "description": "Image route"
        },
        "primary_color": {
          "type": "string"
        },
        "secondary_color": {
          "type": "string"
        },
        "self": {
          "type": "string",
          "description": "Company route"
        },
        "meta": {
          "type": "object",
          "properties": {
            "applications": {
              "type": "string",
              "description": "Company applications route"
            },
            "settings": {
              "type": "string",
              "description": "Company settings route"
            },
            "logo": {
              "type": "string",
              "description": "Company logo route"
            }
          }
        }
      }
    },
    "email": {
      "type": "string"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "created_at": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "resent_at": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "resent_count": {
      "type": "number"
    },
    "self": {
      "type": "string"
    }
  }
}
                      
Company Directory Resend Invitation
Resend AppsCo Company invitation for currently logged in user.

Resend company invitation

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "alias": "",
  "company": {
    "alias": 0,
    "name": "",
    "contact_email": "",
    "billing_email": "",
    "domain": "",
    "intranet_website": "",
    "remaining_trial_period": 0,
    "trial_period": 0,
    "image": "",
    "primary_color": "",
    "secondary_color": "",
    "self": "",
    "meta": {
      "applications": "",
      "settings": "",
      "logo": ""
    }
  },
  "email": "",
  "first_name": "",
  "last_name": "",
  "created_at": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "resent_at": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "resent_count": 0,
  "self": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "alias": {
      "type": "string"
    },
    "company": {
      "type": "object",
      "properties": {
        "alias": {
          "type": "number"
        },
        "name": {
          "type": "string",
          "description": "Name of company"
        },
        "contact_email": {
          "type": "string",
          "description": "Contact email"
        },
        "billing_email": {
          "type": "string",
          "description": "Billing email"
        },
        "domain": {
          "type": "string",
          "description": "Domain of company"
        },
        "intranet_website": {
          "type": "string",
          "description": "Intranet website of company"
        },
        "remaining_trial_period": {
          "type": "number",
          "description": "Remaining trial period"
        },
        "trial_period": {
          "type": "number",
          "description": "Trial period"
        },
        "image": {
          "type": "string",
          "description": "Image route"
        },
        "primary_color": {
          "type": "string"
        },
        "secondary_color": {
          "type": "string"
        },
        "self": {
          "type": "string",
          "description": "Company route"
        },
        "meta": {
          "type": "object",
          "properties": {
            "applications": {
              "type": "string",
              "description": "Company applications route"
            },
            "settings": {
              "type": "string",
              "description": "Company settings route"
            },
            "logo": {
              "type": "string",
              "description": "Company logo route"
            }
          }
        }
      }
    },
    "email": {
      "type": "string"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "created_at": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "resent_at": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "resent_count": {
      "type": "number"
    },
    "self": {
      "type": "string"
    }
  }
}
                      
Company Directory Invitation
Return AppsCo Company invitation for currently logged in user.

Return company invitation

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "alias": "",
  "company": {
    "alias": 0,
    "name": "",
    "contact_email": "",
    "billing_email": "",
    "domain": "",
    "intranet_website": "",
    "remaining_trial_period": 0,
    "trial_period": 0,
    "image": "",
    "primary_color": "",
    "secondary_color": "",
    "self": "",
    "meta": {
      "applications": "",
      "settings": "",
      "logo": ""
    }
  },
  "email": "",
  "first_name": "",
  "last_name": "",
  "created_at": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "resent_at": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "resent_count": 0,
  "self": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "alias": {
      "type": "string"
    },
    "company": {
      "type": "object",
      "properties": {
        "alias": {
          "type": "number"
        },
        "name": {
          "type": "string",
          "description": "Name of company"
        },
        "contact_email": {
          "type": "string",
          "description": "Contact email"
        },
        "billing_email": {
          "type": "string",
          "description": "Billing email"
        },
        "domain": {
          "type": "string",
          "description": "Domain of company"
        },
        "intranet_website": {
          "type": "string",
          "description": "Intranet website of company"
        },
        "remaining_trial_period": {
          "type": "number",
          "description": "Remaining trial period"
        },
        "trial_period": {
          "type": "number",
          "description": "Trial period"
        },
        "image": {
          "type": "string",
          "description": "Image route"
        },
        "primary_color": {
          "type": "string"
        },
        "secondary_color": {
          "type": "string"
        },
        "self": {
          "type": "string",
          "description": "Company route"
        },
        "meta": {
          "type": "object",
          "properties": {
            "applications": {
              "type": "string",
              "description": "Company applications route"
            },
            "settings": {
              "type": "string",
              "description": "Company settings route"
            },
            "logo": {
              "type": "string",
              "description": "Company logo route"
            }
          }
        }
      }
    },
    "email": {
      "type": "string"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "created_at": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "resent_at": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "resent_count": {
      "type": "number"
    },
    "self": {
      "type": "string"
    }
  }
}
                      

Remove company invitation

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "alias": "",
  "company": {
    "alias": 0,
    "name": "",
    "contact_email": "",
    "billing_email": "",
    "domain": "",
    "intranet_website": "",
    "remaining_trial_period": 0,
    "trial_period": 0,
    "image": "",
    "primary_color": "",
    "secondary_color": "",
    "self": "",
    "meta": {
      "applications": "",
      "settings": "",
      "logo": ""
    }
  },
  "email": "",
  "first_name": "",
  "last_name": "",
  "created_at": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "resent_at": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "resent_count": 0,
  "self": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "alias": {
      "type": "string"
    },
    "company": {
      "type": "object",
      "properties": {
        "alias": {
          "type": "number"
        },
        "name": {
          "type": "string",
          "description": "Name of company"
        },
        "contact_email": {
          "type": "string",
          "description": "Contact email"
        },
        "billing_email": {
          "type": "string",
          "description": "Billing email"
        },
        "domain": {
          "type": "string",
          "description": "Domain of company"
        },
        "intranet_website": {
          "type": "string",
          "description": "Intranet website of company"
        },
        "remaining_trial_period": {
          "type": "number",
          "description": "Remaining trial period"
        },
        "trial_period": {
          "type": "number",
          "description": "Trial period"
        },
        "image": {
          "type": "string",
          "description": "Image route"
        },
        "primary_color": {
          "type": "string"
        },
        "secondary_color": {
          "type": "string"
        },
        "self": {
          "type": "string",
          "description": "Company route"
        },
        "meta": {
          "type": "object",
          "properties": {
            "applications": {
              "type": "string",
              "description": "Company applications route"
            },
            "settings": {
              "type": "string",
              "description": "Company settings route"
            },
            "logo": {
              "type": "string",
              "description": "Company logo route"
            }
          }
        }
      }
    },
    "email": {
      "type": "string"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "created_at": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "resent_at": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "resent_count": {
      "type": "number"
    },
    "self": {
      "type": "string"
    }
  }
}
                      
Company Settings
Update AppsCo Company settings for currently logged in user.

Update company settings

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "alias": 0,
  "name": "",
  "contact_email": "",
  "domain": "",
  "intranet_website": "",
  "remaining_trial_period": 0,
  "trial_period": 0,
  "image": "",
  "primary_color": "",
  "secondary_color": "",
  "self": "",
  "meta": {
    "applications": "",
    "settings": "",
    "logo": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "alias": {
      "type": "number"
    },
    "name": {
      "type": "string",
      "description": "Company Name"
    },
    "contact_email": {
      "type": "string",
      "description": "Contact email"
    },
    "domain": {
      "type": "string",
      "description": "Company domain"
    },
    "intranet_website": {
      "type": "string",
      "description": "Company internal website on mosaic"
    },
    "remaining_trial_period": {
      "type": "number",
      "description": "Remaining trial period for AppsCo Business package"
    },
    "trial_period": {
      "type": "number",
      "description": "How big is the trial period"
    },
    "image": {
      "type": "string",
      "description": "Company logo"
    },
    "primary_color": {
      "type": "string"
    },
    "secondary_color": {
      "type": "string"
    },
    "self": {
      "type": "string",
      "description": "Company self resource"
    },
    "meta": {
      "type": "object",
      "properties": {
        "applications": {
          "type": "string",
          "description": "Company applications"
        },
        "settings": {
          "type": "string",
          "description": "Company settings"
        },
        "logo": {
          "type": "string",
          "description": "Create Company logo"
        }
      }
    }
  }
}
                      
Company Branding
Update AppsCo Company branding for currently logged in user.

Update company branding

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "alias": 0,
  "name": "",
  "contact_email": "",
  "domain": "",
  "intranet_website": "",
  "remaining_trial_period": 0,
  "trial_period": 0,
  "image": "",
  "primary_color": "",
  "secondary_color": "",
  "self": "",
  "meta": {
    "applications": "",
    "settings": "",
    "logo": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "alias": {
      "type": "number"
    },
    "name": {
      "type": "string",
      "description": "Company Name"
    },
    "contact_email": {
      "type": "string",
      "description": "Contact email"
    },
    "domain": {
      "type": "string",
      "description": "Company domain"
    },
    "intranet_website": {
      "type": "string",
      "description": "Company internal website on mosaic"
    },
    "remaining_trial_period": {
      "type": "number",
      "description": "Remaining trial period for AppsCo Business package"
    },
    "trial_period": {
      "type": "number",
      "description": "How big is the trial period"
    },
    "image": {
      "type": "string",
      "description": "Company logo"
    },
    "primary_color": {
      "type": "string"
    },
    "secondary_color": {
      "type": "string"
    },
    "self": {
      "type": "string",
      "description": "Company self resource"
    },
    "meta": {
      "type": "object",
      "properties": {
        "applications": {
          "type": "string",
          "description": "Company applications"
        },
        "settings": {
          "type": "string",
          "description": "Company settings"
        },
        "logo": {
          "type": "string",
          "description": "Create Company logo"
        }
      }
    }
  }
}
                      
Company Logo
Update AppsCo Company logo for currently logged in user.

REQUEST

Headers
Authorization token absdef12345
                          -----WebKitFormBoundary7Lk1ieut0jQaBl3L
    Content-Disposition: form-data; name="file"; filename="example_img.png"
    Content-Type: image/png
-----WebKitFormBoundary7Lk1ieut0jQaBl3L--

                        
                          
                        

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "alias": 0,
  "name": "",
  "contact_email": "",
  "domain": "",
  "intranet_website": "",
  "remaining_trial_period": 0,
  "trial_period": 0,
  "image": "",
  "primary_color": "",
  "secondary_color": "",
  "self": "",
  "meta": {
    "applications": "",
    "settings": "",
    "logo": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "alias": {
      "type": "number"
    },
    "name": {
      "type": "string",
      "description": "Company Name"
    },
    "contact_email": {
      "type": "string",
      "description": "Contact email"
    },
    "domain": {
      "type": "string",
      "description": "Company domain"
    },
    "intranet_website": {
      "type": "string",
      "description": "Company internal website on mosaic"
    },
    "remaining_trial_period": {
      "type": "number",
      "description": "Remaining trial period for AppsCo Business package"
    },
    "trial_period": {
      "type": "number",
      "description": "How big is the trial period"
    },
    "image": {
      "type": "string",
      "description": "Company logo"
    },
    "primary_color": {
      "type": "string"
    },
    "secondary_color": {
      "type": "string"
    },
    "self": {
      "type": "string",
      "description": "Company self resource"
    },
    "meta": {
      "type": "object",
      "properties": {
        "applications": {
          "type": "string",
          "description": "Company applications"
        },
        "settings": {
          "type": "string",
          "description": "Company settings"
        },
        "logo": {
          "type": "string",
          "description": "Create Company logo"
        }
      }
    }
  }
}
                      
Company Signup
Return AppsCo Company signup for currently logged in user.

Retrieve company signup

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "items": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "items": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
Confirm Company Signup Request
Return AppsCo Company signup for currently logged in user.

Confirm company signup request

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "dashboard_roles": [],
  "email": "",
  "timezone": "",
  "country": "",
  "created_at": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "name": "",
  "enabled": false,
  "first_name": "",
  "last_name": "",
  "gender": "",
  "last_login": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "locale": "",
  "phone": "",
  "picture_url": "",
  "username": "",
  "roles": {
    "OWNER": "",
    "ADMIN": "",
    "SHARED": ""
  },
  "display_name": "",
  "profile_options": {
    "public": false
  },
  "partner": false,
  "companies": {
    "company": [
      {
        "alias": 0,
        "name": "",
        "contact_email": "",
        "billing_email": "",
        "domain": "",
        "intranet_website": "",
        "remaining_trial_period": 0,
        "trial_period": 0,
        "image": "",
        "primary_color": "",
        "secondary_color": "",
        "self": "",
        "meta": {
          "applications": "",
          "settings": "",
          "logo": ""
        }
      }
    ],
    "icons": "",
    "company_admin": false
  },
  "org_units": [
    {
      "name": "",
      "description": "",
      "alias": 0,
      "meta": {
        "remove": ""
      }
    }
  ],
  "meta": {
    "share": ""
  },
  "self": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "dashboard_roles": {},
    "email": {
      "type": "string"
    },
    "timezone": {
      "type": "string"
    },
    "country": {
      "type": "string"
    },
    "created_at": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "name": {
      "type": "string"
    },
    "enabled": {
      "type": "boolean"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "gender": {
      "type": "string"
    },
    "last_login": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "locale": {
      "type": "string"
    },
    "phone": {
      "type": "string"
    },
    "picture_url": {
      "type": "string"
    },
    "username": {
      "type": "string"
    },
    "roles": {
      "type": "object",
      "properties": {
        "OWNER": {
          "type": "string"
        },
        "ADMIN": {
          "type": "string"
        },
        "SHARED": {
          "type": "string"
        }
      },
      "required": [
        "OWNER",
        "ADMIN",
        "SHARED"
      ],
      "additionalProperties": false
    },
    "display_name": {
      "type": "string"
    },
    "profile_options": {
      "type": "object",
      "properties": {
        "public": {
          "type": "boolean"
        }
      }
    },
    "partner": {
      "type": "boolean"
    },
    "companies": {
      "type": "object",
      "properties": {
        "company": {
          "type": "array"
        },
        "icons": {
          "type": "string"
        },
        "company_admin": {
          "type": "boolean"
        }
      }
    },
    "org_units": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "share": {
          "type": "string"
        }
      }
    },
    "self": {
      "type": "string"
    }
  }
}
                      
Delete Company Signup Request
Delete AppsCo Company signup for currently logged in user.

Delete company signup request

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "email": "",
  "createdOn": "",
  "self": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "email": {
      "type": "string"
    },
    "createdOn": {
      "type": "string"
    },
    "self": {
      "type": "string"
    }
  }
}
                      
Company Labels
Return AppsCo Company labels for currently logged in user.

Retrieve company labels

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "company_labels": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "company_labels": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      

Create company label

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "alias": "",
  "company": {
    "alias": 0,
    "name": "",
    "contact_email": "",
    "domain": "",
    "intranet_website": "",
    "remaining_trial_period": 0,
    "trial_period": 0,
    "image": "",
    "primary_color": "",
    "secondary_color": "",
    "self": "",
    "meta": {
      "applications": "",
      "settings": "",
      "logo": ""
    }
  },
  "name": "",
  "cratedAt": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "meta": {
    "company_roles": [],
    "applications": [],
    "self": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "alias": {
      "type": "string"
    },
    "company": {
      "type": "object",
      "properties": {
        "alias": {
          "type": "number"
        },
        "name": {
          "type": "string",
          "description": "Company Name"
        },
        "contact_email": {
          "type": "string",
          "description": "Contact email"
        },
        "domain": {
          "type": "string",
          "description": "Company domain"
        },
        "intranet_website": {
          "type": "string",
          "description": "Company internal website on mosaic"
        },
        "remaining_trial_period": {
          "type": "number",
          "description": "Remaining trial period for AppsCo Business package"
        },
        "trial_period": {
          "type": "number",
          "description": "How big is the trial period"
        },
        "image": {
          "type": "string",
          "description": "Company logo"
        },
        "primary_color": {
          "type": "string"
        },
        "secondary_color": {
          "type": "string"
        },
        "self": {
          "type": "string",
          "description": "Company self resource"
        },
        "meta": {
          "type": "object",
          "properties": {
            "applications": {
              "type": "string",
              "description": "Company applications"
            },
            "settings": {
              "type": "string",
              "description": "Company settings"
            },
            "logo": {
              "type": "string",
              "description": "Create Company logo"
            }
          }
        }
      }
    },
    "name": {
      "type": "string"
    },
    "cratedAt": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "company_roles": {
          "type": "array"
        },
        "applications": {
          "type": "array"
        },
        "self": {
          "type": "string"
        }
      }
    }
  }
}
                      
Company Label
Return AppsCo Company label for currently logged in user.

Retrieve company label

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "company_label": {
    "alias": "",
    "company": {
      "alias": 0,
      "name": "",
      "contact_email": "",
      "domain": "",
      "intranet_website": "",
      "remaining_trial_period": 0,
      "trial_period": 0,
      "image": "",
      "primary_color": "",
      "secondary_color": "",
      "self": "",
      "meta": {
        "applications": "",
        "settings": "",
        "logo": ""
      }
    },
    "name": "",
    "cratedAt": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "meta": {
      "company_roles": [],
      "applications": [],
      "self": ""
    }
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "company_label": {
      "type": "object",
      "properties": {
        "alias": {
          "type": "string"
        },
        "company": {
          "type": "object",
          "properties": {
            "alias": {
              "type": "number"
            },
            "name": {
              "type": "string",
              "description": "Company Name"
            },
            "contact_email": {
              "type": "string",
              "description": "Contact email"
            },
            "domain": {
              "type": "string",
              "description": "Company domain"
            },
            "intranet_website": {
              "type": "string",
              "description": "Company internal website on mosaic"
            },
            "remaining_trial_period": {
              "type": "number",
              "description": "Remaining trial period for AppsCo Business package"
            },
            "trial_period": {
              "type": "number",
              "description": "How big is the trial period"
            },
            "image": {
              "type": "string",
              "description": "Company logo"
            },
            "primary_color": {
              "type": "string"
            },
            "secondary_color": {
              "type": "string"
            },
            "self": {
              "type": "string",
              "description": "Company self resource"
            },
            "meta": {
              "type": "object",
              "properties": {
                "applications": {
                  "type": "string",
                  "description": "Company applications"
                },
                "settings": {
                  "type": "string",
                  "description": "Company settings"
                },
                "logo": {
                  "type": "string",
                  "description": "Create Company logo"
                }
              }
            }
          }
        },
        "name": {
          "type": "string"
        },
        "cratedAt": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "meta": {
          "type": "object",
          "properties": {
            "company_roles": {
              "type": "array"
            },
            "applications": {
              "type": "array"
            },
            "self": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
                      

Remove company label

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "message": "",
  "code": 0
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "code": {
      "type": "number",
      "description": "Response code"
    }
  }
}
                      
Label Company Roles
Return AppsCo label company roles for currently logged in user.

Retrieve company label company roles

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "company_roles": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "company_roles": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
Label Company Role
Detach AppsCo label company roles for currently logged in user.

Detach company label company role

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "message": "",
  "code": 0
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "code": {
      "type": "number",
      "description": "Response code"
    }
  }
}
                      
Label Company Resources
Return AppsCo label company resources for currently logged in user.

Retrieve company label company resources

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "applications": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "applications": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
Label Company Resource
Detach AppsCo label company resource for currently logged in user.

Detach company label company resource

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "application": {
    "id": 0,
    "title": "",
    "url": "",
    "url_editable": false,
    "icon_url": "",
    "auth_types": []
  },
  "Response": {
    "message": "",
    "code": 0
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "application": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Id of application"
        },
        "title": {
          "type": "string",
          "description": "Name of application"
        },
        "url": {
          "type": "string",
          "description": "Url of application"
        },
        "url_editable": {
          "type": "boolean",
          "description": "If url of applications is editable"
        },
        "icon_url": {
          "type": "string",
          "description": "Url of application's icon"
        },
        "auth_types": {
          "description": "Application authorization type"
        }
      }
    },
    "Response": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string"
        },
        "code": {
          "type": "number",
          "description": "Response code"
        }
      }
    }
  }
}
                      
Company Statistics Two Factor
Return AppsCo label company statistics for two factor.

Retrieve company two factor statistics

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "active": 0,
  "inactive": 0
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "active": {
      "type": "number"
    },
    "inactive": {
      "type": "number"
    }
  }
}
                      
Company Statistics Licences
Return AppsCo label company statistics licences.

Retrieve company licences

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "appscoLicences": 0,
  "currentLicences": 0,
  "active_users": 0
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "appscoLicences": {
      "type": "number"
    },
    "currentLicences": {
      "type": "number"
    },
    "active_users": {
      "type": "number"
    }
  }
}
                      
Company Statistics User Password Scores
Return AppsCo label company statistics user password scores.

Retrieve company user password scores

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "id": 0,
  "dashboard_roles": [],
  "email": "",
  "timezone": "",
  "country": "",
  "created_at": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "name": "",
  "enabled": false,
  "first_name": "",
  "last_name": "",
  "gender": "",
  "last_login": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "locale": "",
  "phone": "",
  "picture_url": "",
  "username": "",
  "roles": {
    "OWNER": "",
    "ADMIN": "",
    "SHARED": ""
  },
  "display_name": "",
  "profile_options": {
    "public": false
  },
  "partner": false,
  "companies": [
    {
      "company": [
        {
          "alias": 0,
          "name": "",
          "contact_email": "",
          "billing_email": "",
          "domain": "",
          "intranet_website": "",
          "remaining_trial_period": 0,
          "trial_period": 0,
          "image": "",
          "primary_color": "",
          "secondary_color": "",
          "self": "",
          "meta": {
            "applications": "",
            "settings": "",
            "logo": ""
          }
        },
        "icons",
        "company_admin"
      ],
      "meta": {
        "share": ""
      },
      "self": ""
    }
  ],
  "application_scores": []
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "dashboard_roles": {},
    "email": {
      "type": "string"
    },
    "timezone": {
      "type": "string"
    },
    "country": {
      "type": "string"
    },
    "created_at": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "name": {
      "type": "string"
    },
    "enabled": {
      "type": "boolean"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "gender": {
      "type": "string"
    },
    "last_login": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "locale": {
      "type": "string"
    },
    "phone": {
      "type": "string"
    },
    "picture_url": {
      "type": "string"
    },
    "username": {
      "type": "string"
    },
    "roles": {
      "type": "object",
      "properties": {
        "OWNER": {
          "type": "string"
        },
        "ADMIN": {
          "type": "string"
        },
        "SHARED": {
          "type": "string"
        }
      },
      "required": [
        "OWNER",
        "ADMIN",
        "SHARED"
      ],
      "additionalProperties": false
    },
    "display_name": {
      "type": "string"
    },
    "profile_options": {
      "type": "object",
      "properties": {
        "public": {
          "type": "boolean"
        }
      }
    },
    "partner": {
      "type": "boolean"
    },
    "companies": {
      "type": "array"
    },
    "application_scores": {
      "type": "array"
    }
  }
}
                      
Company Contacts
Return AppsCo Company contacts for currently logged in user.

Retrieve company contacts

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "contacts": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "contacts": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      

Create company contacts

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "alias": "",
  "company": "",
  "account": "",
  "first_name": "",
  "last_name": "",
  "display_name": "",
  "email": "",
  "createdAt": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "self": "",
  "meta": {
    "promote_to_user": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "alias": {
      "type": "string"
    },
    "company": {
      "type": "string",
      "description": "Company url"
    },
    "account": {
      "type": "string",
      "description": "Account url"
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "display_name": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "createdAt": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "self": {
      "type": "string"
    },
    "meta": {
      "type": "object",
      "properties": {
        "promote_to_user": {
          "type": "string"
        }
      }
    }
  }
}
                      
Company Contact
Return AppsCo Company contact.

Retrieve company contact

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "alias": "",
  "company": "",
  "account": {
    "id": 0,
    "dashboard_roles": [],
    "email": "",
    "timezone": "",
    "country": "",
    "created_at": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "name": "",
    "enabled": false,
    "first_name": "",
    "last_name": "",
    "gender": "",
    "last_login": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "locale": "",
    "phone": "",
    "picture_url": "",
    "username": "",
    "roles": {
      "OWNER": "",
      "ADMIN": "",
      "SHARED": ""
    },
    "display_name": "",
    "profile_options": {
      "public": false
    },
    "partner": false,
    "companies": {
      "company": [
        {
          "alias": 0,
          "name": "",
          "contact_email": "",
          "billing_email": "",
          "domain": "",
          "intranet_website": "",
          "remaining_trial_period": 0,
          "trial_period": 0,
          "image": "",
          "primary_color": "",
          "secondary_color": "",
          "self": "",
          "meta": {
            "applications": "",
            "settings": "",
            "logo": ""
          }
        }
      ],
      "icons": "",
      "company_admin": false
    },
    "org_units": [
      {
        "name": "",
        "description": "",
        "alias": 0,
        "meta": {
          "remove": ""
        }
      }
    ],
    "meta": {
      "share": ""
    },
    "self": ""
  },
  "first_name": "",
  "last_name": "",
  "display_name": "",
  "email": "",
  "createdAt": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "self": "",
  "meta": {
    "promote_to_user": "",
    "applications": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "alias": {
      "type": "string"
    },
    "company": {
      "type": "string",
      "description": "Company url"
    },
    "account": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "dashboard_roles": {},
        "email": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "created_at": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "name": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "first_name": {
          "type": "string"
        },
        "last_name": {
          "type": "string"
        },
        "gender": {
          "type": "string"
        },
        "last_login": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "locale": {
          "type": "string"
        },
        "phone": {
          "type": "string"
        },
        "picture_url": {
          "type": "string"
        },
        "username": {
          "type": "string"
        },
        "roles": {
          "type": "object",
          "properties": {
            "OWNER": {
              "type": "string"
            },
            "ADMIN": {
              "type": "string"
            },
            "SHARED": {
              "type": "string"
            }
          },
          "required": [
            "OWNER",
            "ADMIN",
            "SHARED"
          ],
          "additionalProperties": false
        },
        "display_name": {
          "type": "string"
        },
        "profile_options": {
          "type": "object",
          "properties": {
            "public": {
              "type": "boolean"
            }
          }
        },
        "partner": {
          "type": "boolean"
        },
        "companies": {
          "type": "object",
          "properties": {
            "company": {
              "type": "array"
            },
            "icons": {
              "type": "string"
            },
            "company_admin": {
              "type": "boolean"
            }
          }
        },
        "org_units": {
          "type": "array"
        },
        "meta": {
          "type": "object",
          "properties": {
            "share": {
              "type": "string"
            }
          }
        },
        "self": {
          "type": "string"
        }
      }
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "display_name": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "createdAt": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "self": {
      "type": "string"
    },
    "meta": {
      "type": "object",
      "properties": {
        "promote_to_user": {
          "type": "string"
        },
        "applications": {
          "type": "string"
        }
      }
    }
  }
}
                      

Delete company contact

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "alias": "",
  "company": "",
  "account": {
    "id": 0,
    "dashboard_roles": [],
    "email": "",
    "timezone": "",
    "country": "",
    "created_at": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "name": "",
    "enabled": false,
    "first_name": "",
    "last_name": "",
    "gender": "",
    "last_login": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "locale": "",
    "phone": "",
    "picture_url": "",
    "username": "",
    "roles": {
      "OWNER": "",
      "ADMIN": "",
      "SHARED": ""
    },
    "display_name": "",
    "profile_options": {
      "public": false
    },
    "partner": false,
    "companies": {
      "company": [
        {
          "alias": 0,
          "name": "",
          "contact_email": "",
          "billing_email": "",
          "domain": "",
          "intranet_website": "",
          "remaining_trial_period": 0,
          "trial_period": 0,
          "image": "",
          "primary_color": "",
          "secondary_color": "",
          "self": "",
          "meta": {
            "applications": "",
            "settings": "",
            "logo": ""
          }
        }
      ],
      "icons": "",
      "company_admin": false
    },
    "org_units": [
      {
        "name": "",
        "description": "",
        "alias": 0,
        "meta": {
          "remove": ""
        }
      }
    ],
    "meta": {
      "share": ""
    },
    "self": ""
  },
  "first_name": "",
  "last_name": "",
  "display_name": "",
  "email": "",
  "createdAt": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "self": "",
  "meta": {
    "promote_to_user": "",
    "applications": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "alias": {
      "type": "string"
    },
    "company": {
      "type": "string",
      "description": "Company url"
    },
    "account": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "dashboard_roles": {},
        "email": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "created_at": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "name": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "first_name": {
          "type": "string"
        },
        "last_name": {
          "type": "string"
        },
        "gender": {
          "type": "string"
        },
        "last_login": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "locale": {
          "type": "string"
        },
        "phone": {
          "type": "string"
        },
        "picture_url": {
          "type": "string"
        },
        "username": {
          "type": "string"
        },
        "roles": {
          "type": "object",
          "properties": {
            "OWNER": {
              "type": "string"
            },
            "ADMIN": {
              "type": "string"
            },
            "SHARED": {
              "type": "string"
            }
          },
          "required": [
            "OWNER",
            "ADMIN",
            "SHARED"
          ],
          "additionalProperties": false
        },
        "display_name": {
          "type": "string"
        },
        "profile_options": {
          "type": "object",
          "properties": {
            "public": {
              "type": "boolean"
            }
          }
        },
        "partner": {
          "type": "boolean"
        },
        "companies": {
          "type": "object",
          "properties": {
            "company": {
              "type": "array"
            },
            "icons": {
              "type": "string"
            },
            "company_admin": {
              "type": "boolean"
            }
          }
        },
        "org_units": {
          "type": "array"
        },
        "meta": {
          "type": "object",
          "properties": {
            "share": {
              "type": "string"
            }
          }
        },
        "self": {
          "type": "string"
        }
      }
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "display_name": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "createdAt": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "self": {
      "type": "string"
    },
    "meta": {
      "type": "object",
      "properties": {
        "promote_to_user": {
          "type": "string"
        },
        "applications": {
          "type": "string"
        }
      }
    }
  }
}
                      
Company Contact Convert to User
Convert AppsCo Company contact to user.

Convert company contact to user

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "alias": "",
  "company": "",
  "account": {
    "id": 0,
    "dashboard_roles": [],
    "email": "",
    "timezone": "",
    "country": "",
    "created_at": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "name": "",
    "enabled": false,
    "first_name": "",
    "last_name": "",
    "gender": "",
    "last_login": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "locale": "",
    "phone": "",
    "picture_url": "",
    "username": "",
    "roles": {
      "OWNER": "",
      "ADMIN": "",
      "SHARED": ""
    },
    "display_name": "",
    "profile_options": {
      "public": false
    },
    "partner": false,
    "companies": {
      "company": [
        {
          "alias": 0,
          "name": "",
          "contact_email": "",
          "billing_email": "",
          "domain": "",
          "intranet_website": "",
          "remaining_trial_period": 0,
          "trial_period": 0,
          "image": "",
          "primary_color": "",
          "secondary_color": "",
          "self": "",
          "meta": {
            "applications": "",
            "settings": "",
            "logo": ""
          }
        }
      ],
      "icons": "",
      "company_admin": false
    },
    "org_units": [
      {
        "name": "",
        "description": "",
        "alias": 0,
        "meta": {
          "remove": ""
        }
      }
    ],
    "meta": {
      "share": ""
    },
    "self": ""
  },
  "first_name": "",
  "last_name": "",
  "display_name": "",
  "email": "",
  "createdAt": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "self": "",
  "meta": {
    "promote_to_user": "",
    "applications": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "alias": {
      "type": "string"
    },
    "company": {
      "type": "string",
      "description": "Company url"
    },
    "account": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "dashboard_roles": {},
        "email": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "created_at": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "name": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "first_name": {
          "type": "string"
        },
        "last_name": {
          "type": "string"
        },
        "gender": {
          "type": "string"
        },
        "last_login": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "locale": {
          "type": "string"
        },
        "phone": {
          "type": "string"
        },
        "picture_url": {
          "type": "string"
        },
        "username": {
          "type": "string"
        },
        "roles": {
          "type": "object",
          "properties": {
            "OWNER": {
              "type": "string"
            },
            "ADMIN": {
              "type": "string"
            },
            "SHARED": {
              "type": "string"
            }
          },
          "required": [
            "OWNER",
            "ADMIN",
            "SHARED"
          ],
          "additionalProperties": false
        },
        "display_name": {
          "type": "string"
        },
        "profile_options": {
          "type": "object",
          "properties": {
            "public": {
              "type": "boolean"
            }
          }
        },
        "partner": {
          "type": "boolean"
        },
        "companies": {
          "type": "object",
          "properties": {
            "company": {
              "type": "array"
            },
            "icons": {
              "type": "string"
            },
            "company_admin": {
              "type": "boolean"
            }
          }
        },
        "org_units": {
          "type": "array"
        },
        "meta": {
          "type": "object",
          "properties": {
            "share": {
              "type": "string"
            }
          }
        },
        "self": {
          "type": "string"
        }
      }
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "display_name": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "createdAt": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "self": {
      "type": "string"
    },
    "meta": {
      "type": "object",
      "properties": {
        "promote_to_user": {
          "type": "string"
        },
        "applications": {
          "type": "string"
        }
      }
    }
  }
}
                      
Company Contact Applications
Return AppsCo Company contact applications.

Retrieve company contact

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "applications": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "applications": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
Import Company Contacts
Import AppsCo Company contacts.

Retrieve company contact

REQUEST

Headers
Authorization token absdef12345
                          ------WebKitFormBoundaryWv7iqlq6qDMpd3WH
    Content-Disposition: form-data; name="file"; filename="example_import.csv"
    Content-Type: application/octet-stream
------WebKitFormBoundaryWv7iqlq6qDMpd3WH--

                        
                          
                        

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "total": 0,
  "numberOfContacts": 0,
  "numberOfInvitations": 0,
  "numberOfFailed": 0
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "total": {
      "type": "number"
    },
    "numberOfContacts": {
      "type": "number"
    },
    "numberOfInvitations": {
      "type": "number"
    },
    "numberOfFailed": {
      "type": "number"
    }
  }
}
                      
Company Groups
Return AppsCo Company groups for currently logged in user.

Retrieve company groups

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "company_groups": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "company_groups": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      

Create company group

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "alias": "",
  "createdAt": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "name": "",
  "company": "",
  "meta": {
    "company_roles": "",
    "applications": "",
    "contacts": "",
    "self": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "alias": {
      "type": "string"
    },
    "createdAt": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "name": {
      "type": "string"
    },
    "company": {
      "type": "string"
    },
    "meta": {
      "type": "object",
      "properties": {
        "company_roles": {
          "type": "string"
        },
        "applications": {
          "type": "string"
        },
        "contacts": {
          "type": "string"
        },
        "self": {
          "type": "string"
        }
      }
    }
  }
}
                      
Company Group
Return AppsCo Company contact.

Retrieve company group

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "alias": "",
  "createdAt": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "name": "",
  "company": "",
  "meta": {
    "company_roles": "",
    "applications": "",
    "contacts": "",
    "self": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "alias": {
      "type": "string"
    },
    "createdAt": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "name": {
      "type": "string"
    },
    "company": {
      "type": "string"
    },
    "meta": {
      "type": "object",
      "properties": {
        "company_roles": {
          "type": "string"
        },
        "applications": {
          "type": "string"
        },
        "contacts": {
          "type": "string"
        },
        "self": {
          "type": "string"
        }
      }
    }
  }
}
                      

Delete company group

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "alias": "",
  "createdAt": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "name": "",
  "company": "",
  "meta": {
    "company_roles": "",
    "applications": "",
    "contacts": "",
    "self": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "alias": {
      "type": "string"
    },
    "createdAt": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "name": {
      "type": "string"
    },
    "company": {
      "type": "string"
    },
    "meta": {
      "type": "object",
      "properties": {
        "company_roles": {
          "type": "string"
        },
        "applications": {
          "type": "string"
        },
        "contacts": {
          "type": "string"
        },
        "self": {
          "type": "string"
        }
      }
    }
  }
}
                      
Delete Company Group Role
Remove AppsCo Company group role for currently logged in user.

Delete company group role

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "account": {
    "id": 0,
    "uuid": "",
    "dashboard_roles": [],
    "email": "",
    "timezone": "",
    "country": "",
    "created_at": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "name": "",
    "enabled": false,
    "first_name": "",
    "last_name": "",
    "gender": "",
    "last_login": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "locale": "",
    "phone": "",
    "picture_url": "",
    "username": "",
    "roles": {
      "OWNER": "",
      "ADMIN": "",
      "SHARED": ""
    },
    "display_name": "",
    "native_company": "",
    "personal_dashboard_allowed": false,
    "user_allowed_to_create_company": false,
    "profile_options": {
      "public": false
    },
    "partner": false,
    "companies": {
      "company": [
        {
          "alias": 0,
          "name": "",
          "contact_email": "",
          "billing_email": "",
          "domain": "",
          "intranet_website": "",
          "remaining_trial_period": 0,
          "trial_period": 0,
          "image": "",
          "primary_color": "",
          "secondary_color": "",
          "self": "",
          "meta": {
            "applications": "",
            "settings": "",
            "logo": ""
          }
        }
      ],
      "icons": "",
      "company_admin": false
    },
    "org_units": {
      "name": "",
      "description": "",
      "alias": 0,
      "meta": {
        "remove": ""
      }
    },
    "meta": {
      "share": ""
    },
    "self": ""
  },
  "company": {
    "alias": 0,
    "name": "",
    "contact_email": "",
    "billing_email": "",
    "domain": "",
    "intranet_website": "",
    "remaining_trial_period": 0,
    "trial_period": 0,
    "image": "",
    "primary_color": "",
    "secondary_color": "",
    "self": "",
    "meta": {
      "applications": "",
      "settings": "",
      "logo": ""
    }
  },
  "roles": {
    "OWNER": "",
    "ADMIN": "",
    "SHARED": ""
  },
  "alias": 0,
  "security": {
    "application_score": 0,
    "two_factor": false
  },
  "group": [],
  "org_units": [
    {
      "name": "",
      "description": "",
      "alias": 0,
      "meta": {
        "remove": ""
      }
    }
  ],
  "self": "",
  "meta": {
    "log": "",
    "applications": "",
    "groups": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "account": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "uuid": {
          "type": "string"
        },
        "dashboard_roles": {},
        "email": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "created_at": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "name": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "first_name": {
          "type": "string"
        },
        "last_name": {
          "type": "string"
        },
        "gender": {
          "type": "string"
        },
        "last_login": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "locale": {
          "type": "string"
        },
        "phone": {
          "type": "string"
        },
        "picture_url": {
          "type": "string"
        },
        "username": {
          "type": "string"
        },
        "roles": {
          "type": "object",
          "properties": {
            "OWNER": {
              "type": "string"
            },
            "ADMIN": {
              "type": "string"
            },
            "SHARED": {
              "type": "string"
            }
          },
          "required": [
            "OWNER",
            "ADMIN",
            "SHARED"
          ],
          "additionalProperties": false
        },
        "display_name": {
          "type": "string"
        },
        "native_company": {
          "type": "string"
        },
        "personal_dashboard_allowed": {
          "type": "boolean"
        },
        "user_allowed_to_create_company": {
          "type": "boolean"
        },
        "profile_options": {
          "type": "object",
          "properties": {
            "public": {
              "type": "boolean"
            }
          }
        },
        "partner": {
          "type": "boolean"
        },
        "companies": {
          "type": "object",
          "properties": {
            "company": {
              "type": "array"
            },
            "icons": {
              "type": "string"
            },
            "company_admin": {
              "type": "boolean"
            }
          }
        },
        "org_units": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "Name of org units"
            },
            "description": {
              "type": "string",
              "description": "Description of urg unit"
            },
            "alias": {
              "type": "number",
              "description": "Alias"
            },
            "meta": {
              "type": "object",
              "properties": {
                "remove": {
                  "type": "string",
                  "description": "Remove url"
                }
              }
            }
          }
        },
        "meta": {
          "type": "object",
          "properties": {
            "share": {
              "type": "string"
            }
          }
        },
        "self": {
          "type": "string"
        }
      }
    },
    "company": {
      "type": "object",
      "properties": {
        "alias": {
          "type": "number"
        },
        "name": {
          "type": "string",
          "description": "Name of company"
        },
        "contact_email": {
          "type": "string",
          "description": "Contact email"
        },
        "billing_email": {
          "type": "string",
          "description": "Billing email"
        },
        "domain": {
          "type": "string",
          "description": "Domain of company"
        },
        "intranet_website": {
          "type": "string",
          "description": "Intranet website of company"
        },
        "remaining_trial_period": {
          "type": "number",
          "description": "Remaining trial period"
        },
        "trial_period": {
          "type": "number",
          "description": "Trial period"
        },
        "image": {
          "type": "string",
          "description": "Image route"
        },
        "primary_color": {
          "type": "string"
        },
        "secondary_color": {
          "type": "string"
        },
        "self": {
          "type": "string",
          "description": "Company route"
        },
        "meta": {
          "type": "object",
          "properties": {
            "applications": {
              "type": "string",
              "description": "Company applications route"
            },
            "settings": {
              "type": "string",
              "description": "Company settings route"
            },
            "logo": {
              "type": "string",
              "description": "Company logo route"
            }
          }
        }
      }
    },
    "roles": {
      "type": "object",
      "properties": {
        "OWNER": {
          "type": "string"
        },
        "ADMIN": {
          "type": "string"
        },
        "SHARED": {
          "type": "string"
        }
      },
      "required": [
        "OWNER",
        "ADMIN",
        "SHARED"
      ],
      "additionalProperties": false
    },
    "alias": {
      "type": "number"
    },
    "security": {
      "type": "object",
      "properties": {
        "application_score": {
          "type": "number"
        },
        "two_factor": {
          "type": "boolean"
        }
      }
    },
    "group": {
      "type": "array"
    },
    "org_units": {
      "type": "array"
    },
    "self": {
      "type": "string"
    },
    "meta": {
      "type": "object",
      "properties": {
        "log": {
          "type": "string"
        },
        "applications": {
          "type": "string"
        },
        "groups": {
          "type": "string"
        }
      }
    }
  }
}
                      
Company Groups Role
Return AppsCo Company group roles for currently logged in user.

Retrieve company groups roles

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "company_roles": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "company_roles": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
Company Groups Contacts
Return AppsCo Company groups contacts for currently logged in user.

Retrieve company groups contacts

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "contacts": []
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "contacts": {
      "type": "array"
    }
  }
}
                      
Company Contact
Return AppsCo Company contact.

Retrieve company contact

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "alias": "",
  "company": "",
  "account": {
    "id": 0,
    "dashboard_roles": [],
    "email": "",
    "timezone": "",
    "country": "",
    "created_at": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "name": "",
    "enabled": false,
    "first_name": "",
    "last_name": "",
    "gender": "",
    "last_login": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "locale": "",
    "phone": "",
    "picture_url": "",
    "username": "",
    "roles": {
      "OWNER": "",
      "ADMIN": "",
      "SHARED": ""
    },
    "display_name": "",
    "profile_options": {
      "public": false
    },
    "partner": false,
    "companies": {
      "company": [
        {
          "alias": 0,
          "name": "",
          "contact_email": "",
          "billing_email": "",
          "domain": "",
          "intranet_website": "",
          "remaining_trial_period": 0,
          "trial_period": 0,
          "image": "",
          "primary_color": "",
          "secondary_color": "",
          "self": "",
          "meta": {
            "applications": "",
            "settings": "",
            "logo": ""
          }
        }
      ],
      "icons": "",
      "company_admin": false
    },
    "org_units": [
      {
        "name": "",
        "description": "",
        "alias": 0,
        "meta": {
          "remove": ""
        }
      }
    ],
    "meta": {
      "share": ""
    },
    "self": ""
  },
  "first_name": "",
  "last_name": "",
  "display_name": "",
  "email": "",
  "createdAt": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "self": "",
  "meta": {
    "promote_to_user": "",
    "applications": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "alias": {
      "type": "string"
    },
    "company": {
      "type": "string",
      "description": "Company url"
    },
    "account": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "dashboard_roles": {},
        "email": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "created_at": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "name": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "first_name": {
          "type": "string"
        },
        "last_name": {
          "type": "string"
        },
        "gender": {
          "type": "string"
        },
        "last_login": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "locale": {
          "type": "string"
        },
        "phone": {
          "type": "string"
        },
        "picture_url": {
          "type": "string"
        },
        "username": {
          "type": "string"
        },
        "roles": {
          "type": "object",
          "properties": {
            "OWNER": {
              "type": "string"
            },
            "ADMIN": {
              "type": "string"
            },
            "SHARED": {
              "type": "string"
            }
          },
          "required": [
            "OWNER",
            "ADMIN",
            "SHARED"
          ],
          "additionalProperties": false
        },
        "display_name": {
          "type": "string"
        },
        "profile_options": {
          "type": "object",
          "properties": {
            "public": {
              "type": "boolean"
            }
          }
        },
        "partner": {
          "type": "boolean"
        },
        "companies": {
          "type": "object",
          "properties": {
            "company": {
              "type": "array"
            },
            "icons": {
              "type": "string"
            },
            "company_admin": {
              "type": "boolean"
            }
          }
        },
        "org_units": {
          "type": "array"
        },
        "meta": {
          "type": "object",
          "properties": {
            "share": {
              "type": "string"
            }
          }
        },
        "self": {
          "type": "string"
        }
      }
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "display_name": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "createdAt": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "self": {
      "type": "string"
    },
    "meta": {
      "type": "object",
      "properties": {
        "promote_to_user": {
          "type": "string"
        },
        "applications": {
          "type": "string"
        }
      }
    }
  }
}
                      

Delete company contact

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "alias": "",
  "company": "",
  "account": {
    "id": 0,
    "dashboard_roles": [],
    "email": "",
    "timezone": "",
    "country": "",
    "created_at": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "name": "",
    "enabled": false,
    "first_name": "",
    "last_name": "",
    "gender": "",
    "last_login": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "locale": "",
    "phone": "",
    "picture_url": "",
    "username": "",
    "roles": {
      "OWNER": "",
      "ADMIN": "",
      "SHARED": ""
    },
    "display_name": "",
    "profile_options": {
      "public": false
    },
    "partner": false,
    "companies": {
      "company": [
        {
          "alias": 0,
          "name": "",
          "contact_email": "",
          "billing_email": "",
          "domain": "",
          "intranet_website": "",
          "remaining_trial_period": 0,
          "trial_period": 0,
          "image": "",
          "primary_color": "",
          "secondary_color": "",
          "self": "",
          "meta": {
            "applications": "",
            "settings": "",
            "logo": ""
          }
        }
      ],
      "icons": "",
      "company_admin": false
    },
    "org_units": [
      {
        "name": "",
        "description": "",
        "alias": 0,
        "meta": {
          "remove": ""
        }
      }
    ],
    "meta": {
      "share": ""
    },
    "self": ""
  },
  "first_name": "",
  "last_name": "",
  "display_name": "",
  "email": "",
  "createdAt": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "self": "",
  "meta": {
    "promote_to_user": "",
    "applications": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "alias": {
      "type": "string"
    },
    "company": {
      "type": "string",
      "description": "Company url"
    },
    "account": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "dashboard_roles": {},
        "email": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "created_at": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "name": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "first_name": {
          "type": "string"
        },
        "last_name": {
          "type": "string"
        },
        "gender": {
          "type": "string"
        },
        "last_login": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "locale": {
          "type": "string"
        },
        "phone": {
          "type": "string"
        },
        "picture_url": {
          "type": "string"
        },
        "username": {
          "type": "string"
        },
        "roles": {
          "type": "object",
          "properties": {
            "OWNER": {
              "type": "string"
            },
            "ADMIN": {
              "type": "string"
            },
            "SHARED": {
              "type": "string"
            }
          },
          "required": [
            "OWNER",
            "ADMIN",
            "SHARED"
          ],
          "additionalProperties": false
        },
        "display_name": {
          "type": "string"
        },
        "profile_options": {
          "type": "object",
          "properties": {
            "public": {
              "type": "boolean"
            }
          }
        },
        "partner": {
          "type": "boolean"
        },
        "companies": {
          "type": "object",
          "properties": {
            "company": {
              "type": "array"
            },
            "icons": {
              "type": "string"
            },
            "company_admin": {
              "type": "boolean"
            }
          }
        },
        "org_units": {
          "type": "array"
        },
        "meta": {
          "type": "object",
          "properties": {
            "share": {
              "type": "string"
            }
          }
        },
        "self": {
          "type": "string"
        }
      }
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "display_name": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "createdAt": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "self": {
      "type": "string"
    },
    "meta": {
      "type": "object",
      "properties": {
        "promote_to_user": {
          "type": "string"
        },
        "applications": {
          "type": "string"
        }
      }
    }
  }
}
                      
Company Groups Applications
Remove AppsCo Company groups application for currently logged in user.

Delete company groups applications

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "application_template": {
    "title": "",
    "supported_auth_types": [
      "unpw",
      "none",
      "item"
    ],
    "icon_url": "",
    "url": "",
    "url_editable": false,
    "self": ""
  },
  "title": "",
  "alias": 0,
  "claim_type": "",
  "auth_type": "",
  "url_editable": false,
  "url": "",
  "images": [],
  "added_by": {
    "id": 0,
    "uuid": "",
    "dashboard_roles": [],
    "email": "",
    "timezone": "",
    "country": "",
    "created_at": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "name": "",
    "enabled": false,
    "first_name": "",
    "last_name": "",
    "gender": "",
    "last_login": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "locale": "",
    "phone": "",
    "picture_url": "",
    "username": "",
    "roles": {
      "OWNER": "",
      "ADMIN": "",
      "SHARED": ""
    },
    "display_name": "",
    "profile_options": {
      "public": false
    },
    "partner": false,
    "companies": {
      "company": [
        {
          "alias": 0,
          "name": "",
          "contact_email": "",
          "billing_email": "",
          "domain": "",
          "intranet_website": "",
          "remaining_trial_period": 0,
          "trial_period": 0,
          "image": "",
          "primary_color": "",
          "secondary_color": "",
          "self": "",
          "meta": {
            "applications": "",
            "settings": "",
            "logo": ""
          }
        }
      ],
      "icons": "",
      "company_admin": false
    },
    "meta": {
      "share": "",
      "self": ""
    }
  },
  "security": {
    "info": {
      "not_configured": 0,
      "configured": 0,
      "lowest_score": 0
    },
    "score": 0
  },
  "last_login": "",
  "claims": [
    "username",
    "password"
  ],
  "org_units": [
    {
      "name": "",
      "description": "",
      "alias": 0,
      "meta": {
        "remove": ""
      }
    }
  ],
  "last_modified": {
    "account": "",
    "date": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    }
  },
  "daily_usage": 0,
  "application_url": "",
  "company": "",
  "meta": {
    "log": "",
    "subscribers": "",
    "update_claims": "",
    "update": "",
    "account_claims": "",
    "account_icon": ""
  },
  "self": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "application_template": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string",
          "description": "Title of application"
        },
        "supported_auth_types": {
          "type": "array"
        },
        "icon_url": {
          "type": "string",
          "description": "Icon url"
        },
        "url": {
          "type": "string",
          "description": "Application  url"
        },
        "url_editable": {
          "type": "boolean"
        },
        "self": {
          "type": "string",
          "description": "Application route"
        }
      },
      "description": "Application template"
    },
    "title": {
      "type": "string",
      "description": "Title of application"
    },
    "alias": {
      "type": "number"
    },
    "claim_type": {
      "type": "string",
      "description": "Claim type"
    },
    "auth_type": {
      "type": "string",
      "description": "Auth type"
    },
    "url_editable": {
      "type": "boolean",
      "description": "Url editable"
    },
    "url": {
      "type": "string",
      "description": "Url route"
    },
    "images": {
      "type": "array",
      "description": "Images"
    },
    "added_by": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "uuid": {
          "type": "string"
        },
        "dashboard_roles": {},
        "email": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "created_at": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "name": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "first_name": {
          "type": "string"
        },
        "last_name": {
          "type": "string"
        },
        "gender": {
          "type": "string"
        },
        "last_login": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "locale": {
          "type": "string"
        },
        "phone": {
          "type": "string"
        },
        "picture_url": {
          "type": "string"
        },
        "username": {
          "type": "string"
        },
        "roles": {
          "type": "object",
          "properties": {
            "OWNER": {
              "type": "string"
            },
            "ADMIN": {
              "type": "string"
            },
            "SHARED": {
              "type": "string"
            }
          },
          "required": [
            "OWNER",
            "ADMIN",
            "SHARED"
          ],
          "additionalProperties": false
        },
        "display_name": {
          "type": "string"
        },
        "profile_options": {
          "type": "object",
          "properties": {
            "public": {
              "type": "boolean"
            }
          }
        },
        "partner": {
          "type": "boolean"
        },
        "companies": {
          "type": "object",
          "properties": {
            "company": {
              "type": "array"
            },
            "icons": {
              "type": "string"
            },
            "company_admin": {
              "type": "boolean"
            }
          }
        },
        "meta": {
          "type": "object",
          "properties": {
            "share": {
              "type": "string"
            },
            "self": {
              "type": "string"
            }
          }
        }
      }
    },
    "security": {
      "type": "object",
      "properties": {
        "info": {
          "type": "object",
          "properties": {
            "not_configured": {
              "type": "number"
            },
            "configured": {
              "type": "number"
            },
            "lowest_score": {
              "type": "number"
            }
          }
        },
        "score": {
          "type": "number"
        }
      }
    },
    "last_login": {
      "type": "string",
      "description": "Who was last logged in"
    },
    "claims": {
      "type": "array"
    },
    "org_units": {
      "type": "array"
    },
    "last_modified": {
      "type": "object",
      "properties": {
        "account": {
          "type": "string",
          "description": "Name of account user"
        },
        "date": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        }
      }
    },
    "daily_usage": {
      "type": "number"
    },
    "application_url": {
      "type": "string"
    },
    "company": {
      "type": "string"
    },
    "meta": {
      "type": "object",
      "properties": {
        "log": {
          "type": "string",
          "description": "Application log route"
        },
        "subscribers": {
          "type": "string",
          "description": "Application subscribers route"
        },
        "update_claims": {
          "type": "string",
          "description": "Application claims route"
        },
        "update": {
          "type": "string",
          "description": "Update"
        },
        "account_claims": {
          "type": "string",
          "description": "Application account claims route"
        },
        "account_icon": {
          "type": "string"
        }
      }
    },
    "self": {
      "type": "string"
    }
  }
}
                      
Company Groups Applications
Remove AppsCo Company groups application for currently logged in user.

Delete company groups applications

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "application_template": {
    "title": "",
    "supported_auth_types": [
      "unpw",
      "none",
      "item"
    ],
    "icon_url": "",
    "url": "",
    "url_editable": false,
    "self": ""
  },
  "title": "",
  "alias": 0,
  "claim_type": "",
  "auth_type": "",
  "url_editable": false,
  "url": "",
  "images": [],
  "added_by": {
    "id": 0,
    "uuid": "",
    "dashboard_roles": [],
    "email": "",
    "timezone": "",
    "country": "",
    "created_at": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "name": "",
    "enabled": false,
    "first_name": "",
    "last_name": "",
    "gender": "",
    "last_login": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    },
    "locale": "",
    "phone": "",
    "picture_url": "",
    "username": "",
    "roles": {
      "OWNER": "",
      "ADMIN": "",
      "SHARED": ""
    },
    "display_name": "",
    "profile_options": {
      "public": false
    },
    "partner": false,
    "companies": {
      "company": [
        {
          "alias": 0,
          "name": "",
          "contact_email": "",
          "billing_email": "",
          "domain": "",
          "intranet_website": "",
          "remaining_trial_period": 0,
          "trial_period": 0,
          "image": "",
          "primary_color": "",
          "secondary_color": "",
          "self": "",
          "meta": {
            "applications": "",
            "settings": "",
            "logo": ""
          }
        }
      ],
      "icons": "",
      "company_admin": false
    },
    "meta": {
      "share": "",
      "self": ""
    }
  },
  "security": {
    "info": {
      "not_configured": 0,
      "configured": 0,
      "lowest_score": 0
    },
    "score": 0
  },
  "last_login": "",
  "claims": [
    "username",
    "password"
  ],
  "org_units": [
    {
      "name": "",
      "description": "",
      "alias": 0,
      "meta": {
        "remove": ""
      }
    }
  ],
  "last_modified": {
    "account": "",
    "date": {
      "date": "",
      "timezone_type": 0,
      "timezone": ""
    }
  },
  "daily_usage": 0,
  "application_url": "",
  "company": "",
  "meta": {
    "log": "",
    "subscribers": "",
    "update_claims": "",
    "update": "",
    "account_claims": "",
    "account_icon": ""
  },
  "self": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "application_template": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string",
          "description": "Title of application"
        },
        "supported_auth_types": {
          "type": "array"
        },
        "icon_url": {
          "type": "string",
          "description": "Icon url"
        },
        "url": {
          "type": "string",
          "description": "Application  url"
        },
        "url_editable": {
          "type": "boolean"
        },
        "self": {
          "type": "string",
          "description": "Application route"
        }
      },
      "description": "Application template"
    },
    "title": {
      "type": "string",
      "description": "Title of application"
    },
    "alias": {
      "type": "number"
    },
    "claim_type": {
      "type": "string",
      "description": "Claim type"
    },
    "auth_type": {
      "type": "string",
      "description": "Auth type"
    },
    "url_editable": {
      "type": "boolean",
      "description": "Url editable"
    },
    "url": {
      "type": "string",
      "description": "Url route"
    },
    "images": {
      "type": "array",
      "description": "Images"
    },
    "added_by": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "uuid": {
          "type": "string"
        },
        "dashboard_roles": {},
        "email": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "created_at": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "name": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "first_name": {
          "type": "string"
        },
        "last_name": {
          "type": "string"
        },
        "gender": {
          "type": "string"
        },
        "last_login": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        },
        "locale": {
          "type": "string"
        },
        "phone": {
          "type": "string"
        },
        "picture_url": {
          "type": "string"
        },
        "username": {
          "type": "string"
        },
        "roles": {
          "type": "object",
          "properties": {
            "OWNER": {
              "type": "string"
            },
            "ADMIN": {
              "type": "string"
            },
            "SHARED": {
              "type": "string"
            }
          },
          "required": [
            "OWNER",
            "ADMIN",
            "SHARED"
          ],
          "additionalProperties": false
        },
        "display_name": {
          "type": "string"
        },
        "profile_options": {
          "type": "object",
          "properties": {
            "public": {
              "type": "boolean"
            }
          }
        },
        "partner": {
          "type": "boolean"
        },
        "companies": {
          "type": "object",
          "properties": {
            "company": {
              "type": "array"
            },
            "icons": {
              "type": "string"
            },
            "company_admin": {
              "type": "boolean"
            }
          }
        },
        "meta": {
          "type": "object",
          "properties": {
            "share": {
              "type": "string"
            },
            "self": {
              "type": "string"
            }
          }
        }
      }
    },
    "security": {
      "type": "object",
      "properties": {
        "info": {
          "type": "object",
          "properties": {
            "not_configured": {
              "type": "number"
            },
            "configured": {
              "type": "number"
            },
            "lowest_score": {
              "type": "number"
            }
          }
        },
        "score": {
          "type": "number"
        }
      }
    },
    "last_login": {
      "type": "string",
      "description": "Who was last logged in"
    },
    "claims": {
      "type": "array"
    },
    "org_units": {
      "type": "array"
    },
    "last_modified": {
      "type": "object",
      "properties": {
        "account": {
          "type": "string",
          "description": "Name of account user"
        },
        "date": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "description": "Date time in iso"
            },
            "timezone_type": {
              "type": "number"
            },
            "timezone": {
              "type": "string"
            }
          }
        }
      }
    },
    "daily_usage": {
      "type": "number"
    },
    "application_url": {
      "type": "string"
    },
    "company": {
      "type": "string"
    },
    "meta": {
      "type": "object",
      "properties": {
        "log": {
          "type": "string",
          "description": "Application log route"
        },
        "subscribers": {
          "type": "string",
          "description": "Application subscribers route"
        },
        "update_claims": {
          "type": "string",
          "description": "Application claims route"
        },
        "update": {
          "type": "string",
          "description": "Update"
        },
        "account_claims": {
          "type": "string",
          "description": "Application account claims route"
        },
        "account_icon": {
          "type": "string"
        }
      }
    },
    "self": {
      "type": "string"
    }
  }
}
                      
Company Contact Groups
Return AppsCo Company contact groups for currently logged in user.

Retrieve company contact groups

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "company_groups": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "company_groups": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
Company Roles Groups
Return AppsCo Company roles groups for currently logged in user.

Retrieve company roles groups

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "company_groups": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "company_groups": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
Company Applications Groups
Return AppsCo Company application groups for currently logged in user.

Retrieve company application groups

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "company_groups": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "company_groups": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
Company Oauth Applications
Return AppsCo Company oauth applications.

Retrieve company oauth applications

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "applications": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "applications": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      

Add company oauth application

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "alias": 0,
  "owner": {
    "alias": 0,
    "name": "",
    "contact_email": "",
    "billing_email": "",
    "domain": "",
    "intranet_website": "",
    "remaining_trial_period": 0,
    "trial_period": false,
    "primary_color": "",
    "secondary_color": "",
    "personal_dashboards_allowed": false,
    "user_allowed_to_create_company": false,
    "company_uuid": "",
    "is_partner": false,
    "enforced_2fa": false,
    "ip_whitelist": "",
    "block_tor": false,
    "subscription_paid_externally": false,
    "image": "",
    "self": "",
    "meta": {
      "applications": "",
      "settings": "",
      "logo": "",
      "domains": ""
    }
  },
  "status": false,
  "title": "",
  "website_url": "",
  "redirect_url": "",
  "icon_url": "",
  "decsription": "",
  "client_id": "",
  "client_secret": "",
  "meta": {
    "remove": ""
  },
  "self": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "alias": {
      "type": "number"
    },
    "owner": {
      "type": "object",
      "properties": {
        "alias": {
          "type": "number"
        },
        "name": {
          "type": "string"
        },
        "contact_email": {
          "type": "string"
        },
        "billing_email": {
          "type": "string"
        },
        "domain": {
          "type": "string"
        },
        "intranet_website": {
          "type": "string"
        },
        "remaining_trial_period": {
          "type": "number"
        },
        "trial_period": {
          "type": "boolean"
        },
        "primary_color": {
          "type": "string"
        },
        "secondary_color": {
          "type": "string"
        },
        "personal_dashboards_allowed": {
          "type": "boolean"
        },
        "user_allowed_to_create_company": {
          "type": "boolean"
        },
        "company_uuid": {
          "type": "string"
        },
        "is_partner": {
          "type": "boolean"
        },
        "enforced_2fa": {
          "type": "boolean"
        },
        "ip_whitelist": {
          "type": "string"
        },
        "block_tor": {
          "type": "boolean"
        },
        "subscription_paid_externally": {
          "type": "boolean"
        },
        "image": {
          "type": "string"
        },
        "self": {
          "type": "string"
        },
        "meta": {
          "type": "object",
          "properties": {
            "applications": {
              "type": "string"
            },
            "settings": {
              "type": "string"
            },
            "logo": {
              "type": "string"
            },
            "domains": {
              "type": "string"
            }
          }
        }
      }
    },
    "status": {
      "type": "boolean"
    },
    "title": {
      "type": "string"
    },
    "website_url": {
      "type": "string"
    },
    "redirect_url": {
      "type": "string"
    },
    "icon_url": {
      "type": "string"
    },
    "decsription": {
      "type": "string"
    },
    "client_id": {
      "type": "string"
    },
    "client_secret": {
      "type": "string"
    },
    "meta": {
      "type": "object",
      "properties": {
        "remove": {
          "type": "string"
        }
      }
    },
    "self": {
      "type": "string"
    }
  }
}
                      
Company Oauth Authorizations Count
Retrieve AppsCo Company oauth authorizations count.

Retrieve company oauth authorizations count

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "authorizations_count": 0
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "authorizations_count": {
      "type": "number"
    }
  }
}
                      
Single Oauth Application
Return AppsCo single company oauth applications.

Retrieve oauth application

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "alias": 0,
  "owner": {
    "alias": 0,
    "name": "",
    "contact_email": "",
    "billing_email": "",
    "domain": "",
    "intranet_website": "",
    "remaining_trial_period": 0,
    "trial_period": false,
    "primary_color": "",
    "secondary_color": "",
    "personal_dashboards_allowed": false,
    "user_allowed_to_create_company": false,
    "company_uuid": "",
    "is_partner": false,
    "enforced_2fa": false,
    "ip_whitelist": "",
    "block_tor": false,
    "subscription_paid_externally": false,
    "image": "",
    "self": "",
    "meta": {
      "applications": "",
      "settings": "",
      "logo": "",
      "domains": ""
    }
  },
  "status": false,
  "title": "",
  "website_url": "",
  "redirect_url": "",
  "icon_url": "",
  "decsription": "",
  "client_id": "",
  "client_secret": "",
  "meta": {
    "remove": ""
  },
  "self": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "alias": {
      "type": "number"
    },
    "owner": {
      "type": "object",
      "properties": {
        "alias": {
          "type": "number"
        },
        "name": {
          "type": "string"
        },
        "contact_email": {
          "type": "string"
        },
        "billing_email": {
          "type": "string"
        },
        "domain": {
          "type": "string"
        },
        "intranet_website": {
          "type": "string"
        },
        "remaining_trial_period": {
          "type": "number"
        },
        "trial_period": {
          "type": "boolean"
        },
        "primary_color": {
          "type": "string"
        },
        "secondary_color": {
          "type": "string"
        },
        "personal_dashboards_allowed": {
          "type": "boolean"
        },
        "user_allowed_to_create_company": {
          "type": "boolean"
        },
        "company_uuid": {
          "type": "string"
        },
        "is_partner": {
          "type": "boolean"
        },
        "enforced_2fa": {
          "type": "boolean"
        },
        "ip_whitelist": {
          "type": "string"
        },
        "block_tor": {
          "type": "boolean"
        },
        "subscription_paid_externally": {
          "type": "boolean"
        },
        "image": {
          "type": "string"
        },
        "self": {
          "type": "string"
        },
        "meta": {
          "type": "object",
          "properties": {
            "applications": {
              "type": "string"
            },
            "settings": {
              "type": "string"
            },
            "logo": {
              "type": "string"
            },
            "domains": {
              "type": "string"
            }
          }
        }
      }
    },
    "status": {
      "type": "boolean"
    },
    "title": {
      "type": "string"
    },
    "website_url": {
      "type": "string"
    },
    "redirect_url": {
      "type": "string"
    },
    "icon_url": {
      "type": "string"
    },
    "decsription": {
      "type": "string"
    },
    "client_id": {
      "type": "string"
    },
    "client_secret": {
      "type": "string"
    },
    "meta": {
      "type": "object",
      "properties": {
        "remove": {
          "type": "string"
        }
      }
    },
    "self": {
      "type": "string"
    }
  }
}
                      

Remove oauth application

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "alias": 0,
  "owner": {
    "alias": 0,
    "name": "",
    "contact_email": "",
    "billing_email": "",
    "domain": "",
    "intranet_website": "",
    "remaining_trial_period": 0,
    "trial_period": false,
    "primary_color": "",
    "secondary_color": "",
    "personal_dashboards_allowed": false,
    "user_allowed_to_create_company": false,
    "company_uuid": "",
    "is_partner": false,
    "enforced_2fa": false,
    "ip_whitelist": "",
    "block_tor": false,
    "subscription_paid_externally": false,
    "image": "",
    "self": "",
    "meta": {
      "applications": "",
      "settings": "",
      "logo": "",
      "domains": ""
    }
  },
  "status": false,
  "title": "",
  "website_url": "",
  "redirect_url": "",
  "icon_url": "",
  "decsription": "",
  "client_id": "",
  "client_secret": "",
  "meta": {
    "remove": ""
  },
  "self": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "alias": {
      "type": "number"
    },
    "owner": {
      "type": "object",
      "properties": {
        "alias": {
          "type": "number"
        },
        "name": {
          "type": "string"
        },
        "contact_email": {
          "type": "string"
        },
        "billing_email": {
          "type": "string"
        },
        "domain": {
          "type": "string"
        },
        "intranet_website": {
          "type": "string"
        },
        "remaining_trial_period": {
          "type": "number"
        },
        "trial_period": {
          "type": "boolean"
        },
        "primary_color": {
          "type": "string"
        },
        "secondary_color": {
          "type": "string"
        },
        "personal_dashboards_allowed": {
          "type": "boolean"
        },
        "user_allowed_to_create_company": {
          "type": "boolean"
        },
        "company_uuid": {
          "type": "string"
        },
        "is_partner": {
          "type": "boolean"
        },
        "enforced_2fa": {
          "type": "boolean"
        },
        "ip_whitelist": {
          "type": "string"
        },
        "block_tor": {
          "type": "boolean"
        },
        "subscription_paid_externally": {
          "type": "boolean"
        },
        "image": {
          "type": "string"
        },
        "self": {
          "type": "string"
        },
        "meta": {
          "type": "object",
          "properties": {
            "applications": {
              "type": "string"
            },
            "settings": {
              "type": "string"
            },
            "logo": {
              "type": "string"
            },
            "domains": {
              "type": "string"
            }
          }
        }
      }
    },
    "status": {
      "type": "boolean"
    },
    "title": {
      "type": "string"
    },
    "website_url": {
      "type": "string"
    },
    "redirect_url": {
      "type": "string"
    },
    "icon_url": {
      "type": "string"
    },
    "decsription": {
      "type": "string"
    },
    "client_id": {
      "type": "string"
    },
    "client_secret": {
      "type": "string"
    },
    "meta": {
      "type": "object",
      "properties": {
        "remove": {
          "type": "string"
        }
      }
    },
    "self": {
      "type": "string"
    }
  }
}
                      

Update company oauth application

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "alias": 0,
  "owner": {
    "alias": 0,
    "name": "",
    "contact_email": "",
    "billing_email": "",
    "domain": "",
    "intranet_website": "",
    "remaining_trial_period": 0,
    "trial_period": false,
    "primary_color": "",
    "secondary_color": "",
    "personal_dashboards_allowed": false,
    "user_allowed_to_create_company": false,
    "company_uuid": "",
    "is_partner": false,
    "enforced_2fa": false,
    "ip_whitelist": "",
    "block_tor": false,
    "subscription_paid_externally": false,
    "image": "",
    "self": "",
    "meta": {
      "applications": "",
      "settings": "",
      "logo": "",
      "domains": ""
    }
  },
  "status": false,
  "title": "",
  "website_url": "",
  "redirect_url": "",
  "icon_url": "",
  "decsription": "",
  "client_id": "",
  "client_secret": "",
  "meta": {
    "remove": ""
  },
  "self": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "alias": {
      "type": "number"
    },
    "owner": {
      "type": "object",
      "properties": {
        "alias": {
          "type": "number"
        },
        "name": {
          "type": "string"
        },
        "contact_email": {
          "type": "string"
        },
        "billing_email": {
          "type": "string"
        },
        "domain": {
          "type": "string"
        },
        "intranet_website": {
          "type": "string"
        },
        "remaining_trial_period": {
          "type": "number"
        },
        "trial_period": {
          "type": "boolean"
        },
        "primary_color": {
          "type": "string"
        },
        "secondary_color": {
          "type": "string"
        },
        "personal_dashboards_allowed": {
          "type": "boolean"
        },
        "user_allowed_to_create_company": {
          "type": "boolean"
        },
        "company_uuid": {
          "type": "string"
        },
        "is_partner": {
          "type": "boolean"
        },
        "enforced_2fa": {
          "type": "boolean"
        },
        "ip_whitelist": {
          "type": "string"
        },
        "block_tor": {
          "type": "boolean"
        },
        "subscription_paid_externally": {
          "type": "boolean"
        },
        "image": {
          "type": "string"
        },
        "self": {
          "type": "string"
        },
        "meta": {
          "type": "object",
          "properties": {
            "applications": {
              "type": "string"
            },
            "settings": {
              "type": "string"
            },
            "logo": {
              "type": "string"
            },
            "domains": {
              "type": "string"
            }
          }
        }
      }
    },
    "status": {
      "type": "boolean"
    },
    "title": {
      "type": "string"
    },
    "website_url": {
      "type": "string"
    },
    "redirect_url": {
      "type": "string"
    },
    "icon_url": {
      "type": "string"
    },
    "decsription": {
      "type": "string"
    },
    "client_id": {
      "type": "string"
    },
    "client_secret": {
      "type": "string"
    },
    "meta": {
      "type": "object",
      "properties": {
        "remove": {
          "type": "string"
        }
      }
    },
    "self": {
      "type": "string"
    }
  }
}
                      
Oauth Application Certificate
Retrieve AppsCo Company oauth application certificate.

Add oauth application certificate

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "alias": 0,
  "valid_from": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "valid_to": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "fingerprint": "",
  "certificate": "",
  "o_auth_application": {
    "alias": 0,
    "owner": {
      "alias": 0,
      "name": "",
      "contact_email": "",
      "billing_email": "",
      "domain": "",
      "intranet_website": "",
      "remaining_trial_period": 0,
      "trial_period": false,
      "primary_color": "",
      "secondary_color": "",
      "personal_dashboards_allowed": false,
      "user_allowed_to_create_company": false,
      "company_uuid": "",
      "is_partner": false,
      "enforced_2fa": false,
      "ip_whitelist": "",
      "block_tor": false,
      "subscription_paid_externally": false,
      "image": "",
      "self": "",
      "meta": {
        "applications": "",
        "settings": "",
        "logo": "",
        "domains": ""
      }
    },
    "status": false,
    "title": "",
    "website_url": "",
    "redirect_url": "",
    "icon_url": "",
    "decsription": "",
    "client_id": "",
    "client_secret": "",
    "meta": {
      "remove": ""
    },
    "self": ""
  },
  "self": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "alias": {
      "type": "number"
    },
    "valid_from": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "valid_to": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "fingerprint": {
      "type": "string"
    },
    "certificate": {
      "type": "string"
    },
    "o_auth_application": {
      "type": "object",
      "properties": {
        "alias": {
          "type": "number"
        },
        "owner": {
          "type": "object",
          "properties": {
            "alias": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "contact_email": {
              "type": "string"
            },
            "billing_email": {
              "type": "string"
            },
            "domain": {
              "type": "string"
            },
            "intranet_website": {
              "type": "string"
            },
            "remaining_trial_period": {
              "type": "number"
            },
            "trial_period": {
              "type": "boolean"
            },
            "primary_color": {
              "type": "string"
            },
            "secondary_color": {
              "type": "string"
            },
            "personal_dashboards_allowed": {
              "type": "boolean"
            },
            "user_allowed_to_create_company": {
              "type": "boolean"
            },
            "company_uuid": {
              "type": "string"
            },
            "is_partner": {
              "type": "boolean"
            },
            "enforced_2fa": {
              "type": "boolean"
            },
            "ip_whitelist": {
              "type": "string"
            },
            "block_tor": {
              "type": "boolean"
            },
            "subscription_paid_externally": {
              "type": "boolean"
            },
            "image": {
              "type": "string"
            },
            "self": {
              "type": "string"
            },
            "meta": {
              "type": "object",
              "properties": {
                "applications": {
                  "type": "string"
                },
                "settings": {
                  "type": "string"
                },
                "logo": {
                  "type": "string"
                },
                "domains": {
                  "type": "string"
                }
              }
            }
          }
        },
        "status": {
          "type": "boolean"
        },
        "title": {
          "type": "string"
        },
        "website_url": {
          "type": "string"
        },
        "redirect_url": {
          "type": "string"
        },
        "icon_url": {
          "type": "string"
        },
        "decsription": {
          "type": "string"
        },
        "client_id": {
          "type": "string"
        },
        "client_secret": {
          "type": "string"
        },
        "meta": {
          "type": "object",
          "properties": {
            "remove": {
              "type": "string"
            }
          }
        },
        "self": {
          "type": "string"
        }
      }
    },
    "self": {
      "type": "string"
    }
  }
}
                      

Retrieve oauth application certificate

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "certificates": [],
  "meta": {
    "total": 0,
    "page": 0,
    "first": "",
    "last": "",
    "pages": 0,
    "per_page": 0,
    "prev": "",
    "next": ""
  }
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "certificates": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number",
          "description": "Total number of items"
        },
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "first": {
          "type": "string",
          "description": "First page in collection"
        },
        "last": {
          "type": "string",
          "description": "Last page in collection"
        },
        "pages": {
          "type": "number",
          "description": "Number of pages"
        },
        "per_page": {
          "type": "number",
          "description": "Number of items per page"
        },
        "prev": {
          "type": "string",
          "description": "Previous page"
        },
        "next": {
          "type": "string",
          "description": "Next page"
        }
      }
    }
  }
}
                      
Remove Oauth Application Certificate
Remove AppsCo Company oauth application certificate.

Remove oauth application certificate

REQUEST

Headers
Authorization token absdef12345

RESPONSE

Headers
Content-Type application/json
200 application/json
                        {
  "alias": 0,
  "valid_from": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "valid_to": {
    "date": "",
    "timezone_type": 0,
    "timezone": ""
  },
  "fingerprint": "",
  "certificate": "",
  "o_auth_application": {
    "alias": 0,
    "owner": {
      "alias": 0,
      "name": "",
      "contact_email": "",
      "billing_email": "",
      "domain": "",
      "intranet_website": "",
      "remaining_trial_period": 0,
      "trial_period": false,
      "primary_color": "",
      "secondary_color": "",
      "personal_dashboards_allowed": false,
      "user_allowed_to_create_company": false,
      "company_uuid": "",
      "is_partner": false,
      "enforced_2fa": false,
      "ip_whitelist": "",
      "block_tor": false,
      "subscription_paid_externally": false,
      "image": "",
      "self": "",
      "meta": {
        "applications": "",
        "settings": "",
        "logo": "",
        "domains": ""
      }
    },
    "status": false,
    "title": "",
    "website_url": "",
    "redirect_url": "",
    "icon_url": "",
    "decsription": "",
    "client_id": "",
    "client_secret": "",
    "meta": {
      "remove": ""
    },
    "self": ""
  },
  "self": ""
}
                      
                        {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "alias": {
      "type": "number"
    },
    "valid_from": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "valid_to": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date time in iso"
        },
        "timezone_type": {
          "type": "number"
        },
        "timezone": {
          "type": "string"
        }
      }
    },
    "fingerprint": {
      "type": "string"
    },
    "certificate": {
      "type": "string"
    },
    "o_auth_application": {
      "type": "object",
      "properties": {
        "alias": {
          "type": "number"
        },
        "owner": {
          "type": "object",
          "properties": {
            "alias": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "contact_email": {
              "type": "string"
            },
            "billing_email": {
              "type": "string"
            },
            "domain": {
              "type": "string"
            },
            "intranet_website": {
              "type": "string"
            },
            "remaining_trial_period": {
              "type": "number"
            },
            "trial_period": {
              "type": "boolean"
            },
            "primary_color": {
              "type": "string"
            },
            "secondary_color": {
              "type": "string"
            },
            "personal_dashboards_allowed": {
              "type": "boolean"
            },
            "user_allowed_to_create_company": {
              "type": "boolean"
            },
            "company_uuid": {
              "type": "string"
            },
            "is_partner": {
              "type": "boolean"
            },
            "enforced_2fa": {
              "type": "boolean"
            },
            "ip_whitelist": {
              "type": "string"
            },
            "block_tor": {
              "type": "boolean"
            },
            "subscription_paid_externally": {
              "type": "boolean"
            },
            "image": {
              "type": "string"
            },
            "self": {
              "type": "string"
            },
            "meta": {
              "type": "object",
              "properties": {
                "applications": {
                  "type": "string"
                },
                "settings": {
                  "type": "string"
                },
                "logo": {
                  "type": "string"
                },
                "domains": {
                  "type": "string"
                }
              }
            }
          }
        },
        "status": {
          "type": "boolean"
        },
        "title": {
          "type": "string"
        },
        "website_url": {
          "type": "string"
        },
        "redirect_url": {
          "type": "string"
        },
        "icon_url": {
          "type": "string"
        },
        "decsription": {
          "type": "string"
        },
        "client_id": {
          "type": "string"
        },
        "client_secret": {
          "type": "string"
        },
        "meta": {
          "type": "object",
          "properties": {
            "remove": {
              "type": "string"
            }
          }
        },
        "self": {
          "type": "string"
        }
      }
    },
    "self": {
      "type": "string"
    }
  }
}
                      
Customers List
Return AppsCo customers for partner.

Retrieve customers

REQUEST

Headers
Authorization token absdef12345

RESPONSE