Warning! Construction underway! Amatino is in an 'alpha' state. Not all features are operational. See roadmap

Primary
Account
Entity
Transaction
Derived
Balance
Ledger
Performance
Position
Recursive Balance
Recursive Ledger
Tree
Ancillary
Custom Unit
Entity List
Entry
Global Unit
Global Unit List
Ledger Row
Price
Session
Side
Tx Version List
Tree Node
Type
User
Object
Retrieve

User List

A User List is a collection of Users for whom the retrieving User has billing responsibility, and who were created using the Amatino API.

The User List excludes Users managed by the billing dashboard. See the User object documentation page for a description of the distinction between API-created users and those managed by the billing dashboard.

The User List Object

When returning a User List to you, Amatino uses the following JSON object structure.

Root Type

JSON Object

Object Structure

type JSON Number
example 2
key "page"
description The page number covered by this User List object
type JSON Number
example 3
key number_of_pages
description The number of pages this list covers, in total
type JSON String
example "2018-05-02_05:01:54.72941"
key generated_time
description The time at which this User List was computed, in the format YYYY-MM-DD_HH24:MI:SS.US
type JSON Array
example See User
key "users"
description A list of User objects
list_objects User

Retrieve User List

API Path /users/list
HTTP Method GET
Description Descr. Retrieve a User List

Required Headers

Key X-Signature
Value Your Session signature
Example "yxATCPRKAAXHNiPctNQPHEGGVJF"...
Key X-Session-ID
Value An an integer Session ID
Example 7449059267091272858

Required URL Parameters

None.

Required JSON Data

None.

Returns

Root Type

JSON Array

Object

User List