Find Members

Search for members by name, birth date, email, phone number, or card number. At least one filtering parameter is required. First and last name support wildcards (* and ?) and are case-insensitive. Use limit to cap results (default 50, max 100). If more members match than the limit, only the first limit matches are returned; overflow is not indicated. The result set is not ordered. Performance note: some fields may not be indexed, so broad or unbounded queries can be slower — prefer specific values and reasonable limits.

Authentication

x-np-api-keystring
API Key authentication via header

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

Headers

x-api-versiondateOptional

Used for API versioning. More details.

Query parameters

memberNumberstringOptional
Unique number identifying the member.
firstNamestringOptional
The first name of the member.
lastNamestringOptional
The last name of the member.
birthDatedateOptional
The birth date of the member.
emailstringOptional
The email address of the member.
phonestringOptional
The phone number of the member.
limitintegerOptional
The maximum number of results to return.
withDetailsbooleanOptional
Set to true will include more detailed information in the response

Response

This endpoint returns an object.
memberslist of objects