API Reference
Start typing to search…

List all users

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

Parameters

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 solution provider account based on the parameters submitted. Returns an error if an invalid enum is submitted.

Example request

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

Example response

{
  "@page": "1",
   ...
  "Users": [
    {
      "Id": "I-1234567",
      "FirstName": "Wile",
      "LastName": "Coyote",
      "Username": "WileECoyote",
      "State": "ACTIVE",
      "Language": "en_US",
      "AccessRights": [
        {
          "Role": "Account Administration",
          "Permissions": [
            "MANAGE_ACCOUNT_INFO",
            "MANAGE_DIRECTORY_INFO",
            "RUN_USAGE_REPORTS",
            "MANAGE_MASTER_TERMS"
          ]
        },
        {
          "Role": "Finance and Billing",
          "Permissions": [
            "MANAGE_FINANCIAL_SETTINGS",
            "VIEW_FINANCIALS",
            "RUN_FINANCIAL_TRANSACTION_REPORTS"
          ]
        },
        {
          "Role": "Account Manager",
          "Permissions": [
            "MANAGE_CLIENT_ACCOUNT",
            "RUN_CLIENT_SPECIFIC_REPORTS",
            "APPROVE_AND_MANAGE_CAMPAIGNS",
            "APPROVE_AND_MANAGE_PARTNERS"
          ]
        },
        {
          "Role": "Technical",
          "Permissions": [
            "MANAGE_TECHNICAL_SETTINGS"
          ]
        },
        {
          "Role": "Agency Analyst",
          "Permissions": [
            "RUN_USAGE_REPORTS",
            "RUN_AGENCY_REPORTS"
          ]
        }
      ],
      "JoinedDate": "2019-10-09T00:02:45-07:00",
      "DateLastUpdated": "2021-04-22T23:21:23-07:00",
      "LastUpdatedBy": "MissPiggy",
      "CreatedBy": "RoadRunner",
      "Uri": "/Agencies/<AccountSID>/Users/I-1234567"
    },
    {
      ...
    }
  ]
}