Retrieve all accounts

1min
GET
This endpoint will provide the ability to return all accounts or a subset based upon the filter criteria provided
Authentication
Authorization
Bearer
Query Parameters
emailAddress
string
clientUserId
string
firstName
string
surname
string
street
string
townCity
string
postCode
string
country
string
state
string
phoneNumber
string
dateOfBirth
string
rowsPerPage
string
pageNumber
string
useStartsWithSearch
boolean
Header Parameters
X-TokenId
string
X-SessionId
string
X-Version
string
*
Origin
string
Responses
200
OK
FictiveGlobal.Api.Rest.Dtos.v3.AccountResultNoAddress[]
Description
Account
accountReference
string
status
string<None | Active | Suspended | Closed | MWalletInactive>
verified
boolean
email
string
clientUserId
string
*
salutation
string
firstName
string
lastName
string
phoneNumber
string
mobileNumber
string
dateOfBirth
string<date-time>
gender
string<NotKnown | Female | Male>
customParameters
object
sessionToken
string
marketingAllowed
boolean
204
No Content.
FictiveGlobal.Api.Rest.Dtos.v3.AccountResultNoAddress[]
Description
Account
accountReference
string
status
string<None | Active | Suspended | Closed | MWalletInactive>
verified
boolean
email
string
clientUserId
string
*
salutation
string
firstName
string
lastName
string
phoneNumber
string
mobileNumber
string
dateOfBirth
string<date-time>
gender
string<NotKnown | Female | Male>
customParameters
object
sessionToken
string
marketingAllowed
boolean
401
Not Authorized
500
Internal Server Error
Curl
JS
Ruby
Python
curl --location 'https://api.fictive.com/REST/api/accounts' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location 'https://api.fictive.com/REST/api/accounts' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
204
401
500
[
  {
    "accountReference": "accRef",
    "status": "Active",
    "verified": true,
    "email": "Email",
    "clientUserId": "ClientUserId",
    "salutation": "Salutation",
    "firstName": "FirstName",
    "lastName": "LastName",
    "phoneNumber": "PhoneNumber",
    "mobileNumber": "MobileNumber",
    "dateOfBirth": "2021-09-21T05:33:12.1821545",
    "gender": "NotKnown",
    "customParameters": {
      "ParameterName": "ParameterValue"
    },
    "marketingAllowed": true
  },
  {
    "accountReference": "accRef",
    "status": "Active",
    "verified": true,
    "email": "Email",
    "clientUserId": "ClientUserId",
    "salutation": "Salutation",
    "firstName": "FirstName",
    "lastName": "LastName",
    "phoneNumber": "PhoneNumber",
    "mobileNumber": "MobileNumber",
    "dateOfBirth": "2021-09-21T05:33:12.1821545",
    "gender": "NotKnown",
    "customParameters": {
      "ParameterName": "ParameterValue"
    },
    "marketingAllowed": false
  }
]
[
  {
    "accountReference": "accRef",
    "status": "Active",
    "verified": true,
    "email": "Email",
    "clientUserId": "ClientUserId",
    "salutation": "Salutation",
    "firstName": "FirstName",
    "lastName": "LastName",
    "phoneNumber": "PhoneNumber",
    "mobileNumber": "MobileNumber",
    "dateOfBirth": "2021-09-21T05:33:12.1821545",
    "gender": "NotKnown",
    "customParameters": {
      "ParameterName": "ParameterValue"
    },
    "marketingAllowed": true
  },
  {
    "accountReference": "accRef",
    "status": "Active",
    "verified": true,
    "email": "Email",
    "clientUserId": "ClientUserId",
    "salutation": "Salutation",
    "firstName": "FirstName",
    "lastName": "LastName",
    "phoneNumber": "PhoneNumber",
    "mobileNumber": "MobileNumber",
    "dateOfBirth": "2021-09-21T05:33:12.1821545",
    "gender": "NotKnown",
    "customParameters": {
      "ParameterName": "ParameterValue"
    },
    "marketingAllowed": false
  }
]
﻿
﻿
Updated 22 Sep 2023
Did this page help you?
Verify an email address
Create account