Review Paginated Users

get

https://api.infinicept.com/api/{tenantId}/user/paginated

Returns a paginated list of the users created within a Backoffice tenant. Use the CurrentPage and PageSize parameters to navigate between pages of results.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tenantId

string

required

The tenant identifier.

Query Params

UserRole

array of integers

The user role assigned to the user. User roles include: 0 = Submerchant, 1 = SystemAdministrator, 2 = SalesAgent, 3 = Analyst, 4 = Accountant, 5 = SupportUser, and 7 = PartnerManager.

UserRole

Status

array of integers

The user's status in Backoffice. Statuses include: 0 = Active and 1 = Deactivated.

Status

Allowed:

Name

array of strings

The user's first and last name.

Name

EmailAddress

array of strings

The user's email address.

EmailAddress

AccountStatus

array of integers

A submerchant user's status. Statuses include: 0 = Active, 1 = HoldAllFunding, 2 = Canceled, 3 = WaitingforFirstTrans, 4 = WaitingforFirstAuth, and 99 = Deleted.

AccountStatus

Allowed:

DBAName

array of strings

A submerchant's doing business as name (DBA).

DBAName

LegalEntityName

array of strings

A submerchant's legal entity name.

LegalEntityName

Mid

array of strings

A submerchant's merchant identification number (MID) provided by their payments processor.

Mid

array of int32s

The user's Backoffice identification number.

Cobrand

array of strings

The New Accounts cobrand where the submerchant's merchant application was submitted.

Cobrand

Location

array of strings

A submerchant's location.

Location

MerchantCategoryCode

array of strings

A submerchant's merchant category code (MCC).

MerchantCategoryCode

CancelledDateFilter

array of integers

Filters by the submerchant's cancelled (termination) date. Applied manually against
FundingApp.Core.Objects.Submerchant.TerminationDate since it isn't a simple equality match.

CancelledDateFilter

CancelledFromDate

array of date-times

CancelledFromDate

CancelledToDate

array of date-times

CancelledToDate

CancelledSpecificDate

array of strings

CancelledSpecificDate

CloseReasonId

array of int32s

Filters by the submerchant's current close reason. There is no CloseReasonId column on Submerchants,
so this can't go through the reflected equality filter - it's resolved from
SubmerchantCancellationHistory and applied manually.

CloseReasonId

CurrentPage

int32

Use this parameter to navigate between pages of results.

PageSize

int32

Use this parameter to specify the number of results per page.

FieldName

string

Use this parameter to sort results by a specific field name.

SortOrder

string

Use this parameter to sort results in a specific order.

includeImpersonation

boolean

Defaults to true

This parameter is not currently supported.

Headers

x-AuthenticationKeyId

string

required

The API key id used to authenticate and authorize your request to Infinicept. API keys are managed within your Backoffice tenant.

x-AuthenticationKeyValue

string

required

The API key value used to authenticate and authorize your request to Infinicept. API keys are managed within your Backoffice tenant.

Responses

404

Not Found

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success