User

A User object represents a customer who has made a purchase or registered in your store. Users store identity information including contact details, billing address, and custom identifiers. Each user is automatically created when a customer completes a checkout, or can be created manually via the API. Users are central to the Fungies platform - they link to Orders, Payments, Subscriptions, and inventory items. You can use the API to create, retrieve, update, and manage user accounts.

Endpoints

Method	Endpoint	Description
`GET`	`/v0/users/list`	List and filter users
`POST`	`/v0/users/create`	Create a new user
`GET`	`/v0/users/{userId}`	Retrieve a user
`PATCH`	`/v0/users/{userId}/update`	Update user details
`PATCH`	`/v0/users/{userId}/archive`	Archive a user
`PATCH`	`/v0/users/{userId}/unarchive`	Restore an archived user
`GET`	`/v0/users/{userId}/inventory`	Get user’s inventory items

The User object

object

string

Object type identifier. Always "user" for User objects.

string

required

Unique identifier (UUID) for this user.

string | null

The user’s email address. Used for transactional emails and account identification.

username

string | null

Username of the user, if set. Can be used as an alternative identifier.

details

object | null

Billing and contact details for the user.

Show details properties

type

string | null

The type of customer account. Possible values: "individual", "company"

firstName

string | null

Customer’s first name.

lastName

string | null

Customer’s last name.

phoneNumber

string | null

Customer’s phone number (without country dial code).

dialCode

string | null

International dial code for the phone number (e.g., "+1", "+44").

address

string | null

Primary street address line.

addressLine2

string | null

Secondary address line (apartment, suite, unit, etc.).

city

string | null

City or locality.

state

string | null

State, province, or region.

postalCode

string | null

Postal or ZIP code.

countryCode

string | null

Two-letter ISO 3166-1 alpha-2 country code (e.g., "US", "GB", "DE").

companyName

string | null

Company or organization name. Typically set when type is "company".

taxId

string | null

Tax identification type or label.

taxNumber

string | null

Tax identification number (VAT number, EIN, etc.).

internalId

string | null

Your custom identifier for this user. Use this to link Fungies users to your own system’s user records.

Example response

{
  "status": "success",
  "data": {
    "user": {
      "object": "user",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "email": "customer@example.com",
      "username": "johndoe",
      "details": {
        "type": "individual",
        "firstName": "John",
        "lastName": "Doe",
        "dialCode": "+1",
        "phoneNumber": "5551234567",
        "address": "123 Main Street",
        "addressLine2": "Apt 4B",
        "city": "New York",
        "state": "NY",
        "postalCode": "10001",
        "countryCode": "US",
        "companyName": null,
        "taxId": null,
        "taxNumber": null
      },
      "internalId": "usr_abc123"
    }
  }
}

Orders

View orders placed by users

Payments

Payment transactions by users

Subscriptions

User subscription relationships

Events

Webhook events for user activity

Getting Started

Customers

Commerce

Transactions

Webhooks

Endpoints

The User object

Example response

Orders

Payments

Subscriptions

Events

​Endpoints

​The User object

​Example response

​Related resources

Orders

Payments

Subscriptions

Events

Endpoints

The User object

Example response

Related resources