Apps

Get app

Auth: User JWT

Allows to get a list of all applications for which the user has reading permissions.

get/v1/apps/{id}

Request

  • Base URL: https://api.chat.ethora.com
  • URL: https://api.chat.ethora.com/v1/apps/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

ID of the target resource. The exact type (App, File, etc.) depends on the endpoint.

Query parameters

limitinteger

Maximum number of items to return per page. Server caps vary per endpoint; the response carries the actual page size.

offsetinteger

Number of items to skip from the beginning of the result set. Use with limit for paging.

orderBy'displayName' | 'totalRegistered' | 'totalSessions' | 'totalApiCalls' | 'totalFiles' | 'totalTransactions' | 'createdAt' | 'totalChats'

Field to sort by. Allowed values are listed in the schema; if omitted, the endpoint's default ordering is used.

order'asc' | 'desc'

Sort direction: asc (default) or desc.

Response 

{
  apps: [{
    _id: string,
    displayName: string,
    domainName: string,
    creatorId: string,
    bundleId: string,
    primaryColor: string,
    coinSymbol: string,
    coinName: boolean,
    defaultAccessProfileOpen: boolean,
    defaultAccessAssetsOpen: boolean,
    usersCanFree: boolean,
    isUserDataEncrypted: boolean,
    parentAppId: boolean,
    isAllowedNewAppCreate: boolean,
    isBaseApp: boolean,
    defaultRooms: [{jid: string, pinned: boolean}],
    createdAt: string,
    updatedAt: string,
    appToken: string,
    stats: {
      totalRegistered: number,
      recentlyRegistered: number,
      totalSessions: number,
      recentlySessions: number,
      totalApiCalls: number,
      recentlyApiCalls: number,
      totalFiles: number,
      recentlyFiles: number,
      totalTransactions: number,
      recentlyTransactions: number,
      totalIssuance: number,
      recentlyIssuance: number,
    }
  }],
  total: number,
  limit: number,
  offset: number
}

Changes

No recorded changes to this operation across all 1 revision of this API.