user Query

Description

Retrieves a single buyer by reference ID. Returns the buyer with statistics including order count, order total, credit notes count, wants count, and vouchers count.

query user($userRef: ID!) {
  user(userRef: $userRef) {
    _id
    created
    updated
    lastLogin
    active
    birthdate
    firstName
    lastName
    email
    name
    path
    telephone
    organisation
    taxNumber
    lists {
      _id
      ref
      added
      lastModified
    }
    accountCreated
    addresses {
      _id
      description
      firstName
      lastName
      addressLine1
      addressLine2
      streetNumber
      city
      state
      stateCode
      postCode
      alpha2
      country
      type
    }
    notes
    verification {
      status
      token
      code
      date
      hash
    }
    orderCount
    orderTotal
    creditNotesCount
    wantsCount
    vouchersCount
    type
  }
}

Variables

{
    "userRef": "5f6dbee8892e65e73b908dc1"
}

Response

{
    "user": {
        "_id": "2490429a30e3937bc4c9181f",
        "created": 1733055834521,
        "updated": 1748107346349,
        "lastLogin": 1760017991838,
        "active": true,
        "birthdate": 1760908090387,
        "firstName": "example",
        "lastName": "example",
        "email": "email@example.com",
        "name": "example",
        "path": "/release/1763553751/release-artist-release-name",
        "telephone": "example",
        "organisation": "example",
        "taxNumber": "example",
        "lists": [
            {
                "_id": "07f11a1425855664d8c1bcf1",
                "ref": "d0d588fc1ae1fa575434fe51",
                "added": 1719535577412,
                "lastModified": 1732212167067
            }
        ],
        "accountCreated": true,
        "addresses": [
            {
                "_id": "2446fd7eb818f525b4f00093",
                "description": "example",
                "firstName": "example",
                "lastName": "example",
                "addressLine1": "example",
                "addressLine2": "example",
                "streetNumber": 42,
                "city": "example",
                "state": "example",
                "stateCode": "example",
                "postCode": "example",
                "alpha2": "example",
                "country": "example",
                "type": "example"
            }
        ],
        "notes": "example",
        "verification": {
            "status": true,
            "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ",
            "code": "example",
            "date": 1767641836852,
            "hash": "example"
        },
        "orderCount": 42,
        "orderTotal": 1.23,
        "creditNotesCount": 42,
        "wantsCount": 42,
        "vouchersCount": 42,
        "type": "example"
    }
}

Arguments

Name	Type	Description
userRef	ID!	Reference ID of the buyer to retrieve.

Returns

Buyer