# Users

Endpoints for listing and retrieving partner-account users.

## List all users

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

```json
{"openapi":"3.1.0","info":{"title":"Partner Users API","version":"16"},"tags":[{"name":"Users","description":"Endpoints for listing and retrieving partner-account users."}],"servers":[{"url":"https://api.impact.com","description":"Production server"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"schemas":{"UserState":{"type":"string","enum":["ACTIVE","PENDING","INVITED"],"description":"The account state of the user."},"User":{"type":"object","properties":{"Id":{"type":"string","description":"Unique identifier for the account user, in `I-XXXXXXX` format. The numeric portion is what the Partner Identity Verification API expects."},"FirstName":{"type":"string","description":"The user's first name."},"LastName":{"type":"string","description":"The user's last name."},"Username":{"type":"string","description":"The user's impact.com login username."},"State":{"$ref":"#/components/schemas/UserState"},"Language":{"type":"string","description":"The user's account language preference (locale code)."},"AccessRights":{"type":"array","description":"Roles and the specific permissions granted under each role.","items":{"$ref":"#/components/schemas/AccessRight"}},"JoinedDate":{"type":"string","format":"date-time","description":"Date and time the user joined the partner account (ISO 8601)."},"DateLastUpdated":{"type":"string","format":"date-time","description":"Date and time the user's information was last updated (ISO 8601)."},"LastUpdatedBy":{"type":"string","description":"Username of the user that last updated this account user."},"CreatedBy":{"type":"string","description":"Username of the user that created this account user."},"Uri":{"type":"string","description":"API resource path for this user."}}},"AccessRight":{"type":"object","properties":{"Role":{"type":"string","enum":["Advertiser Management","Finance","Technical","Creative Management","Account Administration"],"description":"The functional area the granted permissions apply to."},"Permissions":{"type":"array","description":"The specific permissions granted to the user under this role.","items":{"type":"string","enum":["MANAGE_DIRECTORY_INFO","RUN_USAGE_REPORTS","MANAGE_ACCOUNT_INFO","MANAGE_PUBLISHER_PACKAGES","MESSAGING","NEGOTIATE_AGREEMENTS","REQUEST_CAP_EXTENSIONS_AND_AGREEMENT_EXCEPTIONS","SEND_MARKETING_MSG_TO_BRAND","VIEW_BRAND_INFO","APPLY_TO_CAMPAIGN","RUN_ACTION_AND_PERFORMANCE_REPORTS","REQUEST_CUSTOM_ADS","APPROVE_CREATIVE_AND_DUB_HOUSE_EXPENSES","MANAGE_CREATIVES","RUN_CREATIVE_REPORTS","GET_AD_HTML","VIEW_FINANCIALS","MANAGE_FINANCIAL_SETTINGS","RUN_FINANCIAL_TRANSACTION_REPORTS","WEBSERVICES_INTEGRATION","EVENT_CALLBACK_INTEGRATION","RUN_TECHNICAL_REPORTS","TRACKER_AND_BRAND_URL_INTEGRATIONS","ITEM_LIST_INTEGRATIONS"]}}}}}},"paths":{"/Mediapartners/{AccountSID}/Users":{"get":{"operationId":"listUsers","tags":["Users"],"summary":"List all users","description":"Lists all users that have access to your partner account, sorted by join date with the first user to join appearing first.","parameters":[{"name":"AccountSID","in":"path","required":true,"schema":{"type":"string"},"description":"Unique identifier for the partner account."},{"name":"Name","in":"query","required":false,"description":"Filter by a URL-encoded string matching `FirstName`, `LastName`, or `Username`.","schema":{"type":"string"}},{"name":"State","in":"query","required":false,"description":"Filter the list of users by their account state.","schema":{"$ref":"#/components/schemas/UserState"}}],"responses":{"200":{"description":"A list of users that have access to your partner account.","content":{"application/json":{"schema":{"type":"object","properties":{"Users":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}}}}}}}}}
```

## Retrieve a specific user

> Retrieves a single account user by their unique Id.

```json
{"openapi":"3.1.0","info":{"title":"Partner Users API","version":"16"},"tags":[{"name":"Users","description":"Endpoints for listing and retrieving partner-account users."}],"servers":[{"url":"https://api.impact.com","description":"Production server"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"schemas":{"User":{"type":"object","properties":{"Id":{"type":"string","description":"Unique identifier for the account user, in `I-XXXXXXX` format. The numeric portion is what the Partner Identity Verification API expects."},"FirstName":{"type":"string","description":"The user's first name."},"LastName":{"type":"string","description":"The user's last name."},"Username":{"type":"string","description":"The user's impact.com login username."},"State":{"$ref":"#/components/schemas/UserState"},"Language":{"type":"string","description":"The user's account language preference (locale code)."},"AccessRights":{"type":"array","description":"Roles and the specific permissions granted under each role.","items":{"$ref":"#/components/schemas/AccessRight"}},"JoinedDate":{"type":"string","format":"date-time","description":"Date and time the user joined the partner account (ISO 8601)."},"DateLastUpdated":{"type":"string","format":"date-time","description":"Date and time the user's information was last updated (ISO 8601)."},"LastUpdatedBy":{"type":"string","description":"Username of the user that last updated this account user."},"CreatedBy":{"type":"string","description":"Username of the user that created this account user."},"Uri":{"type":"string","description":"API resource path for this user."}}},"UserState":{"type":"string","enum":["ACTIVE","PENDING","INVITED"],"description":"The account state of the user."},"AccessRight":{"type":"object","properties":{"Role":{"type":"string","enum":["Advertiser Management","Finance","Technical","Creative Management","Account Administration"],"description":"The functional area the granted permissions apply to."},"Permissions":{"type":"array","description":"The specific permissions granted to the user under this role.","items":{"type":"string","enum":["MANAGE_DIRECTORY_INFO","RUN_USAGE_REPORTS","MANAGE_ACCOUNT_INFO","MANAGE_PUBLISHER_PACKAGES","MESSAGING","NEGOTIATE_AGREEMENTS","REQUEST_CAP_EXTENSIONS_AND_AGREEMENT_EXCEPTIONS","SEND_MARKETING_MSG_TO_BRAND","VIEW_BRAND_INFO","APPLY_TO_CAMPAIGN","RUN_ACTION_AND_PERFORMANCE_REPORTS","REQUEST_CUSTOM_ADS","APPROVE_CREATIVE_AND_DUB_HOUSE_EXPENSES","MANAGE_CREATIVES","RUN_CREATIVE_REPORTS","GET_AD_HTML","VIEW_FINANCIALS","MANAGE_FINANCIAL_SETTINGS","RUN_FINANCIAL_TRANSACTION_REPORTS","WEBSERVICES_INTEGRATION","EVENT_CALLBACK_INTEGRATION","RUN_TECHNICAL_REPORTS","TRACKER_AND_BRAND_URL_INTEGRATIONS","ITEM_LIST_INTEGRATIONS"]}}}}}},"paths":{"/Mediapartners/{AccountSID}/Users/{Id}":{"get":{"operationId":"retrieveUser","tags":["Users"],"summary":"Retrieve a specific user","description":"Retrieves a single account user by their unique Id.","parameters":[{"name":"AccountSID","in":"path","required":true,"schema":{"type":"string"},"description":"Unique identifier for the partner account."},{"name":"Id","in":"path","required":true,"description":"Unique identifier for the account user, in `I-XXXXXXX` format.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful retrieval of the user object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"404":{"description":"No user exists with the supplied Id."}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://integrations.impact.com/partner-api-reference/reference/users/users.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
