Partner API
Get Partner(s) Record
This functionality allows you to filter and fetch partner(s) records.
HTTP Method
POST
Request URL
https://yourdomain.com/api/v2/partner/list
Token
Token is required as an authentication parameter to get response from an API. Detailed Information about Tokens has been provided in the Authentication API Doc.
Request Headers
cache-control: no-cache, Validate: Bearer <Token> |
Parameters
Name | Data Type | Required/Optional | Description | Example |
limit | Integer | Optional | if not mentioned, then 100 records will be fetched at once. | 100 |
page | Integer | Optional | page number | 1 |
partid | Integer | Optional | partner id | 104402 |
status | Integer | Optional | partner status | 1 |
customer_status | Char | Optional | customer status | Active |
Varchar | Optional | partner email address | techsoft@gmail.com | |
username | Varchar | Optional | partner username | techsoft@gmail.com |
partnername | Char | Optional | partner name | Alice |
fromdate | Date | Optional | date range from | 20/2/2019 |
todate | Date | Optional | date range to | 25/2/2019 |
pid | Integer | Optional | partner id | 104195 |
ac_mngr | Integer | Optional | account manager id | 1321 |
Response
Returns a JSON response with details as shown below:
( Below displayed response is after decoding JSON )
Array
(
[Partner] => Array
(
[0] => Array
(
[id] => 625
[firstname] => James
[lastname] => Smith
[username] => james_7878
[email] => james_smith@mail.com
[companyname] => James Infotech
[phonenumber] => 8556955412
[mobilenumber] => 9965582235
[partner_request_date] => 2019-07-16 10:30:38
[inv_due_days] =>
[datecreated] => 2019-07-16 10:30:38
[venture_id] => 1
[customer_status] => Active
[is_subaccount] => 0
[address1] => D-50, Cross Road Colony
[address2] =>
[state] => Abu Dhabi
[city] => abu dhabi
[currency_id] => 2
[pid] => 0
[MpnID] => 3009739
[country_name] => United Arab Emirates
[currency_prefix] => USD
)
)
[total_records] => 46
) |
In case of any errors, an error code key with value along with an error message will be returned.