Skip to content

Users

A user is a person who can sign in to a Flute account.

This endpoint accepts either a partner API token or a merchant API token. The users returned depend on the API token used.

  • A partner API token returns the partner account's users, the users of its merchants, and the merchant applicants it invited.
  • A merchant API token returns only that merchant's users.

A sandbox API token returns only sandbox accounts. It does not return applicants, since merchant applications exist only in production.

Each partner user has the onboarding configuration for the merchant applications created for that user. This configuration includes the user's Schedule A pricing schedules and residual Split Profiles. The Schedule A and Split Profile endpoints require a partner API token.

For more information about Schedule A, see Schedule A.
For more information about Split Profiles, see Split Profiles.

This Users group consists of the following endpoints:

Operations

Lists users

Request

GET {{baseURL}}/v2/users

This endpoint lists the users the API token can access.

Each entry returns the user's id and email. A partner API token returns the partner account's users, its merchants' users, and the applicants it invited. A merchant API token returns only that merchant's users. The userType parameter narrows the results to one type of account. The email parameter finds one user directly.

A sandbox API token returns only sandbox accounts. It returns no applicants, since merchant applications exist only in production.

This endpoint does not require a specific API token. Either a merchant or partner API token can be used.

See Also:
To list a partner user's Schedule A pricing schedules, see GET /v2/users/{{userId}}/schedule-as.
To list a partner user's Split Profiles, see GET /v2/users/{{userId}}/split-profiles.

Security
Bearer
Query
pageIndexinteger, (int32), >= 0

Specifies the page number of the returned search results.

A page is considered each set of the pageSize values.

The page count is zero-based. The maximum for pageIndex, or the page number, is the pageSize divided by the total count rounded down. For example, the pageSize is 50 and the total is 130. That means there are three pages, but the pageIndex value is in the inclusive range from zero to two.

Value restrictions include:

  • A value less than zero is not permitted.
  • Values equal to or greater than totalPages end successfully but will not return any items.

For page size information, see pageSize.

Example: 0

Default:0
pageSizeinteger, (int32), [ 1 .. 100 ]

Specifies the number of items for each page of the returned search results.

A page is considered each set of the pageSize values.

The page count is zero-based. The maximum for pageIndex, or the page number, is the pageSize divided by the total count rounded down. For example, the pageSize is 50 and the total is 130. That means there are three pages, but the pageIndex value is in the inclusive range from zero to two.

For page numbering information, see pageIndex.

Example: 50

Default:20
userTypestring

Specifies filters by the type of account a user belongs to.

Valid values are:

TypeMeaning
ApplicantA merchant applicant invited by the partner.
MerchantA user of one of the partner's merchants, or of the merchant itself.
PartnerA user of the partner account. This returns only users who can create onboarding invitations.

Example: Partner

Enum:"Partner""Merchant""Applicant"
Example:userType=Partner
emailstring, (email)

Specifies filters by the user's email address.

The value must be a valid email address.

Example: ada@partner.example

Example:email=ada@partner.example
GET /v2/users?pageIndex=0&pageSize=20&userType=Partner HTTP/1.1
Host: sandbox.api.flute.com
Authorization: Bearer <YOUR_JWT_HERE>
Accept: application/json

Responses

OK

Bodyapplication/json
itemsArray of objects or null

Indicates an object list of users.

pageInfoobject

Indicates an object describing the pagination status.

If additional pages to review are needed, repeat the exact same search but include a new pageIndex value. Typically, this will increment the current pageIndex by one. However, any valid value may be used. Value restrictions include:

  • A value less than zero is not permitted.
  • Values equal to or greater than totalPages end successfully but will not return any items.
Response

Indicates every response field.

Each item shows every user field.

The pageInfo structure shows every pagination field.

{
  "items": [
    {
      "id": "3f2504e0-4f89-11d3-9a0c-0305e82c3301",
      "email": "ada@partner.example"
    }
  ],
  "pageInfo": {
    "pageIndex": 0,
    "pageSize": 20,
    "totalItems": 1,
    "totalPages": 1,
    "hasMore": false
  }
}