Get a whitelisting

GET /organizations/{organizationId}/contexts/sign-in/{contextId}/whitelistings/{whitelistingId}

Permission: Sign In › Sign In Modules › Whitelisting (Read). See API permissions.

Returns the whitelisting whether it is active or has ended. An ended whitelisting, by its end date or by a revocation, has an expiresAt in the past. An unknown ID, or the ID of a whitelisting of another context, returns 404.

The whitelistingId is in the response of Create a whitelisting and in the list of active whitelistings. The path of this operation is the Location header of a created whitelisting.

Request

Parameter	In	Type	Required	Description
organizationId	Path	string	Yes	The Organization ID of the API key. Any other ID returns 404.
contextId	Path	string	Yes	The ID of a Sign-In Context of the Organization. Any other ID returns 404.
whitelistingId	Path	string	Yes	The ID of the whitelisting. An unknown ID returns 404.

Request example

cURL

curl "$API_BASE_URL/organizations/$ORGANIZATION_ID/contexts/sign-in/$CONTEXT_ID/whitelistings/6aba6cb007a2eda4c7c79ade" \
  -H "Authorization: Bearer $NCP_API_TOKEN"

Response

200 with the whitelisting. The fields are described in the whitelisting object.

Response example

200

{
  "whitelistingId": "6aba6cb007a2eda4c7c79ade",
  "mac": "02:00:5e:10:ab:01",
  "name": "Lobby display",
  "description": "Digital signage, main entrance",
  "tags": ["lobby", "signage"],
  "createdAt": "2026-09-28T13:33:36.341Z",
  "expiresAt": "2026-12-31T22:59:59.999Z"
}

Errors

Status	errorCode	When
404	RESOURCE_NOT_FOUND	The context has no whitelisting with this ID, organizationId is not the Organization of the API key, or contextId is not one of its Sign-In Contexts.

Errors common to all operations are in Errors.