GET api/ClientManagement/Clients/Search?q={q}&organizationId={organizationId}&limit={limit}&offset={offset}

Search for clients.

Request Information

URI Parameters

Name	Description	Type	Additional information
q	The name of the client to filter on.	string	None.
organizationId	The organization identifier.	integer	None.
limit	The limit.	integer	None.
offset	The offset.	integer	Default value is 0

Body Parameters

None.

Response Information

Resource Description

The list of clients that resulted from the search.

Collection of ESignSystems.SmartSAFE.Models.ClientManagement.ClientModel

Name	Description	Type	Additional information
ClientId	Gets or sets the client's client identifier.	integer	None.
OrganizationId	Gets or sets the client's organization identifier.	integer	None.
ClientName	Gets or sets the client's name.	string	None.
Phone	Gets or sets the client's phone number.	string	None.
Email	Gets or sets the client's email address.	string	None.
Active	Gets or sets a value indicating whether the client is active.	boolean	None.
TransferIdentifier	Gets or sets the SmartTRANSFER identifier.	string	None.
SmartTRANSFERUrl	Gets or sets the SmartTRANSFER Url.	string	None.
RootFolderId	Gets or sets the root folder id.	integer	None.
NewClientAdmin	When creating a new client, gets or sets the user that will be created as the client's default client admin. When saving an existing client, property is not used.	ESignSystems.SmartSAFE.Models.Admin.UserManagement.RegisterModel	None.
UpdatedBy	Gets or sets the name of the user that updated the model.	string	None.
UpdatedDate	Gets or sets the date an time that the model was updated.	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ClientId": 1,
    "OrganizationId": 1,
    "ClientName": "sample string 1",
    "Phone": "sample string 2",
    "Email": "sample string 3",
    "Active": true,
    "TransferIdentifier": "sample string 5",
    "SmartTRANSFERUrl": "sample string 6",
    "RootFolderId": 1,
    "NewClientAdmin": {
      "Password": "sample string 1",
      "ConfirmPassword": "sample string 2",
      "ClientId": 1,
      "OrganizationId": 1,
      "UserName": "sample string 3",
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "Email": "sample string 6",
      "PhoneNumber": "sample string 7",
      "Active": true,
      "LockedOut": true,
      "SignatureFont": "sample string 10",
      "IsAdmin": true,
      "RequiresPasswordChange": true,
      "SignatureImage": {
        "UserId": 1,
        "SignatureImage": "sample string 2",
        "InitialsImage": "sample string 3"
      },
      "Permissions": [
        {
          "PermissionAssignmentId": 1,
          "PermissionId": 1,
          "UserId": 1,
          "UserName": "sample string 1",
          "FirstName": "sample string 2",
          "LastName": "sample string 3",
          "Email": "sample string 4",
          "OrganizationName": "sample string 5",
          "ClientName": "sample string 6",
          "IsDeleted": true
        },
        {
          "PermissionAssignmentId": 1,
          "PermissionId": 1,
          "UserId": 1,
          "UserName": "sample string 1",
          "FirstName": "sample string 2",
          "LastName": "sample string 3",
          "Email": "sample string 4",
          "OrganizationName": "sample string 5",
          "ClientName": "sample string 6",
          "IsDeleted": true
        }
      ],
      "Clients": [
        {
          "UserClientAssignmentId": 1,
          "UserId": 1,
          "ClientId": 1,
          "ClientName": "sample string 1",
          "OrganizationId": 1,
          "IsDeleted": true
        },
        {
          "UserClientAssignmentId": 1,
          "UserId": 1,
          "ClientId": 1,
          "ClientName": "sample string 1",
          "OrganizationId": 1,
          "IsDeleted": true
        }
      ],
      "CustodianId": "sample string 13"
    },
    "UpdatedBy": "sample string 7",
    "UpdatedDate": "2024-11-26T10:11:46.524125-05:00"
  },
  {
    "ClientId": 1,
    "OrganizationId": 1,
    "ClientName": "sample string 1",
    "Phone": "sample string 2",
    "Email": "sample string 3",
    "Active": true,
    "TransferIdentifier": "sample string 5",
    "SmartTRANSFERUrl": "sample string 6",
    "RootFolderId": 1,
    "NewClientAdmin": {
      "Password": "sample string 1",
      "ConfirmPassword": "sample string 2",
      "ClientId": 1,
      "OrganizationId": 1,
      "UserName": "sample string 3",
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "Email": "sample string 6",
      "PhoneNumber": "sample string 7",
      "Active": true,
      "LockedOut": true,
      "SignatureFont": "sample string 10",
      "IsAdmin": true,
      "RequiresPasswordChange": true,
      "SignatureImage": {
        "UserId": 1,
        "SignatureImage": "sample string 2",
        "InitialsImage": "sample string 3"
      },
      "Permissions": [
        {
          "PermissionAssignmentId": 1,
          "PermissionId": 1,
          "UserId": 1,
          "UserName": "sample string 1",
          "FirstName": "sample string 2",
          "LastName": "sample string 3",
          "Email": "sample string 4",
          "OrganizationName": "sample string 5",
          "ClientName": "sample string 6",
          "IsDeleted": true
        },
        {
          "PermissionAssignmentId": 1,
          "PermissionId": 1,
          "UserId": 1,
          "UserName": "sample string 1",
          "FirstName": "sample string 2",
          "LastName": "sample string 3",
          "Email": "sample string 4",
          "OrganizationName": "sample string 5",
          "ClientName": "sample string 6",
          "IsDeleted": true
        }
      ],
      "Clients": [
        {
          "UserClientAssignmentId": 1,
          "UserId": 1,
          "ClientId": 1,
          "ClientName": "sample string 1",
          "OrganizationId": 1,
          "IsDeleted": true
        },
        {
          "UserClientAssignmentId": 1,
          "UserId": 1,
          "ClientId": 1,
          "ClientName": "sample string 1",
          "OrganizationId": 1,
          "IsDeleted": true
        }
      ],
      "CustodianId": "sample string 13"
    },
    "UpdatedBy": "sample string 7",
    "UpdatedDate": "2024-11-26T10:11:46.524125-05:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfClientModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.ClientManagement">
  <ClientModel>
    <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 7</UpdatedBy>
    <UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2024-11-26T10:11:46.524125-05:00</UpdatedDate>
    <Active>true</Active>
    <ClientId>1</ClientId>
    <ClientName>sample string 1</ClientName>
    <Email>sample string 3</Email>
    <NewClientAdmin xmlns:d3p1="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Admin.UserManagement">
      <d3p1:Active>true</d3p1:Active>
      <d3p1:ClientId>1</d3p1:ClientId>
      <d3p1:Clients xmlns:d4p1="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Security">
        <d4p1:UserClientAssignmentModel>
          <d4p1:ClientId>1</d4p1:ClientId>
          <d4p1:ClientName>sample string 1</d4p1:ClientName>
          <d4p1:IsDeleted>true</d4p1:IsDeleted>
          <d4p1:OrganizationId>1</d4p1:OrganizationId>
          <d4p1:UserClientAssignmentId>1</d4p1:UserClientAssignmentId>
          <d4p1:UserId>1</d4p1:UserId>
        </d4p1:UserClientAssignmentModel>
        <d4p1:UserClientAssignmentModel>
          <d4p1:ClientId>1</d4p1:ClientId>
          <d4p1:ClientName>sample string 1</d4p1:ClientName>
          <d4p1:IsDeleted>true</d4p1:IsDeleted>
          <d4p1:OrganizationId>1</d4p1:OrganizationId>
          <d4p1:UserClientAssignmentId>1</d4p1:UserClientAssignmentId>
          <d4p1:UserId>1</d4p1:UserId>
        </d4p1:UserClientAssignmentModel>
      </d3p1:Clients>
      <d3p1:CustodianId>sample string 13</d3p1:CustodianId>
      <d3p1:Email>sample string 6</d3p1:Email>
      <d3p1:FirstName>sample string 4</d3p1:FirstName>
      <d3p1:IsAdmin>true</d3p1:IsAdmin>
      <d3p1:LastName>sample string 5</d3p1:LastName>
      <d3p1:LockedOut>true</d3p1:LockedOut>
      <d3p1:OrganizationId>1</d3p1:OrganizationId>
      <d3p1:Permissions xmlns:d4p1="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Security">
        <d4p1:PermissionAssignmentModel>
          <d4p1:ClientName>sample string 6</d4p1:ClientName>
          <d4p1:Email>sample string 4</d4p1:Email>
          <d4p1:FirstName>sample string 2</d4p1:FirstName>
          <d4p1:IsDeleted>true</d4p1:IsDeleted>
          <d4p1:LastName>sample string 3</d4p1:LastName>
          <d4p1:OrganizationName>sample string 5</d4p1:OrganizationName>
          <d4p1:PermissionAssignmentId>1</d4p1:PermissionAssignmentId>
          <d4p1:PermissionId>1</d4p1:PermissionId>
          <d4p1:UserId>1</d4p1:UserId>
          <d4p1:UserName>sample string 1</d4p1:UserName>
        </d4p1:PermissionAssignmentModel>
        <d4p1:PermissionAssignmentModel>
          <d4p1:ClientName>sample string 6</d4p1:ClientName>
          <d4p1:Email>sample string 4</d4p1:Email>
          <d4p1:FirstName>sample string 2</d4p1:FirstName>
          <d4p1:IsDeleted>true</d4p1:IsDeleted>
          <d4p1:LastName>sample string 3</d4p1:LastName>
          <d4p1:OrganizationName>sample string 5</d4p1:OrganizationName>
          <d4p1:PermissionAssignmentId>1</d4p1:PermissionAssignmentId>
          <d4p1:PermissionId>1</d4p1:PermissionId>
          <d4p1:UserId>1</d4p1:UserId>
          <d4p1:UserName>sample string 1</d4p1:UserName>
        </d4p1:PermissionAssignmentModel>
      </d3p1:Permissions>
      <d3p1:PhoneNumber>sample string 7</d3p1:PhoneNumber>
      <d3p1:RequiresPasswordChange>true</d3p1:RequiresPasswordChange>
      <d3p1:SignatureFont>sample string 10</d3p1:SignatureFont>
      <d3p1:SignatureImage xmlns:d4p1="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Signing">
        <d4p1:InitialsImage>sample string 3</d4p1:InitialsImage>
        <d4p1:SignatureImage>sample string 2</d4p1:SignatureImage>
        <d4p1:UserId>1</d4p1:UserId>
      </d3p1:SignatureImage>
      <d3p1:UserName>sample string 3</d3p1:UserName>
      <d3p1:ConfirmPassword>sample string 2</d3p1:ConfirmPassword>
      <d3p1:Password>sample string 1</d3p1:Password>
    </NewClientAdmin>
    <OrganizationId>1</OrganizationId>
    <Phone>sample string 2</Phone>
    <RootFolderId>1</RootFolderId>
    <SmartTRANSFERUrl>sample string 6</SmartTRANSFERUrl>
    <TransferIdentifier>sample string 5</TransferIdentifier>
  </ClientModel>
  <ClientModel>
    <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 7</UpdatedBy>
    <UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2024-11-26T10:11:46.524125-05:00</UpdatedDate>
    <Active>true</Active>
    <ClientId>1</ClientId>
    <ClientName>sample string 1</ClientName>
    <Email>sample string 3</Email>
    <NewClientAdmin xmlns:d3p1="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Admin.UserManagement">
      <d3p1:Active>true</d3p1:Active>
      <d3p1:ClientId>1</d3p1:ClientId>
      <d3p1:Clients xmlns:d4p1="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Security">
        <d4p1:UserClientAssignmentModel>
          <d4p1:ClientId>1</d4p1:ClientId>
          <d4p1:ClientName>sample string 1</d4p1:ClientName>
          <d4p1:IsDeleted>true</d4p1:IsDeleted>
          <d4p1:OrganizationId>1</d4p1:OrganizationId>
          <d4p1:UserClientAssignmentId>1</d4p1:UserClientAssignmentId>
          <d4p1:UserId>1</d4p1:UserId>
        </d4p1:UserClientAssignmentModel>
        <d4p1:UserClientAssignmentModel>
          <d4p1:ClientId>1</d4p1:ClientId>
          <d4p1:ClientName>sample string 1</d4p1:ClientName>
          <d4p1:IsDeleted>true</d4p1:IsDeleted>
          <d4p1:OrganizationId>1</d4p1:OrganizationId>
          <d4p1:UserClientAssignmentId>1</d4p1:UserClientAssignmentId>
          <d4p1:UserId>1</d4p1:UserId>
        </d4p1:UserClientAssignmentModel>
      </d3p1:Clients>
      <d3p1:CustodianId>sample string 13</d3p1:CustodianId>
      <d3p1:Email>sample string 6</d3p1:Email>
      <d3p1:FirstName>sample string 4</d3p1:FirstName>
      <d3p1:IsAdmin>true</d3p1:IsAdmin>
      <d3p1:LastName>sample string 5</d3p1:LastName>
      <d3p1:LockedOut>true</d3p1:LockedOut>
      <d3p1:OrganizationId>1</d3p1:OrganizationId>
      <d3p1:Permissions xmlns:d4p1="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Security">
        <d4p1:PermissionAssignmentModel>
          <d4p1:ClientName>sample string 6</d4p1:ClientName>
          <d4p1:Email>sample string 4</d4p1:Email>
          <d4p1:FirstName>sample string 2</d4p1:FirstName>
          <d4p1:IsDeleted>true</d4p1:IsDeleted>
          <d4p1:LastName>sample string 3</d4p1:LastName>
          <d4p1:OrganizationName>sample string 5</d4p1:OrganizationName>
          <d4p1:PermissionAssignmentId>1</d4p1:PermissionAssignmentId>
          <d4p1:PermissionId>1</d4p1:PermissionId>
          <d4p1:UserId>1</d4p1:UserId>
          <d4p1:UserName>sample string 1</d4p1:UserName>
        </d4p1:PermissionAssignmentModel>
        <d4p1:PermissionAssignmentModel>
          <d4p1:ClientName>sample string 6</d4p1:ClientName>
          <d4p1:Email>sample string 4</d4p1:Email>
          <d4p1:FirstName>sample string 2</d4p1:FirstName>
          <d4p1:IsDeleted>true</d4p1:IsDeleted>
          <d4p1:LastName>sample string 3</d4p1:LastName>
          <d4p1:OrganizationName>sample string 5</d4p1:OrganizationName>
          <d4p1:PermissionAssignmentId>1</d4p1:PermissionAssignmentId>
          <d4p1:PermissionId>1</d4p1:PermissionId>
          <d4p1:UserId>1</d4p1:UserId>
          <d4p1:UserName>sample string 1</d4p1:UserName>
        </d4p1:PermissionAssignmentModel>
      </d3p1:Permissions>
      <d3p1:PhoneNumber>sample string 7</d3p1:PhoneNumber>
      <d3p1:RequiresPasswordChange>true</d3p1:RequiresPasswordChange>
      <d3p1:SignatureFont>sample string 10</d3p1:SignatureFont>
      <d3p1:SignatureImage xmlns:d4p1="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Signing">
        <d4p1:InitialsImage>sample string 3</d4p1:InitialsImage>
        <d4p1:SignatureImage>sample string 2</d4p1:SignatureImage>
        <d4p1:UserId>1</d4p1:UserId>
      </d3p1:SignatureImage>
      <d3p1:UserName>sample string 3</d3p1:UserName>
      <d3p1:ConfirmPassword>sample string 2</d3p1:ConfirmPassword>
      <d3p1:Password>sample string 1</d3p1:Password>
    </NewClientAdmin>
    <OrganizationId>1</OrganizationId>
    <Phone>sample string 2</Phone>
    <RootFolderId>1</RootFolderId>
    <SmartTRANSFERUrl>sample string 6</SmartTRANSFERUrl>
    <TransferIdentifier>sample string 5</TransferIdentifier>
  </ClientModel>
</ArrayOfClientModel>