List User Groups

HTTP Request

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

Example Response

{
"count": 0,
"next": "http://www.example.com",
"previous": "http://www.example.com",
"results": [
{
"id": 0,
"site": 0,
"created": "2021-03-01T14:10:07.502Z",
"modified": "2021-03-01T14:10:07.502Z",
"deleted": "2021-03-01T14:10:07.502Z",
"uuid": "770bba28-9f80-4d40-9c51-6e022364af91",
"source_ref": "string",
"name": "string",
"active": false,
"apply_to_all_branches": false,
"super_access": false,
"branches_add": false,
"branches_update": false,
"teams_add": false,
"teams_update": false,
"leads_view": false,
"leads_add": false,
"leads_update": false,
"leads_archive": false,
"listings_residential_for_sale_view": false,
"listings_residential_for_sale_add": false,
"listings_residential_for_sale_update": 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_to_let_view": false,
"listings_residential_to_let_add": false,
"listings_residential_to_let_update": 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_commercial_for_sale_view": false,
"listings_commercial_for_sale_add": false,
"listings_commercial_for_sale_update": 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_to_let_view": false,
"listings_commercial_to_let_add": false,
"listings_commercial_to_let_update": 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_holiday_view": false,
"listings_holiday_add": false,
"listings_holiday_update": 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_projects_view": false,
"listings_projects_add": false,
"listings_projects_update": false,
"listings_projects_can_select_featured": false,
"listings_projects_select_newsletter_featured": false,
"listings_projects_select_agent_newsletter_featured": 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,
"designations_add": false,
"races_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,
"news_view": false,
"news_add": false,
"news_categories_add": false,
"news_update": false,
"newsletter_send": false,
"newsletter_view": false,
"offers_view": false,
"mailing_list_add": false,
"mailing_list_update": false,
"mailing_list_view": false,
"contacts_view": false,
"contacts_add": false,
"contacts_update": false,
"contact_types_add": false,
"profiles_view": false,
"profiles_add": false,
"profiles_update": false,
"documents_add": false,
"documents_delete": false,
"documents_update": false,
"branches_view_notes": false,
"branches_add_notes": 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_view_notes": false,
"users_add_notes": false,
"users_export": false,
"teams_view_notes": false,
"teams_add_notes": false,
"teams_reports": false,
"teams_export": false,
"user_groups_export": 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_view_notes": false,
"listings_residential_add_notes": 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_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_view_notes": false,
"listings_commercial_add_notes": 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_projects_view_own": false,
"listings_projects_update_own": false,
"listings_projects_view_notes": false,
"listings_projects_add_notes": 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_holiday_view_own": false,
"listings_holiday_update_own": false,
"listings_holiday_view_notes": false,
"listings_holiday_add_notes": 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,
"contacts_view_own": false,
"contacts_update_own": false,
"contacts_associated_agents_view": false,
"contacts_associated_agents_update": false,
"contacts_view_notes": false,
"contacts_add_notes": false,
"contacts_view_team": false,
"contacts_update_team": false,
"contacts_export": false,
"contacts_reports": false,
"leads_view_own": false,
"leads_update_own": false,
"leads_contacts_associated_agents_view": false,
"leads_contacts_associated_agents_update": false,
"leads_view_notes": false,
"leads_add_notes": false,
"leads_view_team": false,
"leads_update_team": false,
"leads_export": false,
"leads_reports": false,
"leads_sms_report": false,
"profiles_view_own": false,
"profiles_update_own": false,
"profiles_contacts_associated_agents_view": false,
"profiles_contacts_associated_agents_update": false,
"profiles_view_notes": false,
"profiles_add_notes": false,
"profiles_export": false,
"profiles_reports": 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_view_notes": false,
"mailing_list_add_notes": false,
"mailing_list_import": false,
"mailing_list_export": false,
"mailing_list_reports": false,
"syndication_listings_can_sync": false,
"syndication_branches_can_sync": false,
"syndication_users_can_sync": false,
"documents_export": false,
"documents_view_notes": false,
"documents_add_notes": false,
"cms_export": false,
"cms_view_notes": false,
"cms_add_notes": false,
"news_export": false,
"news_view_notes": false,
"news_add_notes": false,
"insights_view": false,
"offers_view_own": false,
"newsletter_report": false,
"location_profiles_export": false,
"statistics": 0
}
]
}

NameDescription

order_by

string

Which field to use when ordering the results.

offset

integer

Offset for Pagination

limit

integer

Page Size

Responses

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