MembershipsMembership

Get using Number

Use this endpoint to retrieve membership details based on the membership or customer number. This is helpful when the ID isn't available but the membership number or customer number is known.

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

membershipNumberstringOptional
Unique membership number.
customerNumberstringOptional
Customer number associated with the membership.

Response

This endpoint returns an object.
membershipobject

Membership shape returned by the primary membership endpoints — get by id/number, get members, block/unblock, and create. Extends MembershipEntity with the full timeFrames array. Other membership responses (lifecycle history, lifecycle options, card responses, list) return the base MembershipEntity shape without timeFrames.