Find Members

GET

Search for members based on various criteria such as name, birth date, email, phone number, or card number. This endpoint allows you to perform a flexible search and return a list of members that match the provided criteria.

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.

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.

cardNumberstringOptional

Unique identifier for a card.

limitintegerOptional

The maximum number of results to return.

offsetintegerOptional

The starting point for results, used for pagination.

Response

This endpoint returns an object.
memberslist of objects
cacheInstanceIdstringOptional

Identifier for the NST instance. Providing this value will increase the performance of the API when the NST is load-balanced.