Skip to content

PERS SDK - v2.3.26 / Exports / GetBusinessMembersOptions

Interface: GetBusinessMembersOptions

Options for listing business members

Table of contents

Properties

Properties

page

Optional page: number

Defined in

business/api/business-membership-api.ts:16


limit

Optional limit: number

Defined in

business/api/business-membership-api.ts:17


role

Optional role: MembershipRole

Defined in

business/api/business-membership-api.ts:18


sortBy

Optional sortBy: string

Defined in

business/api/business-membership-api.ts:19


sortOrder

Optional sortOrder: SortOrder

Defined in

business/api/business-membership-api.ts:20


include

Optional include: BusinessMembershipIncludeRelation[]

Include related entities in the response.

  • 'user': Include full user details in membership.included.user
  • 'business': Include full business details in membership.included.business

Defined in

business/api/business-membership-api.ts:26