Get Application

Get Application

This method allows you to get public information about a Application using it's ID.
Parameter NameDefault ValueRequiredDescription
application_idNULLTrueThe ID of the Application

Example Success Response

{
  "success": true,
  "response_code": 200,
  "results": {
    "name": "Application Placeholder Demo",
    "name_safe": "application_placeholder_demo",
    "logo": {
      "original": "https://accounts.intellivoid.net/user/contents/public/application?app_id=APP65640a935039be5570428b6e74747811b0a290210e9e2d2f6722d8a54966ac171a4d5f1c&resource=original",
      "normal": "https://accounts.intellivoid.net/user/contents/public/application?app_id=APP65640a935039be5570428b6e74747811b0a290210e9e2d2f6722d8a54966ac171a4d5f1c&resource=normal",
      "preview": "https://accounts.intellivoid.net/user/contents/public/application?app_id=APP65640a935039be5570428b6e74747811b0a290210e9e2d2f6722d8a54966ac171a4d5f1c&resource=preview",
      "small": "https://accounts.intellivoid.net/user/contents/public/application?app_id=APP65640a935039be5570428b6e74747811b0a290210e9e2d2f6722d8a54966ac171a4d5f1c&resource=small",
      "tiny": "https://accounts.intellivoid.net/user/contents/public/application?app_id=APP65640a935039be5570428b6e74747811b0a290210e9e2d2f6722d8a54966ac171a4d5f1c&resource=tiny"
    },
    "status": "ACTIVE",
    "authentication_mode": "PLACEHOLDER",
    "permissions": [
      "READ_PERSONAL_INFORMATION",
      "INVOKE_TELEGRAM_NOTIFICATIONS",
      "READ_EMAIL_ADDRESS",
      "READ_TELEGRAM_CLIENT",
      "READ_TODO",
      "MANAGE_TODO",
      "SYNC_APPLICATION_SETTINGS",
      "READ_USERNAME",
      "GET_USER_DISPLAY"
    ]
  }
}

Application Object Structure

NameTypeDescription
namestringThe name of the Application
name_safestringThe safe version of the Application's name being lowercase and all spaces replaced with '_'
logoarrayThe permalinks of the application logo and their corresponding sizes, the key being the name of the size and the value being the permalink
statusstringThe status of the Application
authentication_modestringThe authentication mode that the Application uses
permissionsstring[] arrayThe permissions that this Application can request a user upon authentication request

Application Authentication Types

These are the types of Authentication methods that a Application may have enabled.

NameDescription
REDIRECTThis Authentication type is used to redirect users to the provided redirect URL which will include the Access Token in the GET parameter
PLACEHOLDERThis Authentication Type is used to provide a placeholder to tell the user that the Application is busy processing their authentication once the user authenticates. The client is expected to check the status of the Request Token to obtain the Access Token
RETURN_ACCESS_CODEThis Authentication Type is much like the placeholder type but instead the Access Token is presented to the user and the user must copy and paste the Access Token to the client that's asking for it
UNKNOWNThis Authentication Type is not recognized by the service, this may be an error that should be reported.

Application Permissions

To get more information about what permissions a Application can use and what do they mean, see Application Permissions


Application not found response

This response is given when the given Application ID is invalid or the server can't locate information about this Application with the given ID.

For more information about all the possible error codes and their meanings view the errors section in COA API Basics
{
  "success": false,
  "response_code": 404,
  "error": {
    "error_code": 2,
    "message": "INVALID APPLICATION ID",
    "type": "COA"
  }
}