1. GWS
ResellerStack Developer API
  • Introduction
  • Quick start
  • API Reference
    • Customers
      • List customers
      • Create customer
      • Get customer
      • Update customer notes
      • Update customer status
      • Update billing details
    • Geo
      • List countries
      • List states
    • Pricing
      • List TLD pricing
      • Update TLD pricing
      • Set TLD featured
      • Apply bulk margin
      • Reorder TLD pricing
    • Domains
      • List domains
      • Check domain availability
      • Register a domain
      • Checkout domain cart (bulk)
      • Toggle WHOIS privacy
      • Update domain contacts
      • Get domain
      • Toggle transfer lock
      • Toggle auto-renew
      • Preview renewal price
      • Renew domain now
      • Register a domain with Google Workspace
      • List bundle offers for a name
      • Register a bundle
    • Contacts
      • List contacts
      • Create contact
      • Get contact
    • Orders
      • List orders
      • Get order
    • DNS
      • List DNS records
      • Add DNS records
      • Update DNS record
      • Delete DNS record
      • Update nameservers
      • Reset nameservers
      • List DNSSEC records
      • Add DNSSEC record
      • Delete DNSSEC record
    • Wallet
      • Get wallet balance
    • Webhooks
      • workspace.pastdue
      • workspace.expired
      • workspace.txt.failed
      • workspace.renewed
      • workspace.provisioned
      • workspace.txt.ready
      • workspace.txt.propagated
      • workspace.licenses.increased
      • workspace.deleted
      • workspace.failed
      • mailbox.ready
      • mailbox.deleted
      • workspace.dkim.ready
      • workspace.dkim.propagated
      • workspace.domain.swapped
      • Delivered when domain.order.success fires
      • Delivered when domain.order.failed fires
      • Delivered when domain.renewal.success fires
      • Delivered when domain.renewal.failed fires
    • GWS
      • Google Workspace ~ Creation Flow
      • Google Workspace ~ Sandbox Environment
      • Check Workspace Exists
        POST
      • Create Workspace
        POST
      • List Workspaces
        GET
      • Delete Workspace
        DELETE
      • Check DNS Propagation
        POST
      • Renew Workspace
        POST
      • Change Primary Domain (Beta)
        POST
    • Licenses & Mailboxes
      • Create Mailbox
      • List Mailboxes
      • Delete Mailboxes
      • Decrease Seats
  • Health check
    GET
  • Get current partner
    GET
  1. GWS

List Workspaces

Production
https://api.resellerstack.ai/api/v1
Production
https://api.resellerstack.ai/api/v1
GET
/gws
🧪 Sandbox only for now. This endpoint is currently available in the sandbox environment only; live access is coming soon.
List a customer's Google Workspace tenants.
Returns status, seat counts and DNS records. Only workspaces created through this API are visible.
dnsRecords fields are null until provisioning has retrieved them — wait for the corresponding webhook before reading them.
Scope: gws:read

Request

Authorization
API Key
Add parameter in header
rs-x-api-key
Example:
rs-x-api-key: ********************
or
Query Params

Responses

🟢200Success
application/json
Paginated list of workspaces. An empty data array is a valid result, not an error.
Bodyapplication/json

🟠403Forbidden
🟠404Not Found
🟠422Validation Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.resellerstack.ai/api/v1/gws?userId=b3d6f2a1-4c8e-4f9d-a2b1-7e3d5c9f0a12&domain=example.com&contains=example&page=1&limit=50' \
--header 'rs-x-api-key: <api-key>'
Response Response Example
200 - Example 1
{
    "status": 200,
    "message": "Workspaces",
    "data": {
        "workspaces": [
            {
                "domain": "example.com",
                "adminEmail": "admin@example.com",
                "status": "provisioning",
                "totalSeats": 3,
                "usedSeats": 3,
                "availableSeats": 0,
                "dnsRecords": [
                    {
                        "purpose": "domain_verification",
                        "type": "TXT",
                        "host": "@",
                        "expectedValue": "google-site-verification=abc123xyz",
                        "currentValue": "google-site-verification=abc123xyz",
                        "propagatedAt": "2026-09-16T20:14:00.000Z"
                    },
                    {
                        "purpose": "mx",
                        "type": "MX",
                        "host": "@",
                        "expectedValue": "smtp.google.com",
                        "currentValue": null,
                        "priority": 1,
                        "propagatedAt": null
                    },
                    {
                        "purpose": "dkim",
                        "type": "TXT",
                        "host": "google._domainkey",
                        "expectedValue": "v=DKIM1; k=rsa; p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQ...",
                        "currentValue": null,
                        "propagatedAt": null
                    }
                ],
                "createdAt": "2026-09-16T20:00:00.000Z"
            }
        ],
        "total": 1,
        "page": 1,
        "limit": 50
    }
}
Modified at 2026-10-22 09:07:25
Previous
Create Workspace
Next
Delete Workspace
Built with