Search User Groups

HTTP Request

POSThttps://staging.api-gw.propdata.net/users/api/v1/groups/search/

Example Response

{
"count": 0,
"next": "http://www.example.com",
"previous": "http://www.example.com",
"results": [
{
"id": 0,
"site": 0,
"created": "2024-03-28T13:31:07.958Z",
"modified": "2024-03-28T13:31:07.958Z",
"deleted": "2024-03-28T13:31:07.958Z",
"uuid": "770bba28-9f80-4d40-9c51-6e022364af91",
"source_ref": "string",
"name": "string",
"active": false,
"apply_to_all_branches": false,
"super_access": false,
"franchises_view": false,
"franchises_add": false,
"franchises_update": false,
"franchises_view_notes": false,
"franchises_add_notes": false,
"branches_add": false,
"branches_update": false,
"branches_view_notes": false,
"branches_add_notes": false,
"branches_archive": false,
"teams_add": false,
"teams_update": false,
"teams_view_notes": false,
"teams_add_notes": false,
"leads_view": false,
"leads_add": false,
"leads_update": false,
"leads_delete": false,
"leads_view_notes": false,
"leads_add_notes": false,
"listings_residential_for_sale_view": false,
"listings_residential_for_sale_add": false,
"listings_residential_for_sale_update": false,
"listings_residential_for_sale_generate_seller_feedback_report": false,
"listings_residential_for_sale_can_select_featured": false,
"listings_residential_for_sale_select_newsletter_featured": false,
"listings_residential_for_sale_select_agent_newsletter_featured": false,
"listings_residential_for_sale_auction": false,
"listings_residential_to_let_view": false,
"listings_residential_to_let_add": false,
"listings_residential_to_let_update": false,
"listings_residential_to_let_generate_seller_feedback_report": false,
"listings_residential_to_let_can_select_featured": false,
"listings_residential_to_let_select_newsletter_featured": false,
"listings_residential_to_let_select_agent_newsletter_featured": false,
"listings_residential_for_sale_feed_to_portals": false,
"listings_residential_to_let_feed_to_portals": false,
"listings_residential_for_sale_property_permit": false,
"listings_residential_to_let_property_permit": false,
"listings_residential_view_notes": false,
"listings_residential_add_notes": false,
"listings_commercial_for_sale_view": false,
"listings_commercial_for_sale_add": false,
"listings_commercial_for_sale_update": false,
"listings_commercial_for_sale_generate_seller_feedback_report": false,
"listings_commercial_for_sale_can_select_featured": false,
"listings_commercial_for_sale_select_newsletter_featured": false,
"listings_commercial_for_sale_select_agent_newsletter_featured": false,
"listings_commercial_for_sale_auction": false,
"listings_commercial_to_let_view": false,
"listings_commercial_to_let_add": false,
"listings_commercial_to_let_update": false,
"listings_commercial_to_let_generate_seller_feedback_report": false,
"listings_commercial_to_let_can_select_featured": false,
"listings_commercial_to_let_select_newsletter_featured": false,
"listings_commercial_to_let_select_agent_newsletter_featured": false,
"listings_commercial_for_sale_feed_to_portals": false,
"listings_commercial_to_let_feed_to_portals": false,
"listings_commercial_for_sale_property_permit": false,
"listings_commercial_to_let_property_permit": false,
"listings_commercial_view_notes": false,
"listings_commercial_add_notes": false,
"listings_holiday_view": false,
"listings_holiday_add": false,
"listings_holiday_update": false,
"listings_holiday_generate_seller_feedback_report": false,
"listings_holiday_can_select_featured": false,
"listings_holiday_select_newsletter_featured": false,
"listings_holiday_select_agent_newsletter_featured": false,
"listings_holiday_feed_to_portals": false,
"listings_holiday_view_notes": false,
"listings_holiday_add_notes": false,
"listings_projects_view": false,
"listings_projects_add": false,
"listings_projects_update": false,
"listings_projects_generate_seller_feedback_report": false,
"listings_projects_can_select_featured": false,
"listings_projects_select_newsletter_featured": false,
"listings_projects_select_agent_newsletter_featured": false,
"listings_projects_view_notes": false,
"listings_projects_add_notes": false,
"settings_view": false,
"settings_update": false,
"user_groups_view": false,
"user_groups_add": false,
"user_groups_update": false,
"users_add": false,
"users_update": false,
"user_personal_details_view": false,
"users_view_notes": false,
"users_add_notes": false,
"designations_add": false,
"races_add": false,
"franchises_regions_add": false,
"franchises_divisions_add": false,
"users_email_stationery": false,
"location_profiles_view": false,
"location_profiles_add": false,
"location_profiles_update": false,
"cms_view": false,
"cms_add": false,
"cms_update": false,
"cms_view_notes": false,
"cms_add_notes": false,
"news_view": false,
"news_add": false,
"news_categories_add": false,
"news_update": false,
"news_view_notes": false,
"news_add_notes": false,
"newsletter_send": false,
"newsletter_view": false,
"offers_view": false,
"offers_add": false,
"offers_update": false,
"offers_view_notes": false,
"offers_add_notes": false,
"deals_view": false,
"deals_add": false,
"deals_update": false,
"deals_view_notes": false,
"deals_add_notes": false,
"mailing_list_add": false,
"mailing_list_update": false,
"mailing_list_view": false,
"mailing_list_delete": false,
"mailing_list_view_notes": false,
"mailing_list_add_notes": false,
"contacts_view": false,
"contacts_add": false,
"contacts_update": false,
"contacts_delete": false,
"contact_types_add": false,
"contacts_view_notes": false,
"contacts_add_notes": false,
"profiles_view": false,
"profiles_add": false,
"profiles_update": false,
"profiles_delete": false,
"profiles_view_notes": false,
"profiles_add_notes": false,
"referrals_view": false,
"referrals_add": false,
"referrals_update": false,
"referrals_view_notes": false,
"referrals_add_notes": false,
"documents_view": false,
"documents_add": false,
"documents_delete": false,
"documents_update": false,
"documents_view_notes": false,
"documents_add_notes": false,
"tags_own_add": false,
"tags_own_update": false,
"tags_own_delete": false,
"tags_branch_add": false,
"tags_branch_update": false,
"tags_branch_delete": false,
"tags_agency_add": false,
"tags_agency_update": false,
"tags_agency_delete": false,
"valuation_view": false,
"valuation_add": false,
"valuation_update": false,
"valuation_approve": false,
"valuation_delete": false,
"snippets_add": false,
"snippets_update": false,
"snippets_delete": false,
"canvassing_view": false,
"canvassing_add": false,
"canvassing_update": false,
"vehicles_delete": false,
"vehicles_add": false,
"vehicles_update": false,
"applications_view": false,
"applications_add": false,
"applications_update": false,
"applications_delete": false,
"franchises_view_own": false,
"franchises_update_own": false,
"franchises_export": false,
"franchises_reports": false,
"branches_export": false,
"branches_reports": false,
"branches_update_serviced_locations": false,
"users_update_own": false,
"users_email_stationery_own": false,
"users_reports": false,
"users_export": false,
"users_delete": false,
"users_update_serviced_locations": false,
"teams_reports": false,
"teams_export": false,
"teams_delete": false,
"user_groups_export": false,
"user_groups_delete": false,
"listings_residential_for_sale_view_own": false,
"listings_residential_for_sale_update_own": false,
"listings_residential_to_let_view_own": false,
"listings_residential_to_let_update_own": false,
"listings_residential_for_sale_export": false,
"listings_residential_to_let_export": false,
"listings_residential_for_sale_reports": false,
"listings_residential_to_let_reports": false,
"listings_residential_for_sale_view_team": false,
"listings_residential_for_sale_update_team": false,
"listings_residential_to_let_view_team": false,
"listings_residential_to_let_update_team": false,
"listings_residential_for_sale_display_on_website": false,
"listings_residential_to_let_display_on_website": false,
"listings_residential_disallow_custom_ref_numbers": false,
"listings_commercial_for_sale_view_own": false,
"listings_commercial_for_sale_update_own": false,
"listings_commercial_to_let_view_own": false,
"listings_commercial_to_let_update_own": false,
"listings_commercial_for_sale_reports": false,
"listings_commercial_to_let_reports": false,
"listings_commercial_for_sale_export": false,
"listings_commercial_to_let_export": false,
"listings_commercial_for_sale_update_team": false,
"listings_commercial_for_sale_view_team": false,
"listings_commercial_to_let_update_team": false,
"listings_commercial_to_let_view_team": false,
"listings_commercial_for_sale_display_on_website": false,
"listings_commercial_to_let_display_on_website": false,
"listings_commercial_disallow_custom_ref_numbers": false,
"listings_projects_view_own": false,
"listings_projects_update_own": false,
"listings_projects_export": false,
"listings_projects_reports": false,
"listings_projects_view_team": false,
"listings_projects_update_team": false,
"listings_projects_display_on_website": false,
"listings_projects_disallow_custom_ref_numbers": false,
"listings_holiday_view_own": false,
"listings_holiday_update_own": false,
"listings_holiday_export": false,
"listings_holiday_reports": false,
"listings_holiday_view_team": false,
"listings_holiday_update_team": false,
"listings_holiday_display_on_website": false,
"listings_holiday_disallow_custom_ref_numbers": false,
"contacts_view_own": false,
"contacts_view_unassigned": false,
"contacts_update_own": false,
"contacts_associated_agents_view": false,
"contacts_associated_agents_update": false,
"contacts_view_team": false,
"contacts_update_team": false,
"contacts_export": false,
"contacts_reports": false,
"contacts_delete_own": false,
"leads_view_own": false,
"leads_view_unassigned": false,
"leads_update_own": false,
"leads_contacts_associated_agents_view": false,
"leads_contacts_associated_agents_update": false,
"leads_view_team": false,
"leads_update_team": false,
"leads_export": false,
"leads_reports": false,
"leads_sms_report": false,
"leads_delete_own": false,
"profiles_view_own": false,
"profiles_view_unassigned": false,
"profiles_update_own": false,
"profiles_contacts_associated_agents_view": false,
"profiles_contacts_associated_agents_update": false,
"profiles_export": false,
"profiles_reports": false,
"profiles_delete_own": false,
"mailing_list_update_own": false,
"mailing_list_view_own": false,
"mailing_list_contacts_associated_agents_view": false,
"mailing_list_contacts_associated_agents_update": false,
"mailing_list_import": false,
"mailing_list_export": false,
"mailing_list_reports": false,
"mailing_list_delete_own": false,
"referrals_view_own": false,
"referrals_update_own": false,
"referrals_reports": false,
"referrals_export": false,
"referrals_can_add": false,
"referrals_can_accept": false,
"syndication_listings_can_sync": false,
"syndication_branches_can_sync": false,
"syndication_users_can_sync": false,
"documents_export": false,
"cms_export": false,
"news_export": false,
"insights_view": false,
"newsletter_report": false,
"location_profiles_export": false,
"sales_targets_user_edit": false,
"sales_targets_branch_edit": false,
"valuation_view_own": false,
"valuation_update_own": false,
"valuation_export": false,
"valuation_reports": false,
"valuation_delete_own": false,
"canvassing_view_own": false,
"canvassing_update_own": false,
"canvassing_export": false,
"canvassing_reports": false,
"offers_view_own": false,
"offers_update_own": false,
"offers_export": false,
"offers_reports": false,
"deals_view_own": false,
"deals_update_own": false,
"deals_export": false,
"deals_reports": false,
"applications_view_own": false,
"applications_update_own": false,
"applications_export": false,
"applications_reports": false,
"applications_delete_own": false,
"applications_credit_check": false,
"statistics": 0
}
]
}

NameDescription

filters

required

object

Filters

Responses

200
400 Bad request body
403 You do not have permission to perform this action
500 Internal server error
503 This website is not active