List Accounts

GET /api/v2/directory/accounts

This endpoint retrieves a list of all accounts within the directory.

Query Parameters

Name	Type	Description	Required
start_range	string	Starting point for specified data range. Example:2020-12-09
end_range	string	Ending point for specified data range. Example:2023-12-09
page	integer	The page number. Minimum: 1. Default: 1
size	Integer	The page size. Minimum: 1. Maximum: 100. Default: 50.
sort	string	Criteria for result sorting. Default: -created. Example: -last_modified
account_type	string	Type of the account. Either individual or entity
account_category	string	Category of the account. Either customer or recipient.

Response

200

{
    "status": "success",
    "data": {
        "items": [
            {
                "reference_id": "Mary",
                "account_type": "Individual",
                "name": "Mary Jane",
                "account_category": "customer",
                "email": "[email protected]",
                "created": "2024-09-20T07:16:05+00:00",
                "last_modified": "2024-09-20T07:16:05+00:00"
            },
            {
                "reference_id": "Ospree",
                "account_type": "Entity",
                "name": "Ospree Ltd.",
                "account_category": "customer",
                "email": "[email protected]",
                "created": "2024-09-18T09:52:51+00:00",
                "last_modified": "2024-09-18T09:52:51+00:00"
            },
            {
                "reference_id": "John123",
                "account_type": "Individual",
                "name": "John Doe",
                "account_category": "recipient",
                "email": "[email protected]",
                "created": "2024-09-18T09:52:36+00:00",
                "last_modified": "2024-09-18T09:52:36+00:00"
            },
            {
                "reference_id": "NewBusiness123",
                "account_type": "Entity",
                "name": "New Business Ltd.",
                "account_category": "recipient",
                "email": "[email protected]",
                "created": "2024-09-18T09:52:14+00:00",
                "last_modified": "2024-09-18T09:52:14+00:00"
            }
        ],
        "pagination": {
            "total": 4,
            "size": 10,
            "page": 1
        }
    }
}