Search Account

Search an account based on the input search criteria.

Securityoauth2
Request
Request Body schema:
agentId
integer or null <int32>

Unique identifier of agent.

agentCode
string or null

Indicates code of agent.

ids
Array of integers or null <int32>

Collection of unique identifier of account.

accountCodes
Array of strings or null

Indicates codes of account.

accountName
string or null

Name of the account.

agentNames
string or null

Name of the agents.

displayName
string or null

Indicates display name.

email
string or null

Indicates email for the account.

phoneNumber
string or null

Phone number of account.

emails
Array of strings or null

Collection of emails.

phoneNumbers
Array of strings or null

Collection of phone number.

socialNetworkIds
Array of strings or null

Collections of social network IDs.

pageIndex
integer <int32>

Indicates index of pages.

pageSize
integer <int32>

Indicates Pagesize from collection.

sortDirection
integer <int32> (DE.UserProfile.Entities.SortDirection)

Indicates whether Object is Simple, Collection, or XML.

Enum: 0 1
sortParameter
string or null

Indicates sorting parameter.

startsWith
string or null

Indicates starts with character for filtering.

industryType
string or null

Type of Industry.

fein
string or null

Indicates FEIN Number.

object (DE.UserProfile.Entities.AddressInfo)
likeSearch
integer <int32>

Set to true if it is LikeSearch for filtering.

createdBy
integer <int32>

Indicates user created.

sein
string or null

Indicates SEIN Number.

duplicateCheck
boolean

Set to true for duplicate check.

verifiedBy
string or null

Indicates user verified.

createdDateFrom
string <date-time>

Indicates date range.

createdDateTo
string <date-time>

Indicates date range.

Responses
200

Success

401

Unauthorized

403

Forbidden

post/api/v1/accounts/search
Request samples
{
  • "agentId": 0,
  • "agentCode": "string",
  • "ids": [
    ],
  • "accountCodes": [
    ],
  • "accountName": "string",
  • "agentNames": "string",
  • "displayName": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "emails": [
    ],
  • "phoneNumbers": [
    ],
  • "socialNetworkIds": [
    ],
  • "pageIndex": 0,
  • "pageSize": 0,
  • "sortDirection": 0,
  • "sortParameter": "string",
  • "startsWith": "string",
  • "industryType": "string",
  • "fein": "string",
  • "address": {
    },
  • "likeSearch": 0,
  • "createdBy": 0,
  • "sein": "string",
  • "duplicateCheck": true,
  • "verifiedBy": "string",
  • "createdDateFrom": "2019-08-24T14:15:22Z",
  • "createdDateTo": "2019-08-24T14:15:22Z"
}
Response samples
No sample