The endpoint and http method information to member search are stated below.
| HTTP Method | URL | URL Parameters |
|---|---|---|
GET |
/onboarding/v1/members |
For URL parameters, see Request Parameters |
The parameters expected to be sent in requests to search for an existing member are listed under the table and subheadings below.
| Parameter Name | Type | Required | Description |
|---|---|---|---|
isBuyer |
boolean |
No | Returns true if member is a buyer |
isSubMerchant |
boolean |
No | Returns true if member is a seller |
memberType |
MemberType |
No | Member type. See: Member Types |
memberExternalId |
string |
Yes | External id of the member |
memberIds |
number[] |
Yes | List of member ids |
name |
string |
No | Name of the member |
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.
You can review the sample codes in the open source Craftgate API clients.