Sign in
System Accounts

List System Accounts

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

get/v3/system-accounts

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

Changed in 4 of the 75 revisions of this API.153

  • 8ab3ec3ed3011See the full diff
    • ●

      added the new type enum value to the allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/rule response property for the response status 400

      response-property-enum-value-added

  • 3c0154b2053a13See the full diff
    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterChoiceItem]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterDependentItem]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMaximumLength]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMinimumLength]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property data became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/items/description became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/items/konnect_managed became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/items/name became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property detail became nullable for the status 403

      response-property-became-nullable

    • ▲

      the response property instance became nullable for the status 403

      response-property-became-nullable

    • ▲

      the response property status became nullable for the status 403

      response-property-became-nullable

    • ▲

      the response property title became nullable for the status 403

      response-property-became-nullable

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6333a0d3b0952See the full diff
    • ▲

      for the query request parameter filter, the type/format of property description was specialized from / to object/

      request-parameter-property-type-specialized

    • ▲

      for the query request parameter filter, the type/format of property name was specialized from / to object/

      request-parameter-property-type-specialized

    This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 76b0fefddb0d2See the full diff
    • ●

      for the query request parameter filter, the type/format of property description was changed from object/ to /

      request-parameter-property-type-changed

    • ●

      for the query request parameter filter, the type/format of property name was changed from object/ to /

      request-parameter-property-type-changed