List System Accounts
Returns an array of system accounts (SA) in the organization. Returns 400 if any filter parameters are invalid.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Filter system accounts returned in the response.
Show Child Parameters
Response
application/json
Response
A paginated list response for a collection of system accounts.
returns the pagination information
Show Child Parameters
Schema of the system account.
Example:{"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}
Show Child Parameters
Authentication
Query Parameters
Create System Account
Creates a system account. Returns a 409 if a system account with the same name already exists.
Body
application/json
Body
The request schema to create a system account.
Name of the system account.
Description of the system account. Useful when the system account name is not sufficient to differentiate one system account from another.
The system account is managed by Konnect (true/false).
Response
application/json
Response
A response including a single system account.
System Account
Schema of the system account.
ID of the system account.
Name of the system account.
Description of the system account.
Timestamp of when the system account was created.
Timestamp of when the system account was last updated.
The system account is managed by Konnect (true/false).
Authentication
Body
Get a System Account
Returns the system account (SA) for the SA ID specified as a path parameter.
Path Parameters
ID of the system account.
Response
application/json
Response
A response including a single system account.
System Account
Schema of the system account.
ID of the system account.
Name of the system account.
Description of the system account.
Timestamp of when the system account was created.
Timestamp of when the system account was last updated.
The system account is managed by Konnect (true/false).
Authentication
Path Parameters
Update System Account
Updates the specified system account. Returns a 409 if the updated name is the same as another system account in the organization.
Path Parameters
ID of the system account.
Body
application/json
Body
The request schema for the update system account request.
Name of the system account.
Description of the system account.
Response
application/json
Response
A response including a single system account.
System Account
Schema of the system account.
ID of the system account.
Name of the system account.
Description of the system account.
Timestamp of when the system account was created.
Timestamp of when the system account was last updated.
The system account is managed by Konnect (true/false).
Authentication
Path Parameters
Body
Delete System Account
Deletes the specified system account. Returns 404 if the requested account was not found.
Path Parameters
ID of the system account.
Response
Response
No Content