Fetch Accounts from Clickpost

With help of this API enterprises can get all the carrier partner accounts that are currently active on their Clickpost dashboard. This API would be useful if the enterprise is not using Clickpost's allocation rules and just require the active list of accounts to assign the carrier manually

Important Links

Run in Postman API Guide

Response

meta [meta parameters]

Field NameData TypeDescription
successBooleanIndicates the success of the API request
messageStringSUCCESS in case request was successfully processed by Clickpost, else returns error message.
statusHTTP CodeThe HTTP response status code of the API request

result [result parameters]

Field NameData TypeDescription
enterprise_nameStringThe name of the enterprise
accountsListContains the list of all the carrier partner accounts
courier_partner_idnumThe carrier partner ID
courier_namestringThe name of the carrier partner
account_codestringThe account configured under a carrier partner
account_activebooleanWhether the carrier account is active or not
Language
Click Try It! to start a request and see the response here!