{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Interface: GetBusinessMembersOptions"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-reference/readme"},"children":["PERS SDK - v2.3.26"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-reference/modules"},"children":["Exports"]}," / GetBusinessMembersOptions"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"interface-getbusinessmembersoptions","__idx":0},"children":["Interface: GetBusinessMembersOptions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Options for listing business members"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"table-of-contents","__idx":1},"children":["Table of contents"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"properties","__idx":2},"children":["Properties"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-reference/interfaces/getbusinessmembersoptions#page"},"children":["page"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-reference/interfaces/getbusinessmembersoptions#limit"},"children":["limit"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-reference/interfaces/getbusinessmembersoptions#role"},"children":["role"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-reference/interfaces/getbusinessmembersoptions#sortby"},"children":["sortBy"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-reference/interfaces/getbusinessmembersoptions#sortorder"},"children":["sortOrder"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-reference/interfaces/getbusinessmembersoptions#include"},"children":["include"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"properties-1","__idx":3},"children":["Properties"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"page","__idx":4},"children":["page"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["• ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Optional"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["page"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"defined-in","__idx":5},"children":["Defined in"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/business/api/business-membership-api.ts#L16"},"children":["business/api/business-membership-api.ts:16"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"limit","__idx":6},"children":["limit"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["• ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Optional"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["limit"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"defined-in-1","__idx":7},"children":["Defined in"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/business/api/business-membership-api.ts#L17"},"children":["business/api/business-membership-api.ts:17"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"role","__idx":8},"children":["role"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["• ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Optional"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["role"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MembershipRole"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"defined-in-2","__idx":9},"children":["Defined in"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/business/api/business-membership-api.ts#L18"},"children":["business/api/business-membership-api.ts:18"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"sortby","__idx":10},"children":["sortBy"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["• ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Optional"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["sortBy"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"defined-in-3","__idx":11},"children":["Defined in"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/business/api/business-membership-api.ts#L19"},"children":["business/api/business-membership-api.ts:19"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"sortorder","__idx":12},"children":["sortOrder"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["• ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Optional"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["sortOrder"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SortOrder"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"defined-in-4","__idx":13},"children":["Defined in"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/business/api/business-membership-api.ts#L20"},"children":["business/api/business-membership-api.ts:20"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"include","__idx":14},"children":["include"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["• ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Optional"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["include"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BusinessMembershipIncludeRelation"]},"[]"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Include related entities in the response."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["'user': Include full user details in membership.included.user"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["'business': Include full business details in membership.included.business"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"defined-in-5","__idx":15},"children":["Defined in"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/business/api/business-membership-api.ts#L26"},"children":["business/api/business-membership-api.ts:26"]}]}]},"headings":[{"value":"Interface: GetBusinessMembersOptions","id":"interface-getbusinessmembersoptions","depth":1},{"value":"Table of contents","id":"table-of-contents","depth":2},{"value":"Properties","id":"properties","depth":3},{"value":"Properties","id":"properties-1","depth":2},{"value":"page","id":"page","depth":3},{"value":"Defined in","id":"defined-in","depth":4},{"value":"limit","id":"limit","depth":3},{"value":"Defined in","id":"defined-in-1","depth":4},{"value":"role","id":"role","depth":3},{"value":"Defined in","id":"defined-in-2","depth":4},{"value":"sortBy","id":"sortby","depth":3},{"value":"Defined in","id":"defined-in-3","depth":4},{"value":"sortOrder","id":"sortorder","depth":3},{"value":"Defined in","id":"defined-in-4","depth":4},{"value":"include","id":"include","depth":3},{"value":"Defined in","id":"defined-in-5","depth":4}],"frontmatter":{"seo":{"title":"Interface: GetBusinessMembersOptions"}},"lastModified":"2026-08-21T18:40:55.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/sdk-reference/interfaces/getbusinessmembersoptions","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}