Skip to main content
GET
List Conduit Tenants

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

query
string

Search filter for tenant name or code

Maximum string length: 255
sortBy
string

Sort column

Maximum string length: 50
sortDirection
enum<string>

Sort direction

Available options:
asc,
desc
paginated
integer
default:1

1 = paginated response, 0 = full list

Required range: 0 <= x <= 1
page
number

Page number

recordsPerPage
number

Records per page

export
integer
default:0

1 = email a CSV of the full result set to the requester

Required range: 0 <= x <= 1

Response

200 - application/json

Paginated conduit tenant list

records
object[]
required
page
number
required
maxPage
number
required
totalRecords
number
required