Get users account by branding or sponsorships

get

https://tenants-gateway-api-sbx.sidedrawersbx.com/api/v2/tenants/tenant/tenant-id/{tenantId}/users

Path Params

tenantId

string

required

Tenant identifier.

Query Params

limit

string

Limit. Default value is 20.

startingAfter

string

Starting after is an object ID that defines your place in the list.

endingBefore

string

Object identifier that defines your place in the list.

filter

string

enum

Filter Type (By sponsorship or by branding).

Allowed:

brandCode

string

The affiliate code (brandCode) is an identifier for the "brand" or "affiliate" within a Tenant. The affiliate code is the version of the brand name that appears in the URL. A brand name may be "Corporate ABC", for example. Then the affiliate code might be something like "corporate-abc".

region

string

Region.

displayInactive

boolean

Display inactive.

username

string

Account username.

firstName

string

Contributor's first name.

lastName

string

Contributor's last name.

businessName

string

Business name.

inactiveDaysFrom

number

Open days from range.

inactiveDaysTo

number

Open days to range.

lock

boolean

Filter users who have lock.

Response

Language

Credentials

Bearer

JWT

Loading…

Response

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

application/json

201The Account has been successfully created.