APappdirect
User

List all users

Changed on

Retrieves all marketplace users

get/account/v2/users

Request

Query parameters

namestring

First or last name of user

emailstring

Email address of user

externalIdstring

External ID of user

usernamestring

User name of user

companyMembershipRolestring

If specified, returns only users with the specified role, one of the following values: ROLE_CHANNEL_ADMIN (Marketplace Manager), ROLE_CHANNEL_PRODUCT_SUPPORT (Product Support), ROLE_SALES_SUPPORT (Sales Support), ROLE_RESELLER_MANAGER (Reseller Manager), ROLE_RESELLER (Reseller), ROLE_CHANNEL_SUPPORT (Customer Support), ROLE_SYS_ADMIN (Company Admin), ROLE_BILLING_ADMIN (Billing Admin), ROLE_DEVELOPER (Developer)

custom.customAttributeNamestring

Accepts a notIn filter in the form of ?custom.customAttributeName=notIn(customAttributeValue1, customAttributeValue2, customAttributeValueN...) that excludes users with matching values. Before you can use the filter, you must first create "Text" type user custom attributes in the user interface. You can then specify the custom attribute name and values as customAttributeName and customAttributeValueN. See https://help.appdirect.com/appmarket/Default.htm#MarketplaceManager/MM-Setgscustui-create-attribs.html.

lastModifiednumber

The date on which the user was last modified, in UNIX Epoch milliseconds

pageinteger

Zero-based page index

sizeinteger

Number of results per page to return

sortField'DATE' | 'FIRST_NAME' | 'LAST_NAME'

The property to sort by

sortOrder'ASC' | 'DESC'

Ordering type

includeCustomAttributesboolean

Optional. Default is true. When set to true, user custom attributes are included in the API response. When set to false, user custom attributes are not included.

Response

Success

Example response

{
  "links": [],
  "content": [
    {
      "uuid": "2f93cb24-f7b9-433f-875e-bb0dd9b0f1c1",
      "email": "john.lee@company0093957321.com",
      "userName": "john.lee",
      "firstName": "John",
      "lastName": "Lee",
      "picture": "http://appdirect/profilePics/img6839249962619189663.png?32339267f9f00643fd18373adf580743",
      "activated": true,
      "allowLogin": true,
      "ldapId": "1",
      "boostUser": null,
      "creationDate": 1398896238000,
      "externalId": "b34974b2-f5d6-4326-9859-5247dc42ee60",
      "idpUuid": "1d37bace-f4cf-11e6-af80-22000a9513f7",
      "locale": "en_US",
      "lastSuccessfulLogin": 1543268078000,
      "openId": "http://appdirect/openid/id/2f93cb24-f7b9-433f-875e-bb0dd9b0f1c1",
      "roles": [
        "ROLE_USER"
      ],
      "currency": "USD",
      "customAttributes": [
        {
          "name": "C5125859",
          "attributeType": "TEXT",
          "label": "Commission_Payout_ID",
          "hint": "commission_hint",
          "value": "t1"
        },
        {
          "name": "allow_credit_card",
          "attributeType": "MULTISELECT",
          "label": "Allow Credit Card",
          "hint": "Allows credit card payments and enables credit card fields",
          "valueKeys": []
        },
        {
          "name": "C5457097",
          "attributeType": "TEXT",
          "label": "C5457097",
          "hint": "",
          "value": "abcd"
        }
      ],
      "metadata": {
        "apsUid": null
      },
      "links": [
        {
          "rel": "self",
          "href": "http://appdirect/api/account/v2/users/2f93cb24-f7b9-433f-875e-bb0dd9b0f1c1"
        },
        {
          "rel": "memberships",
          "href": "http://appdirect/api/account/v2/users/2f93cb24-f7b9-433f-875e-bb0dd9b0f1c1/memberships"
        }
      ]
    },
    {
      "uuid": "8db1c051-73a6-4ff8-a0ce-bc1d80d0f156",
      "email": "jane.lee@company1151609035.com",
      "userName": "jane.lee",
      "firstName": "Jane",
      "lastName": "Lee",
      "picture": null,
      "activated": true,
      "allowLogin": true,
      "ldapId": null,
      "boostUser": null,
      "creationDate": 1498080462000,
      "externalId": "47ac42db-162e-11e7-af80-22000a9513f7",
      "locale": "en_US",
      "lastSuccessfulLogin": 1542820131000,
      "openId": "http://appdirect/openid/id/8db1c051-73a6-4ff8-a0ce-bc1d80d0f156",
      "roles": [
        "ROLE_USER"
      ],
      "currency": "USD",
      "customAttributes": [],
      "metadata": {
        "apsUid": null
      },
      "links": [
        {
          "rel": "self",
          "href": "http://appdirect/api/account/v2/users/8db1c051-73a6-4ff8-a0ce-bc1d80d0f156"
        },
        {
          "rel": "memberships",
          "href": "http://appdirect/api/account/v2/users/8db1c051-73a6-4ff8-a0ce-bc1d80d0f156/memberships"
        }
      ]
    }
  ],
  "page": {
    "size": 50,
    "totalElements": 2,
    "totalPages": 1,
    "number": 0
  }
}

Changes