[Bug Report: API Field Missing]

[Fahad-Habib]

🐛 Describe the Bug

The API endpoint is missing restrictSubAccount in the response which according to the documentation should be there and is crucial for us to know whether the user's account is restricted to the added sub-accounts or not.

📍 API Endpoint

https://services.leadconnectorhq.com/users/:userId

✅ Expected Behavior

The API should return the field restrictSubAccount with a boolean in the response.

💻 Screenshots or Code Samples

curl --location 'https://services.leadconnectorhq.com/users/vG51xz7sjxs4SR90G7XM' \
--header 'Version: 2021-07-28' \
--header 'Authorization: Bearer {company_access_token}'

Response:

{
    "id": "vG51xz7sjxs4SR90G7XM",
    "name": "Abdullah Raheel",
    "firstName": "Abdullah",
    "lastName": "Raheel",
    "email": "abdullah@dispogenius.io",
    "permissions": {
        "campaignsEnabled": true,
        "campaignsReadOnly": false,
        "workflowsEnabled": true,
        "workflowsReadOnly": false,
        "contactsEnabled": true,
        "triggersEnabled": true,
        "opportunitiesEnabled": true,
        "settingsEnabled": true,
        "tagsEnabled": true,
        "leadValueEnabled": true,
        "dashboardStatsEnabled": true,
        "bulkRequestsEnabled": true,
        "opportunitiesBulkActionsEnabled": true,
        "appointmentsEnabled": true,
        "reviewsEnabled": true,
        "onlineListingsEnabled": true,
        "phoneCallEnabled": true,
        "conversationsEnabled": true,
        "assignedDataOnly": false,
        "funnelsEnabled": true,
        "websitesEnabled": true,
        "marketingEnabled": true,
        "adwordsReportingEnabled": true,
        "facebookAdsReportingEnabled": true,
        "attributionsReportingEnabled": true,
        "membershipEnabled": true,
        "botService": false,
        "agentReportingEnabled": true,
        "socialPlanner": true,
        "bloggingEnabled": true,
        "invoiceEnabled": true,
        "affiliateManagerEnabled": true,
        "contentAiEnabled": true,
        "refundsEnabled": true,
        "recordPaymentEnabled": true,
        "cancelSubscriptionEnabled": true,
        "paymentsEnabled": true,
        "communitiesEnabled": true,
        "exportPaymentsEnabled": true,
        "certificatesEnabled": true,
        "mediaStorageEnabled": true,
        "reportingEnabled": true,
        "adPublishingEnabled": true,
        "adPublishingReadOnly": true,
        "wordpressEnabled": true,
        "customMenuLinkReadOnly": true,
        "customMenuLinkWrite": true,
        "gokollabEnabled": true
    },
    "deleted": false,
    "roles": {
        "type": "agency",
        "role": "user",
        "locationIds": [
            "ezgb5h8dePEYGiwg0WSu",
            "tXFZb9xgj7PbVj2lRkse"
        ]
    },
    "scopes": [
        "adPublishing.readonly",
        "adPublishing.write",
        "blogs.write",
        "calendars.readonly",
        "calendars.write",
        "calendars/events.write",
        "calendars/groups.write",
        "campaigns.write",
        "certificates.readonly",
        "certificates.write",
        "communities.write",
        "contacts.write",
        "contacts/bulkActions.write",
        "contentAI.write",
        "conversations.readonly",
        "conversations.write",
        "conversations/message.readonly",
        "conversations/message.write",
        "custom-menu-link.write",
        "dashboard/stats.readonly",
        "forms.write",
        "funnels.write",
        "gokollab.write",
        "invoices.readonly",
        "invoices.write",
        "invoices/schedule.readonly",
        "invoices/schedule.write",
        "invoices/template.readonly",
        "invoices/template.write",
        "launchpad.readonly",
        "launchpad.write",
        "launchpad/location.readonly",
        "launchpad/location.write",
        "locations/tags.readonly",
        "locations/tags.write",
        "marketing.write",
        "marketing/affiliate.write",
        "medias.readonly",
        "medias.write",
        "membership.write",
        "native-integrations.readonly",
        "native-integrations.write",
        "opportunities.write",
        "opportunities/bulkActions.write",
        "opportunities/leadValue.readonly",
        "payments.write",
        "payments/orders.collectPayment",
        "payments/orders.export",
        "payments/orders.import",
        "payments/orders.readonly",
        "payments/records.write",
        "payments/settings.configureReceipt",
        "payments/settings.configureSubscription",
        "payments/settings.readonly",
        "payments/subscriptions.export",
        "payments/subscriptions.pauseResumeCancel",
        "payments/subscriptions.readonly",
        "payments/subscriptions.sharePaymentMethod",
        "payments/subscriptions.update",
        "payments/subscriptions.write",
        "payments/taxesSettings.configureAutomatic",
        "payments/taxesSettings.manageRates",
        "payments/taxesSettings.readonly",
        "payments/taxesSettings.updateInclusiveExclusive",
        "payments/transactions.export",
        "payments/transactions.import",
        "payments/transactions.readonly",
        "payments/transactions.refund",
        "payments/transactions.viewReceipts",
        "products.bulkActions",
        "products.delete",
        "products.duplicate",
        "products.readonly",
        "products.write",
        "prospecting.readonly",
        "prospecting.write",
        "prospecting/auditReport.write",
        "prospecting/reports.readonly",
        "qrcodes.write",
        "quizzes.write",
        "reporting/adwords.readonly",
        "reporting/agent.readonly",
        "reporting/attributions.readonly",
        "reporting/facebookAds.readonly",
        "reporting/phone.readonly",
        "reporting/reports.readonly",
        "reporting/reports.write",
        "reporting/stats.export",
        "reputation/gbp.write",
        "reputation/listing.write",
        "reputation/review.write",
        "settings.write",
        "snapshots/api.create",
        "snapshots/api.delete",
        "snapshots/api.edit",
        "snapshots/api.push",
        "snapshots/api.readonly",
        "snapshots/api.refresh",
        "socialplanner/account.readonly",
        "socialplanner/account.write",
        "socialplanner/category.readonly",
        "socialplanner/category.write",
        "socialplanner/csv.readonly",
        "socialplanner/csv.write",
        "socialplanner/facebook.readonly",
        "socialplanner/filters.readonly",
        "socialplanner/group.write",
        "socialplanner/hashtag.readonly",
        "socialplanner/hashtag.write",
        "socialplanner/linkedin.readonly",
        "socialplanner/medias.readonly",
        "socialplanner/medias.write",
        "socialplanner/metatag.readonly",
        "socialplanner/notification.readonly",
        "socialplanner/notification.write",
        "socialplanner/oauth.readonly",
        "socialplanner/oauth.write",
        "socialplanner/post.readonly",
        "socialplanner/post.write",
        "socialplanner/recurring.readonly",
        "socialplanner/recurring.write",
        "socialplanner/review.readonly",
        "socialplanner/review.write",
        "socialplanner/rss.readonly",
        "socialplanner/rss.write",
        "socialplanner/search.readonly",
        "socialplanner/setting.readonly",
        "socialplanner/setting.write",
        "socialplanner/snapshot.readonly",
        "socialplanner/snapshot.write",
        "socialplanner/stat.readonly",
        "socialplanner/tag.readonly",
        "socialplanner/tag.write",
        "socialplanner/twitter.readonly",
        "socialplanner/watermarks.readonly",
        "socialplanner/watermarks.write",
        "surveys.write",
        "text-ai-agent-goals.readonly",
        "text-ai-agent-goals.write",
        "text-ai-agent-training.write",
        "text-ai-agents-dashboard.readonly",
        "text-ai-agents.write",
        "triggers.write",
        "users/team-management.readonly",
        "voice-ai-agent-goals.readonly",
        "voice-ai-agent-goals.write",
        "voice-ai-agents.readonly",
        "voice-ai-agents.write",
        "voice-ai-common.readonly",
        "voice-ai-common.write",
        "voice-ai-dashboard.readonly",
        "websites.write",
        "wordpress.read",
        "wordpress.write",
        "workflows.write"
    ],
    "scopesAssignedToOnly": [],
    "freshdeskContactId": "155016626982",
    "totpEnabled": false,
    "lcPhone": {
        "ezgb5h8dePEYGiwg0WSu": "",
        "tXFZb9xgj7PbVj2lRkse": ""
    },
    "traceId": "6378310e-ca47-477e-b8a2-ccfcd483248b"
}

Product Area

users

📋 Use Case

We need this field to:

• Get to know whether an Agency user is restricted to some specific sub-accounts or can access all of them.

🚨 Why Should This Be Prioritized?

This should be prioritized because it is blocking our integration of user-level permissions to specific sub-accounts.

🧠 Additional Context

This field is coming in the Search Users endpoint but is missing in the Get User endpoint.

[github-actions]

✅ Issue processed successfully!

Your issue has been reviewed and assigned to the appropriate team.

[garvjeet-highlevel]

Fixed: restrictSubAccount now included in Get User endpoint response

Issue resolved

The restrictSubAccount field is now included in the GET /users/:userId response.

Response structure:
The field appears at the root level of the response:

{
  "id": "...",
  "name": "...",
  "roles": {
    "type": "agency",
    "role": "user",
    "locationIds": [...],
    "restrictSubAccount": true
  },
  ...
}

The response now includes restrictSubAccount as a boolean indicating whether the user is restricted to specific sub-accounts.

Here is the update documentation link: https://marketplace.gohighlevel.com/docs/ghl/users/get-user

Thanks for reporting this. If you notice any issues, let us know.