Users

Endpoints for listing and retrieving partner-account users.

List all users

get

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

Authorizations

basicAuth

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

Query parameters

NamestringOptional

Filter by a URL-encoded string matching FirstName, LastName, or Username.

Statestring · enumOptional

The account state of the user.

Possible values:

Responses

200

A list of users that have access to your partner account.

application/json

get

/Mediapartners/{AccountSID}/Users

curl

curl -L \
  --url 'https://api.impact.com/Mediapartners/{AccountSID}/Users' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: application/json'

200

A list of users that have access to your partner account.

{
  "Users": [
    {
      "Id": "I-1139074",
      "FirstName": "Hazel",
      "LastName": "Nutt",
      "Username": "hnutt",
      "State": "ACTIVE",
      "Language": "en_US",
      "AccessRights": [
        {
          "Role": "Creative Management",
          "Permissions": [
            "MANAGE_DIRECTORY_INFO"
          ]
        }
      ],
      "JoinedDate": "2020-04-29T16:24:13-07:00",
      "DateLastUpdated": "2020-12-09T08:34:06-08:00",
      "LastUpdatedBy": "hnutt",
      "CreatedBy": "rbanks",
      "Uri": "/Mediapartners/<AccountSID>/Users/I-1139074"
    }
  ]
}

Retrieve a specific user

get

Retrieves a single account user by their unique Id.

Authorizations

basicAuth

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

IdstringRequired

Unique identifier for the account user, in I-XXXXXXX format.

Responses

200

Successful retrieval of the user object.

application/json

IdstringOptional

Unique identifier for the account user, in I-XXXXXXX format. The numeric portion is what the Partner Identity Verification API expects.

Example: I-1139074

FirstNamestringOptional

The user's first name.

Example: Hazel

LastNamestringOptional

The user's last name.

Example: Nutt

UsernamestringOptional

The user's impact.com login username.

Example: hnutt

Statestring · enumOptional

The account state of the user.

Possible values:

LanguagestringOptional

The user's account language preference (locale code).

Example: en_US

JoinedDatestring · date-timeOptional

Date and time the user joined the partner account (ISO 8601).

Example: 2020-04-29T16:24:13-07:00

DateLastUpdatedstring · date-timeOptional

Date and time the user's information was last updated (ISO 8601).

Example: 2020-12-09T08:34:06-08:00

LastUpdatedBystringOptional

Username of the user that last updated this account user.

Example: hnutt

CreatedBystringOptional

Username of the user that created this account user.

Example: rbanks

UristringOptional

API resource path for this user.

Example: /Mediapartners/<AccountSID>/Users/I-1139074

404

No user exists with the supplied Id.

get

/Mediapartners/{AccountSID}/Users/{Id}

curl

curl -L \
  --url 'https://api.impact.com/Mediapartners/{AccountSID}/Users/{Id}' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: application/json'

{
  "Id": "I-1139074",
  "FirstName": "Hazel",
  "LastName": "Nutt",
  "Username": "hnutt",
  "State": "ACTIVE",
  "Language": "en_US",
  "AccessRights": [
    {
      "Role": "Creative Management",
      "Permissions": [
        "MANAGE_DIRECTORY_INFO"
      ]
    }
  ],
  "JoinedDate": "2020-04-29T16:24:13-07:00",
  "DateLastUpdated": "2020-12-09T08:34:06-08:00",
  "LastUpdatedBy": "hnutt",
  "CreatedBy": "rbanks",
  "Uri": "/Mediapartners/<AccountSID>/Users/I-1139074"
}