List all users

Lists all users that have access to your brand account. The users are sorted by join date, with the first user to join appearing first.

Parameters


Name optional

Filters the list of users based on the provided URL-encoded string. If the provided value fully or partially matches a Firstname, Lastname, or Username, the matching user object will be returned.


State optional

Filters the list of users based on a provided enum value.

Possible enum values
ACTIVE
PENDING
INVITED

Returns


Returns a list of users that have access to your brand account based on the parameters submitted. Returns an error if an invalid enum is submitted.

Example request


curl 'https://api.impact.com/Advertisers/<AccountSID>/Users' \
  -X GET \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json' \
  -d 'Name=John' \
  -d 'State=ACTIVE' \
  -G

Example response


{
  "@page": "1",
   ...
  "Users": [
    {
      "Id": "I-1234567",
      "FirstName": "Wile",
      "LastName": "Coyote",
      "Username": "WileECoyote",
      "Type": "MEMBER",
      "State": "ACTIVE",
      "Language": "en_US",
      "ProductRoles": [
        {
          "Product":"RADIUS",
          "AccessibleCampaigns":["10123"],
          "Role":"ACCOUNT_ADMINISTRATOR"
        }
      ],
      "JoinedDate": "2020-04-29T16:24:13-07:00",
      "DateLastUpdated": "2020-12-09T08:34:06-08:00",
      "LastUpdatedBy": "WileECoyote",
      "CreatedBy": "RoadRunner",
      "Uri": "/Advertisers/<AccountSID>/Users/I-2320266"
    },
    {
      ...
    }
  ]
}