System Accounts

List System Accounts

Changed on

Returns an array of system accounts (SA) in the organization. Returns 400 if any filter parameters are invalid.

get/v3/system-accounts

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/system-accounts
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Query parameters

page[size]integer
Example:10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]integer
Example:1

Determines which page of the entities to retrieve.

konnect_managedboolean

Filter by a boolean value (true/false).

Filter system accounts returned in the response.

Response

A paginated list response for a collection of system accounts.

Example response

{
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 100
    }
  },
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "Example System Account",
      "description": "This is a sample system account description.",
      "created_at": "2022-08-24T14:15:22Z",
      "updated_at": "2022-10-05T10:33:49Z",
      "konnect_managed": false
    }
  ]
}

Changes

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 68d43091b84dRevision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 401.00 enum value to the response property for the response status