Accounts API

get listing

GET /api/rest/admin/accounts

Parameters

Name Description
filter[id] id filter
filter[name] name filter
filter[name-eq] name eq filter
filter[name-not-eq] name not eq filter
filter[name-cont] name cont filter
filter[name-start] name start filter
filter[name-end] name end filter
filter[name-in] name in filter
filter[name-not-in] name not in filter
filter[name-cont-any] name cont any filter
filter[balance-eq] balance eq filter
filter[balance-not-eq] balance not eq filter
filter[balance-gt] balance gt filter
filter[balance-gteq] balance gteq filter
filter[balance-lt] balance lt filter
filter[balance-lteq] balance lteq filter
filter[balance-in] balance in filter
filter[balance-not-in] balance not in filter
filter[vat-eq] vat eq filter
filter[vat-not-eq] vat not eq filter
filter[vat-gt] vat gt filter
filter[vat-gteq] vat gteq filter
filter[vat-lt] vat lt filter
filter[vat-lteq] vat lteq filter
filter[vat-in] vat in filter
filter[vat-not-in] vat not in filter
filter[min-balance-eq] min balance eq filter
filter[min-balance-not-eq] min balance not eq filter
filter[min-balance-gt] min balance gt filter
filter[min-balance-gteq] min balance gteq filter
filter[min-balance-lt] min balance lt filter
filter[min-balance-lteq] min balance lteq filter
filter[min-balance-in] min balance in filter
filter[min-balance-not-in] min balance not in filter
filter[max-balance-eq] max balance eq filter
filter[max-balance-not-eq] max balance not eq filter
filter[max-balance-gt] max balance gt filter
filter[max-balance-gteq] max balance gteq filter
filter[max-balance-lt] max balance lt filter
filter[max-balance-lteq] max balance lteq filter
filter[max-balance-in] max balance in filter
filter[max-balance-not-in] max balance not in filter
filter[balance-low-threshold-eq] balance low threshold eq filter
filter[balance-low-threshold-not-eq] balance low threshold not eq filter
filter[balance-low-threshold-gt] balance low threshold gt filter
filter[balance-low-threshold-gteq] balance low threshold gteq filter
filter[balance-low-threshold-lt] balance low threshold lt filter
filter[balance-low-threshold-lteq] balance low threshold lteq filter
filter[balance-low-threshold-in] balance low threshold in filter
filter[balance-low-threshold-not-in] balance low threshold not in filter
filter[balance-high-threshold-eq] balance high threshold eq filter
filter[balance-high-threshold-not-eq] balance high threshold not eq filter
filter[balance-high-threshold-gt] balance high threshold gt filter
filter[balance-high-threshold-gteq] balance high threshold gteq filter
filter[balance-high-threshold-lt] balance high threshold lt filter
filter[balance-high-threshold-lteq] balance high threshold lteq filter
filter[balance-high-threshold-in] balance high threshold in filter
filter[balance-high-threshold-not-in] balance high threshold not in filter
filter[destination-rate-limit-eq] destination rate limit eq filter
filter[destination-rate-limit-not-eq] destination rate limit not eq filter
filter[destination-rate-limit-gt] destination rate limit gt filter
filter[destination-rate-limit-gteq] destination rate limit gteq filter
filter[destination-rate-limit-lt] destination rate limit lt filter
filter[destination-rate-limit-lteq] destination rate limit lteq filter
filter[destination-rate-limit-in] destination rate limit in filter
filter[destination-rate-limit-not-in] destination rate limit not in filter
filter[max-call-duration-eq] max call duration eq filter
filter[max-call-duration-not-eq] max call duration not eq filter
filter[max-call-duration-gt] max call duration gt filter
filter[max-call-duration-gteq] max call duration gteq filter
filter[max-call-duration-lt] max call duration lt filter
filter[max-call-duration-lteq] max call duration lteq filter
filter[max-call-duration-in] max call duration in filter
filter[max-call-duration-not-in] max call duration not in filter
filter[external-id-eq] external id eq filter
filter[external-id-not-eq] external id not eq filter
filter[external-id-gt] external id gt filter
filter[external-id-gteq] external id gteq filter
filter[external-id-lt] external id lt filter
filter[external-id-lteq] external id lteq filter
filter[external-id-in] external id in filter
filter[external-id-not-in] external id not in filter
filter[uuid-eq] uuid eq filter
filter[uuid-not-eq] uuid not eq filter
filter[uuid-in] uuid in filter
filter[uuid-not-in] uuid not in filter
filter[origination-capacity-eq] origination capacity eq filter
filter[origination-capacity-not-eq] origination capacity not eq filter
filter[origination-capacity-gt] origination capacity gt filter
filter[origination-capacity-gteq] origination capacity gteq filter
filter[origination-capacity-lt] origination capacity lt filter
filter[origination-capacity-lteq] origination capacity lteq filter
filter[origination-capacity-in] origination capacity in filter
filter[origination-capacity-not-in] origination capacity not in filter
filter[termination-capacity-eq] termination capacity eq filter
filter[termination-capacity-not-eq] termination capacity not eq filter
filter[termination-capacity-gt] termination capacity gt filter
filter[termination-capacity-gteq] termination capacity gteq filter
filter[termination-capacity-lt] termination capacity lt filter
filter[termination-capacity-lteq] termination capacity lteq filter
filter[termination-capacity-in] termination capacity in filter
filter[termination-capacity-not-in] termination capacity not in filter
filter[total-capacity-eq] total capacity eq filter
filter[total-capacity-not-eq] total capacity not eq filter
filter[total-capacity-gt] total capacity gt filter
filter[total-capacity-gteq] total capacity gteq filter
filter[total-capacity-lt] total capacity lt filter
filter[total-capacity-lteq] total capacity lteq filter
filter[total-capacity-in] total capacity in filter
filter[total-capacity-not-in] total capacity not in filter

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3MjEyMzYzMDUsInN1YiI6MTJ9.PDQF0cPlMWA5Aa1RIowyA_fb0jaHSov-QO8j3K-HW5c
Host: example.org
Cookie: 

Route

GET /api/rest/admin/accounts

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/vnd.api+json
Vary: Accept
ETag: W/"b1f64185f292e8e2c817ff9069c6b383"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: f2d39e6f-55a2-4526-ab54-a4d29a178095
X-Runtime: 0.023163
Content-Length: 2394

Status

200 OK

Body

{
  "data": [
    {
      "id": "20",
      "type": "accounts",
      "links": {
        "self": "http://example.org/api/rest/admin/accounts/20"
      },
      "attributes": {
        "name": "account1",
        "balance": "0.0",
        "min-balance": "0.0",
        "max-balance": "0.0",
        "vat": "23.1",
        "balance-low-threshold": null,
        "balance-high-threshold": null,
        "send-balance-notifications-to": null,
        "destination-rate-limit": "0.3444",
        "max-call-duration": 36000,
        "external-id": null,
        "uuid": "3f3db864-445e-11ef-b3ec-0242ac120003",
        "origination-capacity": 1,
        "termination-capacity": 2,
        "total-capacity": 5,
        "send-invoices-to": null,
        "invoice-period": null
      },
      "relationships": {
        "contractor": {
          "links": {
            "self": "http://example.org/api/rest/admin/accounts/20/relationships/contractor",
            "related": "http://example.org/api/rest/admin/accounts/20/contractor"
          }
        },
        "timezone": {
          "links": {
            "self": "http://example.org/api/rest/admin/accounts/20/relationships/timezone",
            "related": "http://example.org/api/rest/admin/accounts/20/timezone"
          }
        },
        "invoice-template": {
          "links": {
            "self": "http://example.org/api/rest/admin/accounts/20/relationships/invoice-template",
            "related": "http://example.org/api/rest/admin/accounts/20/invoice-template"
          }
        }
      }
    },
    {
      "id": "21",
      "type": "accounts",
      "links": {
        "self": "http://example.org/api/rest/admin/accounts/21"
      },
      "attributes": {
        "name": "account2",
        "balance": "0.0",
        "min-balance": "0.0",
        "max-balance": "0.0",
        "vat": "23.1",
        "balance-low-threshold": null,
        "balance-high-threshold": null,
        "send-balance-notifications-to": null,
        "destination-rate-limit": "0.3444",
        "max-call-duration": 36000,
        "external-id": null,
        "uuid": "3f601990-445e-11ef-b3ec-0242ac120003",
        "origination-capacity": 1,
        "termination-capacity": 2,
        "total-capacity": 5,
        "send-invoices-to": null,
        "invoice-period": null
      },
      "relationships": {
        "contractor": {
          "links": {
            "self": "http://example.org/api/rest/admin/accounts/21/relationships/contractor",
            "related": "http://example.org/api/rest/admin/accounts/21/contractor"
          }
        },
        "timezone": {
          "links": {
            "self": "http://example.org/api/rest/admin/accounts/21/relationships/timezone",
            "related": "http://example.org/api/rest/admin/accounts/21/timezone"
          }
        },
        "invoice-template": {
          "links": {
            "self": "http://example.org/api/rest/admin/accounts/21/relationships/invoice-template",
            "related": "http://example.org/api/rest/admin/accounts/21/invoice-template"
          }
        }
      }
    }
  ],
  "meta": {
    "total-count": 2
  },
  "links": {
    "first": "http://example.org/api/rest/admin/accounts?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/admin/accounts?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}