List active whitelistings

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

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

Returns one page of the whitelistings that have not ended, oldest first. items is empty when the context has no active whitelisting. No operation lists ended whitelistings; Get a whitelisting returns one whitelisting, active or ended.

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.
limit	Query	integer	No	Whitelistings per page, 1 to 100. Default 20.
cursor	Query	string	No	The nextCursor of the previous page. Leave it out for the first page.

Request example

cURL

curl "$API_BASE_URL/organizations/$ORGANIZATION_ID/contexts/sign-in/$CONTEXT_ID/whitelistings?limit=20" \
  -H "Authorization: Bearer $NCP_API_TOKEN"

Response

A page of whitelistings.

Field	Type	Description
items	object[]	The whitelistings on this page, oldest first. Each has the fields of the whitelisting object.

Response example

200

{
  "items": [
    {
      "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"
    }
  ],
  "nextCursor": null
}

Errors

Status	errorCode	When
400	VALIDATION_FAILED	limit is outside 1 to 100, or cursor is not a cursor of this operation. errors names the parameter.
404	RESOURCE_NOT_FOUND	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.