---
title: "List an identity's nicknames"
method: GET
path: "/identities/{identityId}/nicknames"
tags: ["identities"]
---

# List an identity's nicknames

`GET /identities/{identityId}/nicknames`

__JWT is required for this endpoint with at least one of the following scopes__: i{params.identityId}:w,i{params.identityId}:r,i:w,i:r<br/><br/>__Endpoint name__: listIdentityNicknames

## Path parameters

- `identityId` integer, required

## Query parameters

- `limit` integer
- `offset` integer
- `sort` string
- `order` string
- `q` string
- `filter` string
- `preFilter` string

## Response `200`

Successful

- object
  - `totalCount` integer
  - `filteredCount` integer
  - `data` object[]
    - `nickname` string
  - `meta` object
    - `accessToken` object, nullable
      - `scopeUpdatedAt` string, date
    - `siteSpecificAccess` object, nullable
      - `isSiteSpecific` boolean
      - `siteIds` integer[], nullable
      - `siteIdsByScope` object, nullable
        - `string` integer[], nullable

---

[API](https://skmtc.net/openpath/apis/openpath-api-documentation.md) · [All operations](https://skmtc.net/openpath/apis/openpath-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openpath/openpath-api-documentation/revisions/d8a888c114fa/schema)