Family

• Generic
  • getGet application KPIs
  • getGet subscription plan IDs
• Salesforce
  • getGet Salesforce organizations
  • getGet Salesforce organization KPIs
  • getGet Salesforce users
  • getGet Salesforce users KPI
  • getGet Salesforce users lookup values
  • getGet Salesforce family subscriptions
  • getGet Salesforce family consumptions
• Servicenow
  • getGet ServiceNow subscriptions
  • getGet ServiceNow users

API docs by Redocly

SaaS: Family (1.0.0)

Download OpenAPI specification:Download

URL: https://www.flexera.com

API for interacting with SaaS family subscription endpoints.

Generic

Tag for Generic endpoints.

Get application KPIs

Returns the details of a family's application KPIs.

Authorizations:

bearerAuth

query Parameters

fromDate required	string <date> Example: fromDate=2024-11-26 Starting date from which to calculate KPI.
toDate required	string <date> Example: toDate=2024-11-26 Starting date until which to calculate KPI.
subscriptionIds	string Example: subscriptionIds=5b35aa33-e7a8-47a3-b1b6-19099ebb6bfd,b10f3e61-bf51-4e87-88fe-f3d22e3194bd,b12ce8d7-2ca6-4b2d-80ca-eb5d1a57ceca Comma separated list of subscription IDs.
subscriptionPlanIds	string Example: subscriptionPlanIds=5b35aa33-e7a8-47a3-b1b6-19099ebb6bfd,b10f3e61-bf51-4e87-88fe-f3d22e3194bd,b12ce8d7-2ca6-4b2d-80ca-eb5d1a57ceca A comma-separated list of subscription plan IDs.

Responses

https://{region}.snowsoftware.io/api/saas/consolidated-view/v2/subscription-family/applications/kpi

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "notApproved": 71,
• "total": 56

}

Get subscription plan IDs

Returns a list of subscription plan IDs associated with the specified subscription family.

Authorizations:

bearerAuthbearerAuth

path Parameters

familyId required

string <uuid> Example: 82da0ce3-acba-4089-b765-6fe883617968 The unique ID of the subscription family.

query Parameters

subscriptionIds	string Example: subscriptionIds=5b35aa33-e7a8-47a3-b1b6-19099ebb6bfd,b10f3e61-bf51-4e87-88fe-f3d22e3194bd,b12ce8d7-2ca6-4b2d-80ca-eb5d1a57ceca Comma separated list of subscription IDs.
page_number	integer <int32> Default: 1 The page number.
page_size	integer <int32> Default: 100 The maximum number of items in the response.

Responses

https://{region}.snowsoftware.io/api/saas/consolidated-view/v1/subscription-family/{familyId}/subscriptionplanids

Response samples

• 200
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "name": "Premium Salesforce Plan",
    • "id": "plan_12345"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 1,
  • "total_items": 1

  }

}

Salesforce

Tag for Salesforce endpoints.

Get Salesforce organizations

Returns a collection of Salesforce organizations for a family.

Authorizations:

bearerAuth

query Parameters

subscriptionPlanIds	string Example: subscriptionPlanIds=5b35aa33-e7a8-47a3-b1b6-19099ebb6bfd,b10f3e61-bf51-4e87-88fe-f3d22e3194bd,b12ce8d7-2ca6-4b2d-80ca-eb5d1a57ceca A comma-separated list of subscription plan IDs.
page_number	integer <int32> Default: 1 The page number.
page_size	integer <int32> Default: 100 The maximum number of items in the response.
filter	string Example: filter=?filter=field1 -eq 'abc' For more information on the available operators and which data types those operators work on, see Filter API call results.
sort	string Example: sort=?sort=field1:asc For more information on sorting capability and examples, see Sort API call results.

Responses

https://{region}.snowsoftware.io/api/saas/consolidated-view/v1/subscription-family/salesforce/organizations

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "active": 10,
    • "id": "2f86b198-04f3-4770-ad08-b32518206da0",
    • "inactive": 10,
    • "name": "Salesforce organization name",
    • "noActivity": 1,
    • "potentialSavings": 100,
    • "subscriptionIds": [

      • "2f86b198-04f3-4770-ad08-b32518206da0"

      ],
    • "subscriptions": 20,
    • "totalCost": 100,
    • "totalCostPerYear": 100,
    • "usage": 0.1,
    • "users": 20,
    • "utilization": 98

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 1,
  • "total_items": 1

  }

}

Get Salesforce organization KPIs

Returns a collection of Salesforce organizations' key performance indicators.

Authorizations:

bearerAuth

query Parameters

subscriptionPlanIds

string Example: subscriptionPlanIds=5b35aa33-e7a8-47a3-b1b6-19099ebb6bfd,b10f3e61-bf51-4e87-88fe-f3d22e3194bd,b12ce8d7-2ca6-4b2d-80ca-eb5d1a57ceca A comma-separated list of subscription plan IDs.

Responses

https://{region}.snowsoftware.io/api/saas/consolidated-view/v1/subscription-family/salesforce/organizations/kpi

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "total": 10,
• "totalCostPerYear": 157.35

}

Get Salesforce users

Returns a collection of Salesforce users for a family.

Authorizations:

bearerAuthbearerAuth

query Parameters

subscriptionPlanIds	string Example: subscriptionPlanIds=5b35aa33-e7a8-47a3-b1b6-19099ebb6bfd,b10f3e61-bf51-4e87-88fe-f3d22e3194bd,b12ce8d7-2ca6-4b2d-80ca-eb5d1a57ceca A comma-separated list of subscription plan IDs.
page_number	integer <int32> Default: 1 The page number.
page_size	integer <int32> Default: 100 The maximum number of items in the response.
filter	string Example: filter=?filter=field1 -eq 'abc' For more information on the available operators and which data types those operators work on, see Filter API call results.
sort	string Example: sort=?sort=field1:asc For more information on sorting capability and examples, see Sort API call results.

Responses

https://{region}.snowsoftware.io/api/saas/consolidated-view/v1/subscription-family/salesforce/users

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "id": "05f333f7-9b1a-4324-af10-7911efe3888b",
    • "email": "johndoe@email.com",
    • "displayName": "John Doe",
    • "userIds": {

      • "0": "User_257c2af2-834d-4735-893d-e5a65f98adf3_0051M00000AOvl3QAD"

      },
    • "aliases": {

      • "0": "J Doe"

      },
    • "userNames": {

      • "0": "johndoe@email.com"

      },
    • "orgsCount": 1,
    • "orgNames": {

      • "0": "Clutterbusters"

      },
    • "lastActive": "2025-03-25T15:04:05",
    • "status": "Active",
    • "userTypes": {

      • "0": "Standard"

      },
    • "roles": {

      • "0": "GCS Support Engineer"

      },
    • "profiles": {

      • "0": "Support"

      },
    • "country": "Se",
    • "department": "Sales",
    • "locale": "sv-SE",
    • "monthlyCost": 157.35,
    • "subscriptionAccounts": [

      • {

        • "subscriptionId": "FeatureLicense_257c2af2-834d-4735-893d-e5a65f98adf3_KnowledgeUser",
        • "subscriptionPlanId": "e3225d5f-ce1e-49ec-b119-8083d3b2acb5",
        • "subscriptionName": "KnowledgeUserSubscription",
        • "subscriptionType": "Feature",
        • "lastActive": "2025-03-25T15:04:05",
        • "monthlyCost": 157.35,
        • "orgId": "aaf72770-1521-4ae8-8872-ac7bd71e292e",
        • "orgName": "Clutterbusters"

        }

      ]

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 1,
  • "total_items": 1

  }

}

Get Salesforce users KPI

Returns salesforce users KPI.

Authorizations:

bearerAuthbearerAuth

query Parameters

subscriptionPlanIds

string Example: subscriptionPlanIds=5b35aa33-e7a8-47a3-b1b6-19099ebb6bfd,b10f3e61-bf51-4e87-88fe-f3d22e3194bd,b12ce8d7-2ca6-4b2d-80ca-eb5d1a57ceca A comma-separated list of subscription plan IDs.

Responses

https://{region}.snowsoftware.io/api/saas/consolidated-view/v1/subscription-family/salesforce/users/kpi

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "totalUsers": 56,
• "active": 12,
• "inactive": 44,
• "noActivity": 15,
• "usersWithMultipleOrgs": 5

}

Get Salesforce users lookup values

Returns values that can be used as for lookup values for filters.

Authorizations:

bearerAuthbearerAuth

Responses

https://{region}.snowsoftware.io/api/saas/consolidated-view/v1/subscription-family/salesforce/users/lookup-values

Response samples

• 200
• 500

Content type

application/json

{

• "userTypes": {

  • "0": "Standard",
  • "1": "PowerCustomerSuccess"

  },
• "orgNames": {

  • "0": "Clutterbusters",
  • "1": "Space Matters"

  },
• "roles": {

  • "0": "GCS Consultant NAM",
  • "1": "Sales MAM NAM West"

  },
• "profiles": {

  • "0": "Engineering Management",
  • "1": "Standard Platform User"

  }

}

Get Salesforce family subscriptions

Returns a list of Salesforce subscriptions.

Authorizations:

bearerAuthbearerAuth

query Parameters

page_number	integer <int32> Default: 1 The page number.
page_size	integer <int32> Default: 100 The maximum number of items in the response.
filter	string Example: filter=?filter=field1 -eq 'abc' For more information on the available operators and which data types those operators work on, see Filter API call results.
sort	string Example: sort=?sort=field1:asc For more information on sorting capability and examples, see Sort API call results.

Responses

https://{region}.snowsoftware.io/api/saas/consolidated-view/v1/subscription-family/salesforce/subscriptions

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "name": "Chatter External",
    • "purchased": 10,
    • "assigned": 5,
    • "utilization": 12.5,
    • "potentialSavings": 5000,
    • "usage": 1000,
    • "type": "User",
    • "totalCost": 1000.5,
    • "totalCostPerYear": 2000,
    • "active": 10,
    • "discoveryTypes": [

      • 0

      ],
    • "notMonitored": 100,
    • "noActivity": 100,
    • "inactive": 20,
    • "totalCostPerMonth": 10,
    • "overAssigned": 11,
    • "unassigned": 15,
    • "details": [

      • {

        • "name": "Chatter External",
        • "purchased": 10,
        • "assigned": 5,
        • "utilization": 12.5,
        • "potentialSavings": 5000,
        • "usage": 1000,
        • "type": "User",
        • "totalCost": 1000.5,
        • "totalCostPerYear": 2000,
        • "active": 10,
        • "discoveryTypes": [

          • 0

          ],
        • "notMonitored": 100,
        • "noActivity": 100,
        • "inactive": 20,
        • "totalCostPerMonth": 10,
        • "overAssigned": 11,
        • "unassigned": 15,
        • "organizationName": "Salesforce Org 1",
        • "skuName": "SKU 1",
        • "id": "2f86b198-04f3-4770-ad08-b32518206da0"

        }

      ],
    • "organizationNames": {

      • "0": "Salesforce Org 1",
      • "1": "Salesforce Org 2",
      • "2": "Salesforce Org 3"

      },
    • "skuNames": {

      • "0": "SKU 1",
      • "1": "SKU 2",
      • "2": "SKU 3"

      }

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 1,
  • "total_items": 1

  }

}

Get Salesforce family consumptions

Returns a list of Salesforce consumptions.

Authorizations:

bearerAuthbearerAuth

query Parameters

page_number	integer <int32> Default: 1 The page number.
page_size	integer <int32> Default: 100 The maximum number of items in the response.
filter	string Example: filter=?filter=field1 -eq 'abc' For more information on the available operators and which data types those operators work on, see Filter API call results.
sort	string Example: sort=?sort=field1:asc For more information on sorting capability and examples, see Sort API call results.

Responses

https://{region}.snowsoftware.io/api/saas/consolidated-view/v1/subscription-family/salesforce/consumptions

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "originalId": "0UTG0000000004wOAA",
    • "name": "API Request Limit per Month",
    • "resourceId": "(tenant)",
    • "purchased": 10,
    • "consumed": 10,
    • "remaining": 10,
    • "utilization": 12.5,
    • "usageDate": "2019-08-24T14:15:22Z",
    • "frequency": "Daily",
    • "details": [

      • {

        • "originalId": "0UTG0000000004wOAA",
        • "name": "API Request Limit per Month",
        • "resourceId": "(tenant)",
        • "purchased": 10,
        • "consumed": 10,
        • "remaining": 10,
        • "utilization": 12.5,
        • "usageDate": "2019-08-24T14:15:22Z",
        • "frequency": "Daily",
        • "organizationName": "Salesforce Org 1"

        }

      ],
    • "organizationNames": {

      • "0": "Salesforce Org 1",
      • "1": "Salesforce Org 2",
      • "2": "Salesforce Org 3"

      }

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 1,
  • "total_items": 1

  }

}

Servicenow

Tag for ServiceNow endpoints.

Get ServiceNow subscriptions

Returns a collection of ServiceNow subscriptions for a family.

Authorizations:

bearerAuth

query Parameters

subscriptionIds	string Example: subscriptionIds=5b35aa33-e7a8-47a3-b1b6-19099ebb6bfd,b10f3e61-bf51-4e87-88fe-f3d22e3194bd,b12ce8d7-2ca6-4b2d-80ca-eb5d1a57ceca Comma separated list of subscription IDs.
page_number	integer <int32> Default: 1 The page number.
page_size	integer <int32> Default: 100 The maximum number of items in the response.
filter	string Example: filter=?filter=field1 -eq 'abc' For more information on the available operators and which data types those operators work on, see Filter API call results.
sort	string Example: sort=?sort=field1:asc For more information on sorting capability and examples, see Sort API call results.

Responses

https://{region}.snowsoftware.io/api/saas/consolidated-view/v1/subscription-family/servicenow/subscriptions

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "purchased": 10,
    • "assigned": 3,
    • "unassigned": 2,
    • "overassigned": 1,
    • "id": "2f86b198-04f3-4770-ad08-b32518206da0",
    • "active": 10,
    • "inactive": 10,
    • "noActivity": 1,
    • "application": "ServiceNow application name",
    • "applicationId": "d8fdde78-60e4-4f81-9e32-6b769176eac0",
    • "applications": [

      • {

        • "appCategoryName": "Document Management",
        • "applicationId": "0dd14c40-965f-432d-b5de-fe8e50677519",
        • "applicationName": "Adobe Acrobat.",
        • "disServiceId": "a5b52a55-515c-48f6-9939-10b12191fe6d"

        }

      ],
    • "automaticallyAdded": false,
    • "connectorName": "ServiceNow connector",
    • "costPerUnit": 32.1,
    • "currency": "USD",
    • "disServiceId": "f3924b69-140c-4587-a15e-ecbb4a9e9998",
    • "discovered": 3,
    • "discoveryTypes": [

      • {

        • "0": 1,
        • "1": 2

        }

      ],
    • "excludedFromMetrics": false,
    • "expirationDate": "2030-01-02T15:04:05",
    • "familyId": "6c12ebe7-4098-443c-b5b0-80ab0b544a60",
    • "familyName": "ServiceNow Family name",
    • "free": true,
    • "isBundled": true,
    • "name": "ServiceNow subscription name",
    • "notMonitored": 3,
    • "purchasedDate": "2006-01-02T15:04:05",
    • "quantity": 1,
    • "rrpPeriod": "Annually",
    • "rrpValue": 155.88,
    • "startDate": "2006-01-02T15:04:05",
    • "usage": 0.1,
    • "utilization": 98,
    • "vendor": "Adobe Inc.",
    • "vendorId": "0dd14c40-965f-432d-b5de-fe8e50677519",
    • "measuredRoleTypes": {

      • "0": "Fulfiller",
      • "1": "Requester"

      },
    • "applicationTypes": {

      • "0": "Case Management",
      • "1": "Incident Management",
      • "2": "Request Management"

      }

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 1,
  • "total_items": 1

  }

}

Get ServiceNow users

Returns a collection of ServiceNow users of a family based on filter query if given. If an insightRuleId is provided, users will be returned from the perspective of the provided insights instead.

Authorizations:

bearerAuth

query Parameters

subscriptionIds	string Example: subscriptionIds=5b35aa33-e7a8-47a3-b1b6-19099ebb6bfd,b10f3e61-bf51-4e87-88fe-f3d22e3194bd,b12ce8d7-2ca6-4b2d-80ca-eb5d1a57ceca Comma separated list of subscription IDs.
page_number	integer <int32> Default: 1 The page number.
page_size	integer <int32> Default: 100 The maximum number of items in the response.
filter	string Example: filter=?filter=field1 -eq 'abc' For more information on the available operators and which data types those operators work on, see Filter API call results.
sort	string Example: sort=?sort=field1:asc For more information on sorting capability and examples, see Sort API call results.

Responses

https://{region}.snowsoftware.io/api/saas/consolidated-view/v1/subscription-family/servicenow/users

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "country": "Se",
    • "createdDate": "2030-01-02T15:04:05",
    • "department": "Sales.",
    • "details": [

      • {

        • "applicationName": "Zoom.",
        • "lastActive": "2030-01-02T15:04:05",
        • "lastActiveValueInInt": 1,
        • "lastActiveValueType": 1,
        • "subscriptionName": "Video calls software pro delux edition."

        }

      ],
    • "discoveryTypes": [

      • {

        • "0": 1,
        • "1": 2

        }

      ],
    • "displayName": "John Doe.",
    • "email": "john@example.com",
    • "id": "c6851b0a-6b85-4c8c-9b27-bfa4d357276c",
    • "isInReview": true,
    • "isOnline": true,
    • "isQualified": true,
    • "lastActive": "2030-01-02T15:04:05",
    • "manuallyAssigned": true,
    • "monthlyCost": 90.99,
    • "status": "Not monitored.",
    • "username": "john@example.com",
    • "roleTypes": {

      • "0": "Admin",
      • "1": "Fulfiller",
      • "2": "Requester"

      },
    • "oobRoles": {

      • "0": "pa_viewer",
      • "1": "catalog_editor",
      • "2": "ais_admin"

      },
    • "customRoles": {

      • "0": "catalog",
      • "1": "client_user",
      • "2": "awa_admin"

      },
    • "webServiceUser": true,
    • "applicationTypes": {

      • "0": "Incident management",
      • "1": "Request management",
      • "2": "Case management",
      • "3": "Security operations"

      },
    • "groups": {

      • "0": "Analyst",
      • "1": "Application dev",
      • "2": "Legal service management team"

      }

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 1,
  • "total_items": 1

  }

}