Billiecart API

<back to all web services

ListMembersForOrganisationRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
GET/organisations/{Id}/members
ListMembersForOrganisationRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathstringNo
SearchOperationUnTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
DistinctformstringNo
Limitformint?No
Offsetformint?No
SortformstringNo
FilterformstringNo
SearchformstringNo
GetOperationUnTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
EmbedformstringNo
ListMembersForOrganisationResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
MembersformList<OrganisationMembership>No
SearchOperationResponse Parameters:
NameParameterData TypeRequiredDescription
MetadataformSearchMetadataNo
SearchMetadata Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
LimitformintNo
OffsetformintNo
SortformSortingNo
FilterformFilteringNo
Sorting Parameters:
NameParameterData TypeRequiredDescription
ByformstringNo
DirectionformSortDirectionNo
SortDirection Enum:
Ascending
Descending
Filtering Parameters:
NameParameterData TypeRequiredDescription
FieldsformList<string>No
SearchformstringNo
OrganisationMembership Parameters:
NameParameterData TypeRequiredDescription
EmailAddressformstringNo
IsOwnerformboolNo
IsConfirmedformboolNo
IdformstringNo
ListMembersForOrganisationResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
MembersformList<OrganisationMembership>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /organisations/{Id}/members HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"members":[{"emailAddress":"String","isOwner":false,"isConfirmed":false,"id":"String"}],"metadata":{"total":0,"limit":0,"offset":0,"sort":{"by":"String","direction":"Ascending"},"filter":{"fields":["String"],"search":"String"}}}