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/listList and filter users POST/v0/users/createCreate a new user GET/v0/users/{userId}Retrieve a user PATCH/v0/users/{userId}/updateUpdate user details PATCH/v0/users/{userId}/archiveArchive a user PATCH/v0/users/{userId}/unarchiveRestore an archived user GET/v0/users/{userId}/inventoryGet user’s inventory items
The User object Object type identifier. Always "user" for User objects.
Unique identifier (UUID) for this user.
The user’s email address. Used for transactional emails and account identification.
Username of the user, if set. Can be used as an alternative identifier.
Billing and contact details for the user. The type of customer account. Possible values: "individual", "company"
Customer’s phone number (without country dial code).
International dial code for the phone number (e.g., "+1", "+44").
Primary street address line.
Secondary address line (apartment, suite, unit, etc.).
State, province, or region.
Two-letter ISO 3166-1 alpha-2 country code (e.g., "US", "GB", "DE").
Company or organization name. Typically set when type is "company".
Tax identification type or label.
Tax identification number (VAT number, EIN, etc.).
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" : "[email protected] " , "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" } } }
