WhatConverts
API for Developers
API for Developers
Join 20,000+ other marketers and start getting marketing clarity

Subscribe to our newsletter and get proven marketing strategies for growing your business.

    Suggested Blog Articles
    SEO Content Planners: Comparing SEMrush vs Ahrefs
    Lead Tracking SEO Content Planners: Comparing SEMrush vs Ahrefs

    Last update on Aug 31, 2020

    Roles

    The roles resource allows you to retrieve user roles.

    Roles Instance Resources

    MethodEndpointDescription
    GET/api/v1/rolesGet a paginated list of details for all roles.
    GET/api/v1/roles/{role_id}Get details about a single role.

    Get All Roles

    Get a paginated list of details for all roles.

    Resource Details

    MethodEndpoint
    GEThttps://app.whatconverts.com/api/v1/roles

    Supported Parameters

    ParameterTypeDescriptionRequired
    roles_per_pagenumberNumber of roles to return for this request (default 25, maximum 250).No
    page_numbernumberPage number to return for this request.No
    orderstringOrder in which to return the roles by name; (default) asc or desc.No
    role_typestringRole type to return for this request; (default) master_account or account user.No

    Response Details

    ParameterTypeDescription
    roles_per_pagenumberThe number of roles returned in the request.
    page_numbernumberThe current page number in the request.
    total_pagesnumberThe total amount of pages available in the request.
    total_rolesnumberThe total amount of roles available in the request.
    rolesarrayContains all the requested roles.
    role_idnumberUnique identifier for the role.
    role_typestringThe type of role. master_account_role or account_role
    role_namestringThe name of the role.

    Example Response

        {
          "page_number": 1,
          "roles_per_page": 25,
          "total_pages": 2,
          "total_roles": 45,
          "roles": [
            {
              "role_id": 42390328,
              "role_type": "master_account_role",
              "role_name": "Administrator"
            },
            ...
          ]
        }
    

    Get Single Role

    Get details for specific role.

    Resource Details

    MethodEndpoint
    GEThttps://app.whatconverts.com/api/v1/roles/{role_id}

    Supported Parameters

    No supported parameters.

    Response Details

    ParameterTypeDescription
    roles_per_pagenumberThe number of roles returned in the request.
    page_numbernumberThe current page number in the request.
    total_pagesnumberThe total amount of pages available in the request.
    total_rolesnumberThe total amount of roles available in the request.
    rolesarrayContains all the requested roles.
    role_idnumberUnique identifier for the role.
    role_typestringThe type of role. master_account_role or account_role
    role_namestringThe name of the role.
    lead_notificationsbooleanIf the role is able to receive lead notifications.
    permissionsobjectPermissions for this role.
    integrationsstringPermissions for integrations. none, view or edit.
    leadsstringPermissions for leads. none, view or edit.
    profilesstringPermissions for profiles. none, view or edit.
    reportsstringPermissions for reports. none, view or edit.
    settingsstringPermissions for settings. none, view or edit.
    trackingstringPermissions for tracking. none, view or edit.
    accountsstringPermissions for accounts. none, view or edit. Applicable to master_account roles.
    billingstringPermissions for billing. none, view or edit. Applicable to master_account roles.
    securitystringPermissions for security. none, view or edit. Applicable to master_account roles.
    usersstringPermissions for users. none, view or edit. Applicable to master_account roles.

    Example Response

        {
          "page_number": 1,
          "roles_per_page": 1,
          "total_pages": 1,
          "total_roles": 1,
          "users": [
            {
              "role_id": 42390328,
              "role_type": "master_account_role",
              "role_name": "Administrator"
              "lead_notifications": true,
              "permissions": {
                "integrations": "edit",
                "leads": "edit",
                "profiles": "edit",
                "reports": "edit",
                "settings": "edit",
                "tracking": "edit",
                "accounts": "edit",
                "billing": "edit",
                "security": "edit",
                "users": "edit"
              }
            }
          ]
        }
    
    Get a FREE presentation of WhatConverts

    One of our marketing experts will give you a full presentation of how WhatConverts can help you grow your business.

    Schedule a Demo
    Whatconverts Features for your Business
    Leads by Day
    Analytics & Insights Leads by Day

    See which days of the week drive the most business, and how this changes over time.

    Call Flows - Post Call Qualification
    Lead Tracking Call Flows - Post Call Qualification

    Allow your people to qualify incoming calls as leads as soon as the call ends.

    Assign Sales Value
    Lead Management Assign Sales Value

    Calculate marketing ROI.

    Call Flows - Custom IVR Menu
    Lead Tracking Call Flows - Custom IVR Menu

    Your callers will hear a menu of options to direct their call to the proper connection.

    Join 20,000+ other marketers and start getting marketing clarity

    Subscribe to our newsletter and get proven marketing strategies for growing your business.

      Suggested Blog Articles
      ready to get marketing clarity?

      Grow your business with WhatConverts

      14 days free trial Easy setup Dedicated support
      G2 Users Love Us Badge
      G2 High Performer Badge
      G2 High Performer Small Business Badge
      G2 Momentum Leader Badge
      G2 High Performer Europe Badge