Admin

class Admin(session_kwargs, client, return_type='raw')

Methods

list_organizations(*[, status, org_type])

List organizations

Examples

>>> import civis
>>> client = civis.APIClient()
>>> client.admin.list_organizations(...)
list_organizations(*, status: List[str] = None, org_type: List[str] = None)

List organizations

Parameters:
statusList[str], optional

The status of the organization (active/trial/inactive).

org_typeList[str], optional

The organization type (platform/ads/survey_vendor/other).

Returns:
civis.response.Response
  • idint

    The ID of this organization.

  • namestr

    The name of this organization.

  • slugstr

    The slug of this organization.

  • account_manager_idint

    The user ID of the Account Manager.

  • cs_specialist_idint

    The user ID of the Client Success Specialist.

  • statusstr

    The status of the organization (active/trial/inactive).

  • org_typestr

    The organization type (platform/ads/survey_vendor/other).

  • custom_brandingstr

    The custom branding settings.

  • contract_sizeint

    The monthly contract size.

  • max_analyst_usersint

    The max number of full platform users for the org.

  • max_report_usersint

    The max number of report-only platform users for the org.

  • verticalstr

    The business vertical that the organization belongs to.

  • cs_metadatastr

    Additional metadata about the organization in JSON format.

  • remove_footer_in_emailsbool

    If true, emails sent by platform will not include Civis text.

  • salesforce_account_idstr

    The Salesforce Account ID for this organization.

  • tableau_site_idstr

    The Tableau Site ID for this organization.

  • fedramp_enabledbool

    Flag denoting whether this organization is FedRAMP compliant.

  • created_by_idint

    The ID of the user who created this organization

  • last_updated_by_idint

    The ID of the user who last updated this organization

  • advanced_settingsdict
    • dedicated_dj_pool_enabledbool

      If true, the Organization has a dedicated delayed jobs pool. Defaults to false.

  • tableau_refresh_historyList[dict]

    The number of tableau refreshes used this month.