PureBasic / Broker API / All Accounts
Back to Collection Items
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::setCkBasicAuth(http, 1)
CkHttp::setCkLogin(http, "{{api_key}}")
CkHttp::setCkPassword(http, "{{api_secret}}")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://domain.com/v1/accounts",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
Debug "Response status code = " + Str(CkHttp::ckLastStatus(http))
Debug CkStringBuilder::ckGetAsString(sbResponseBody)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndProcedure
Curl Command
curl -X GET
-u '{{api_key}}:{{api_secret}}'
https://domain.com/v1/accounts
Postman Collection Item JSON
{
"name": "All Accounts",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{HOST}}/v1/accounts",
"host": [
"{{HOST}}"
],
"path": [
"v1",
"accounts"
],
"query": [
{
"key": "query",
"value": "John Doe",
"description": "Pass space-delimited tokens. The response will contain accounts that match with each of the tokens (logical AND). A match means the token is present in either the account’s associated account number, phone number, name, or e-mail address (logical OR).",
"disabled": true
},
{
"key": "created_after",
"value": "2021-09-09T0:00:00Z",
"disabled": true
},
{
"key": "created_before",
"value": "2021-09-09T0:00:00Z",
"disabled": true
},
{
"key": "status",
"value": "ACTIVE",
"description": "ENUM.AccountStatus",
"disabled": true
},
{
"key": "sort",
"value": "asc",
"description": "asc or desc. Defaults to desc",
"disabled": true
},
{
"key": "entities",
"value": null,
"description": "Comma-delimited entity names to include in the response",
"disabled": true
}
]
}
},
"response": [
]
}