TOtoggl
clients

List clients

List clients from workspace.

get/workspaces/{workspace_id}/clients

Request

Path parameters

workspace_idinteger required

Numeric ID of the workspace

Query parameters

statusstring

Use 'active' to only list active clients, 'archived' to only list archived clients and 'both' to retrieve active and archived clients. If not provided, only active clients are returned.

namestring

If provided, allows to filter by client name in a case insensitive manner, returning all the ones that contain the given string.

Response

Successful operation.

archivedboolean

IsArchived is true if the client is archived

atstring

When was the last update

creator_idinteger

CreatorID is the ID of the user who created the client

guidstring

GUID is a unique identifier for the client

idinteger

Client ID

namestring

Name of the client

permissionsstring

List of authorization permissions for this client.

server_deleted_atstring

When was deleted, null if not deleted

widinteger

Workspace ID

Changes

No recorded changes to this operation across all 1 revision of this API.