Get Accounts

Used to retrieve a paginated list of accounts with support for filtering, sorting, and searching.

API Endpoint

Property	Value
Request Method	POST
Request URL	https://api.seliseblocks.com/idp/v1/Iam/GetAccounts

Request

Request Example

curl -X POST 'https://api.seliseblocks.com/idp/v1/Iam/GetAccounts' \
  -H 'Content-Type: application/json' \
  -H 'x-blocks-key: YOUR_PROJECT_KEY' \
  -d '{
    "page": 1,
    "pageSize": 10,
    "sort": {
      "property": "createdDate",
      "isDescending": true
    },
    "filter": {
      "email": "user@example.com",
      "name": "John",
      "userIds": ["user_123"],
      "status": {
        "active": true,
        "inactive": false
      },
      "mfa": {
        "enabled": true,
        "disabled": false
      },
      "joinedOn": "2026-01-01T00:00:00Z",
      "lastLogin": "2026-03-01T00:00:00Z",
      "organizationId": "org_123"
    }
  }'

Request Headers

Field	Type	Description
Content-Type	application/json	Data type, must be application/json.
x-blocks-key	string	Project key for authentication.

Request Body

Field	Type	Required	Description
page	integer	No	Page number for pagination (1-based).
pageSize	integer	No	Number of records per page.
sort	object	No	Sort configuration with property and direction.
filter	object	No	Filter criteria for searching accounts.

Sort Object

Field	Type	Description
property	string	Property to sort by (e.g., createdDate).
isDescending	boolean	Sort in descending order if true.

Filter Object

Field	Type	Description
email	string	Filter by email address.
name	string	Filter by account name.
userIds	array	Filter by specific user IDs.
status	object	Filter by account status.
mfa	object	Filter by MFA status.
joinedOn	string(date-time)	Filter by join date.
lastLogin	string(date-time)	Filter by last login date.
organizationId	string	Filter by organization ID.

Response

Success Response

Returns HTTP status 200 OK with paginated accounts list.

{
  "data": [
    {
      "itemId": "account_123",
      "createdDate": "2026-01-15T10:30:00Z",
      "lastUpdatedDate": "2026-03-20T14:00:00Z",
      "language": "en-US",
      "salutation": "Mr.",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "userName": "johndoe",
      "phoneNumber": "+1234567890",
      "memberships": [
        {
          "organizationId": "org_123",
          "roles": ["admin"],
          "permissions": ["read", "write"]
        }
      ],
      "active": true,
      "isVarified": true,
      "profileImageUrl": "https://example.com/image.jpg",
      "mfaEnabled": true,
      "isMfaVerified": true,
      "userMfaType": 1,
      "userCreationType": 0
    }
  ],
  "errors": {},
  "totalCount": 1
}

Response Fields

Field	Type	Description
data	array	List of account objects.
errors	object	Any errors encountered during retrieval.
totalCount	integer	Total count of accounts matching filter.

Account Object Fields

Field	Type	Description
itemId	string	Unique account identifier.
createdDate	string(date-time)	Account creation date.
lastUpdatedDate	string(date-time)	Last update date.
language	string	Account's preferred language.
salutation	string	Account holder's salutation.
firstName	string	Account holder's first name.
lastName	string	Account holder's last name.
email	string	Account email address.
userName	string	Account username.
phoneNumber	string	Account phone number.
memberships	array	Organization memberships.
active	boolean	Whether account is active.
isVarified	boolean	Whether email is verified.
profileImageUrl	string	Account's profile image URL.
mfaEnabled	boolean	Whether MFA is enabled.
isMfaVerified	boolean	Whether MFA is verified.
userMfaType	integer	Type of MFA (0-based).
userCreationType	integer	Type of account creation (0-based).