Search Members
The endpoint and http method information to member search are stated below.
URL
GET/onboarding/v1/members
Request Parameters
The parameters expected to be sent in requests to search for an existing member are listed under the table and subheadings below.
isBuyer
boolean
Returns true if member is a buyer
isSubMerchant
boolean
Returns true if member is a seller
memberType
MemberType
Member type. See: Member Types
Values:
PERSONAL
PRIVATE_COMPANY
LIMITED_OR_JOINT_STOCK_COMPANY
memberExternalId
string
External id of the member
memberIds
number[]
List of member ids
name
string
Name of the member
Response Parameters
Parameters returned as a result of member search are also subject to the rules specified in
the Response Formats section of the API documentation home page. In the absence of a systematic
or fictional error, the sub-parameters of the object returned in the data parameter are stated
in Response Parameters page.
Sample Codes
You can review the sample codes in the open source Craftgate API clients.