Lists the users who can be granted portal access for the current merchant.

GET /api/developer-portal/accounts/assignable-users deprecated

Requires: DeveloperPortal.Accounts, DeveloperPortal.Accounts.Create, merchant scope.

Narrow the result with `filter`. Every user returned already meets the rules the create call enforces, so a request built from this list is not refused for the account it names. Create still checks those rules, because a caller need not have read this list first. A user who already holds a developer account for the current merchant is not returned, whether that account is active or disabled, because create refuses a second one. The list is empty when every eligible user already has access. A user whose access was removed is returned, and granting them access again restores it. The developer-account permissions gate this route, not the user-directory permissions: granting portal access does not entitle a caller to browse the directory.

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a . See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X GET "{{BASE_URL}}/api/developer-portal/accounts/assignable-users" \
  -H "api-key: {{API_KEY}}"

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/developer-portal/accounts/assignable-users' `
    -Headers $headers

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, DeveloperPortalApi } from '@winkpg/winkpg-api';

const api = new DeveloperPortalApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.developerPortalGetAssignableUsers();

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/developer-portal/accounts/assignable-users', {
  method: 'GET',
  headers: {
    "api-key": "{{API_KEY}}",
  },
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new DeveloperPortalApi(config);
var result = await api.DeveloperPortalGetAssignableUsersAsync();

C# (raw HTTP)

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/developer-portal/accounts/assignable-users");
request.Headers.Add("api-key", "{{API_KEY}}");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)

import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.DeveloperPortalApi(client)
    result = api.developer_portal_get_assignable_users()

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
}

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/developer-portal/accounts/assignable-users",
    headers=headers,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`filter` required	query	string
`suppressNulls` required	query	boolean	If true, omit properties with null values.
`X-Acting-Merchant-Id` required	header	string (uuid)	The merchant to act for. Optional: when absent, the caller's own merchant scope answers. A caller whose identity carries no merchant scope, such as an administrator, must send it. The selection is authorized on every operation; a merchant the caller may not act for is refused.

Request body

application/json , required

Field	Type	Description

This request body has no documented fields.