Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceQueries

Identity__customers

{ permissions: ['*', 'create'], collectionName: 'identity__Customer', } Requires a signed-in staff user. Needs the `identity__Customer` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).

QUERYidentity__customers(input: CustomerFilterInput): CustomersWithPagination!

{ permissions: ['*', 'create'], collectionName: 'identity__Customer', } Requires a signed-in staff user. Needs the identity__Customer read permission. Send the x-tenant header (the gateway sets it from your API key).

Arguments

input?

Returns

  1. identity__customers
meta?
nodes?
Example Request
query Identity__customers {  identity__customers {    meta {      currentPage      hasNextPage      totalCount      totalPages    }    nodes {      _id      avatar {        alt        external        fileAssetId        key        provider      }      createdAt      email      emailVerifiedAt      lastLoginAt      name      phoneNumber      shippingAddress {        addressLine        area        district        division        postalCode        title        upazila      }      status    }  }}
Example Response
{  "data": {    "identity__customers": {      "meta": {        "currentPage": 10.5,        "hasNextPage": true,        "totalCount": 10.5,        "totalPages": 10.5      },      "nodes": [        {          "_id": "1",          "avatar": {            "alt": "string",            "external": "string",            "fileAssetId": "1",            "key": "string",            "provider": "CLOUDINARY"          },          "createdAt": "<DateTime>",          "email": "string",          "emailVerifiedAt": "<DateTime>",          "lastLoginAt": "<DateTime>",          "name": "string",          "phoneNumber": "string",          "shippingAddress": [            {              "addressLine": "string",              "area": "string",              "district": "string",              "division": "string",              "postalCode": "string",              "title": "string",              "upazila": "string"            }          ],          "status": "ACTIVE"        }      ]    }  }}