Auth

Authorization

Method EndPoint Description
GET v2/auth/gatoken

Generate a new ga token.

POST v2/Auth

Generates a new Json Web Token.

Apps

Gets the Master App Information

Method EndPoint Description
GET v2/apps/{id}

Get Specific App Information from providing the AppId

GET v2/apps/{id}/details

Fetch the Details of an App from the provided App Id

GET v2/apps/{id}/android

Fetch the Android Details of an App from the provided App Id

GET v2/apps/{id}/ios

Fetch the iOS Details of an App from the provided App Id

GET v2/apps/{id}/footer

Fetch the Footer Details of an App from the provided App Id

GET v2/apps/{id}/masterhomescreen

Fetch the Home Details of an App from the provided App Id

POST v2/apps/GetGaData

Get the Google Analytics data of the app

AppsPush

Send and manage Push Notifictions on apps

Method EndPoint Description
GET v2/apps/{appId}/push

Gets all push notifications for the application

GET v2/apps/{appId}/push/history?after={after}&tenants={tenants}&categories={categories}

Retrieves a list of push notifications for an app after a given date. If no date is given the previous 30 days are retrieved. Only non-previewer and non-geo push notifications are returned that you have access to read. If you do not have access to read this apps notifications, or non-previewer pushes, it will return an emtpy list NOTE : Categories are optional

GET v2/apps/{appId}/push/previewer?after={after}&categories={categories}

Retrieves a list of previewer push notifications for an app after a given date. If no date is given the previous 30 days are retrieved. Only previewer and non-geo push notifications are returned that you have access to read. If you do not have access to read this apps notifications, it will return an emtpy list NOTE : Categories are optional

GET v2/apps/{appId}/push/{pushId}

Grabs details about a specific Push Notification on an application

GET v2/apps/{appId}/push/categories?type={type}

Retrieves the currently active list of push categories for an app

GET v2/apps/{appId}/push/targetmember

Get list of registered target push members.

POST v2/apps/{appId}/push

Send a push notification to the application

POST v2/apps/{appId}/push/targetmember?member={member}

Creates a new record that the push notification can target

Calendar

Manager Calendars of the apps.

Method EndPoint Description
GET v2/apps/{appId}/calendar?id={id}

Returns a Calendar Response

GET v2/apps/{appId}/calendar

Returns an IEnumerable List of Calendar Response for the Master

GET v2/apps/{appId}/calendar/{tenantId}

Returns an IEnumerable List of Calendar Response for the Tenant

POST v2/apps/{appId}/calendar

Create a new Calendar for the Master

POST v2/apps/{appId}/calendar/{tenantId}

Create a new Calendar for the Tenant

PUT v2/apps/{appId}/calendar/{calendarId}

Update the already existing calendar

DELETE v2/apps/{appId}/calendar/{calendarId}

Delete specific calendar

CalendarEvent

Manage the calendar event on the apps.

Method EndPoint Description
GET v2/apps/{appId}/calendarevent

Returns the events for the master app or single app.

GET v2/apps/{appId}/calendarevent/{tenantId}/{calId}

Returns events private/shared for the tenant app.

GET v2/apps/{appId}/calendarevent/{tenantId}?endDate={endDate}

Returns the event for the master app or single app.

POST v2/apps/{appId}/calendarevent

Create a new Event or Reminder for the Master

POST v2/apps/{appId}/calendarevent/{tenantId}

Create a new Event or Reminder for the Tenant

DELETE v2/apps/{appId}/calendarevent/{calendarEventId}

Delete specific calendar event or reminder

ImpactVideo

Gets the Master App Information

Method EndPoint Description
GET v2/impactvideo/getprofile/{id}

Returns a Impact Video Profile

GET v2/impactvideo/getmyvideo/{id}

No documentation available.

GET v2/impactvideo/getmyvideobyprofile/{id}

No documentation available.

POST v2/impactvideo/GetCompanyNameList

No documentation available.

POST v2/impactvideo/MyvideoAdminDelete

No documentation available.

PUT v2/impactvideo/UpdateProfile/{id}

Update the already existing profile

PUT v2/impactvideo/UpdateMyVideo/{id}

No documentation available.

TenantMember

Retrieves information about tenant members

Method EndPoint Description
GET v2/tenantmember/{id}

Retrieves a specific member that has access to the tenant using the Member Id. Returns Not Found if it does not have any information to return

GET v2/tenantmember?email={email}

Retrieves a specific member that has access to the tenant using members email address. Returns Not Found if it does not have any information to return

POST v2/tenantmember/login/{appId}

Validates Login credentials from App

POST v2/tenantmember

Create a new External member in AppNotch. Special permissions are required for this call

POST v2/tenantmember/{id}/associate/{tenantId}

Create a new External member in AppNotch. Special permissions are required for this call

POST v2/tenantmember/{id}/changeconfig/{tenantId}

Change the access of the member on their dashboard.

POST v2/tenantmember/ResetPassword

Request for a reset token to reset the old password

PUT v2/tenantmember/{id}

Update the members information, NOTE: this method does not allow the caller to change the email and password of the tenant

Tenants

Retrieve information about Tenants for MultiTenant apps

Method EndPoint Description
GET v2/apps/{appId}/tenants

Retrieves all Tenants for an Application, including disabled ones. Returns Not Found if App doesn't exist or is not a Multi-Tenant App

GET v2/apps/{appId}/tenants/full?tag={tag}

Retrieves full details of all Tenants for an Application, including disabled ones. Returns Not Found if App doesn't exist or is not a Multi-Tenant App

GET v2/apps/{appId}/tenants/active

Retrieves all active Tenants for an Application. Returns Not Found if App doesn't exist or is not a Multi-Tenant App

GET v2/apps/{appId}/tenants/active/page/{page}/display?display={display}

Retrieves all active Tenants for an Application. Returns Not Found if App doesn't exist or is not a Multi-Tenant App

GET v2/apps/{appId}/tenants/active/near?lat={lat}&lng={lng}&distance={distance}

Retrieves all active Tenants for an Application. Returns Not Found if App doesn't exist or is not a Multi-Tenant App

GET v2/apps/{appId}/tenants/active/full?tag={tag}

Retrieves full details of all active Tenants for an Application. Returns Not Found if App doesn't exist or is not a Multi-Tenant App

GET v2/apps/{appId}/tenants/{id}

Retrieves a specific tenant for an Application.

GET v2/apps/{appId}/tenants/{id}/full

Retrieves full information for a tenant of an Application.

GET v2/apps/{appId}/tenants/{tenantId}/members

Retrieves all members that has access to the tenant. Returns Not Found if it does not have any information to return

GET v2/apps/{appId}/tenants/{memberId}/gettenantsbymember

Gets the list of tenant that a member has

GET v2/apps/{appId}/tenants/active/search?searchFilter={searchFilter}

Retreives all tenants within the app that matches the filter.

GET v2/apps/{appId}/tenants/{id}/homescreen

Fetch the Home Details of an App from the provided App Id

GET v2/Tenants?appId={appId}&branchUrl={branchUrl}

Retrieves a specific tenant for an Application.

POST v2/apps/{appId}/tenants

Create a Tenant inside the master app, NOTE Leave the footer empty to replicate master footer.

POST v2/apps/{appId}/tenants/{tenantId}/createtrackingentry

Track the device

POST v2/apps/{appId}/tenants/{tenantId}/GetTracking

Gets the analytics of the app.

PUT v2/apps/{appId}/tenants/{id}

Update a Tenant for a specific app

DELETE v2/apps/{appId}/tenants/{id}

Permanently deletes a tenant from an application

TenantsPush

Manage push notifications to specific tenants

Method EndPoint Description
GET v2/apps/{appId}/tenants/{tenantId}/push

Retrieve all push messages for a tenant

GET v2/apps/{appId}/tenants/{tenantId}/push/{id}

Retrieve a specific push message from a tenant

POST v2/apps/{appId}/tenants/{tenantId}/push

Send a push notification to a specific tenant. Previewer pushes are not supported for this operation

POST v2/apps/{appId}/tenants/{tenantId}/push/count

Gets the total number of push sent by the tenant

POST v2/apps/{appId}/tenants/{tenantId}/push/addCategory?categoryName={categoryName}

Delete push with {categoryId}

DELETE v2/apps/{appId}/tenants/{tenantId}/push/delete/{pushId}

Delete push with {pushId}

DELETE v2/apps/{appId}/tenants/{tenantId}/push/deleteCategory/{categoryId}

Delete push with {categoryId}