FAfanhero
Organizations

List organizations

Changed on
get/organizations

Request

  • Base URL
    https://api-staging.fanheroapi.com
  • URL
    https://api-staging.fanheroapi.com/organizations
  • Auth
    API key in header API Key

Query parameters

pagenumber

Page to search. Page numbering starts with 0.

pageSizenumber required

Number of documents that will be returned

direction'ASC' | 'DESC' required

Sort direction. Ascending or Descending. Enum

field'name' required

Name of the sort-by field

Response

Successful response. Returns an array of organization objects.

idstring required
namestring required

The organization name

kind'PUBLIC' | 'EXCLUSIVE' | 'PAYWALL' | 'PRIVATE' required

The organization's privacy level

web_urlstring[] required

The URLs of the end user web applications.

identifierstring required
itunes_idstring required

Apple ID is the account that you use to access Apple services.

current_versionstring required
onesignal_idstring required
min_compat_versionstring required
portal_urlstring required

The URL to the clients portal on the FanHero platform

email_settingsobject required
tenant_idstring required
avatarCdnBaseUrlstring required
audioCdnBaseUrlstring required
imageCdnBaseUrlstring required

Example response

[
  {
    "id": "61886612d37f875060b4749c",
    "web_url": [
      "[\"https://vale.fanhero.tv\"]"
    ],
    "avatarCdnBaseUrl": "https://avatar-cdn",
    "audioCdnBaseUrl": "https://audio-cdn",
    "imageCdnBaseUrl": "https://image-cdn"
  }
]

Changes