Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceQueries

Identity__users

Requires a signed-in staff user. Needs the `identity__User` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).

QUERYidentity__users(where: CommonPaginationDto): UsersWithPagination!

Requires a signed-in staff user. Needs the identity__User read permission. Send the x-tenant header (the gateway sets it from your API key).

Arguments

where?

Returns

  1. identity__users
meta?
nodes?
Example Request
query Identity__users {  identity__users {    meta {      currentPage      hasNextPage      totalCount      totalPages    }    nodes {      _id      accountStatus      authProviders {        email        linkedAt        provider        subject      }      avatar {        alt        external        fileAssetId        key        provider      }      createdAt      email      lastLoginAt      mustChangePassword      name      phoneNumber    }  }}
Example Response
{  "data": {    "identity__users": {      "meta": {        "currentPage": 10.5,        "hasNextPage": true,        "totalCount": 10.5,        "totalPages": 10.5      },      "nodes": [        {          "_id": "1",          "accountStatus": "ACTIVE",          "authProviders": [            {              "email": "string",              "linkedAt": "<DateTime>",              "provider": "GOOGLE",              "subject": "string"            }          ],          "avatar": {            "alt": "string",            "external": "string",            "fileAssetId": "1",            "key": "string",            "provider": "CLOUDINARY"          },          "createdAt": "<DateTime>",          "email": "string",          "lastLoginAt": "<DateTime>",          "mustChangePassword": true,          "name": "string",          "phoneNumber": "string"        }      ]    }  }}