Chilkat Online Tools

Ruby / Broker API / All Accounts

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

http.put_BasicAuth(true)
http.put_Login("{{api_key}}")
http.put_Password("{{api_secret}}")

sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://domain.com/v1/accounts",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

print "Response status code = " + http.get_LastStatus().to_s() + "\n";
print sbResponseBody.getAsString() + "\n";

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": [
  ]
}