Get SaaS Locations

GET 
/saas-api/public-api/saas-locations/:companyId

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Fetch all SaaS-activated locations for a company with pagination

Request

Version stringrequired

API Version

Available options2021-04-15

companyId stringrequired

Company ID to get SaaS locations for

page number

Page number for pagination

application/json

SaaS locations retrieved successfully

application/json

Schema

Schema

locationsobject[]required

Array of SaaS locations

paginationobjectrequired

Example (auto)

{
  "locations": [
    {
      "locationId": "locationId1",
      "companyId": "companyId1",
      "saasMode": "saasV2",
      "subscriptionId": "subscriptionId1",
      "customerId": "customerId1",
      "name": "John Doe",
      "email": "[email protected]",
      "providerLocationId": "r06mdj4OrrERzYDvsOdh",
      "isSaaSV2": true,
      "subscriptionInfo": {
        "priceId": "price_1QDPY5FpU9DlKp7RQ8BXfywx",
        "saasPlanId": "66c4d36534f21f900dc2a265",
        "stripeProductId": "prod_1QDPY5FpU9DlKp7RQ8BXfywx",
        "subscriptionStatus": "active"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 100,
    "totalPages": 10,
    "hasNext": true,
    "hasPrev": true
  }
}