--- title: "Retrieves a list of the users in an account." slug: "retrieves-a-list-of-the-users-in-an-account" updated: 2026-03-25T18:59:21Z published: 2026-03-25T18:59:21Z canonical: "docs.onespan.com/retrieves-a-list-of-the-users-in-an-account" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.onespan.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieves a list of the users in an account. Get/api/account/senders Retrieves a list of the users in an account. Optional query parameters can be used to filter the list. By default, only one sender is retrieved. To retrieve additional users you must modify the “to” and “from” parameters, where each number in the parameter corresponds to a user. For example: to = 3 from = 10 Will return users 3 to 10 in the user list. SecurityAPI Key: ApiKeyAuthHeader parameter nameAuthorization Please type "Basic " followed by the Api Key found in your OneSpan Sign admin section. For example: **Basic UGxlYXNlIHVzZSB5b3VyIG93biBrZXksIG5vdCB0aGlzIGV4YW1wbGUgb25lIDstKQ==** (See [Api Key Documentation](https://community.onespan.com/documentation/onespan-sign/guides/admin-guides/user/integration#API_Key)) API Key: ApiTokenAuthHeader parameter nameAuthorization Please type "Bearer " followed by the access token generate by a call to /apitoken/clientApp/accessToken endpoint. For example: **Bearer 8824a2be8f9c3ad9a71880cd771b52d880fd1845404e0920bb2e43c166770ec7** (See [Api Token Documentation](https://community.onespan.com/documentation/onespan-sign/guides/admin-guides/user/integration#API_Token)) OAuth OAuth2 Bearer token authentication for accessing OneSpan Sign API. Use the client credentials flow to obtain an access token from /oauth2/token. FlowClient Credentials Token URL/oauth2/token Query parameterssearchstring Any text which is going to be used in conjunction with the searchtype if provided frominteger (int32) The first record that will be returned. Useful for pagination. Minimum0 tointeger (int32) The last record that will be returned. Useful for pagination. dirstring The direction according to which the data will be sorted. 'asc' for ascending and 'desc' for descending. Valid values[ "asc", "desc" ] roleIdstring The unique role id for a category of senders. Responses200 OK Expand Allobject countinteger Minimum0 results Array of object (Sender) The senders list object namestring Name typestring Type Valid values[ "REGULAR", "MANAGER" ] signatureobject (SignatureStyle) handdrawnstring Handdrawn textualobject (TextualSignatureStyle) colorstring Color fontstring Font statusstring Status Valid values[ "INVITED", "ACTIVE", "LOCKED" ] accountobject (Account) namestring The name of the account. createdstring (date-time) The date and time that the account was created. ownerstring The account owner's unique identification number. ExampleOhONEdotwte12 idstring The account's unique identification number. ExampleAhONEdspank23 dataobject Data property*object additionalProperties customFields Array of object (CustomField) CustomFields object valuestring Value namestring Name idstring Id requiredboolean Required dataobject Data property*object additionalProperties translations Array of object (Translation) Translations object dataobject Data property*object additionalProperties descriptionstring Description idstring Id languagestring Language namestring Name providersobject (AccountProviders) documents Array of object (Provider) Documents object namestring Name idstring Id dataobject Data property*object additionalProperties providesstring Provides users Array of object (Provider) Users object namestring Name idstring Id dataobject Data property*object additionalProperties providesstring Provides timezoneIdstring The default time zone Id of the time zone configured for a transaction in an account. Visible time components, like the signature time stamp and date fields, will format and display according to the specified time zone. Default"GMT"ExampleAmerica/Toronto licenses Array of object (License) Licenses object statusstring Status Valid values[ "ACTIVE", "PENDING", "GRACE" ] createdstring (date-time) Created transactions Array of object (Transaction) Transactions object createdstring (date-time) Created priceobject (Price) currencyobject (Currency) namestring Name idstring Id dataobject Data property*object additionalProperties amountinteger (int32) Amount creditCardobject (CreditCard) namestring Name typestring Type numberstring Number expirationobject (CcExpiration) yearinteger (int32) Year monthinteger (int32) Month cvvstring Cvv paidUntilstring (date-time) PaidUntil planobject (Plan) namestring Name cyclestring Cycle Valid values[ "DAY", "MONTH", "YEAR" ] descriptionstring Description featuresobject Features property*object additionalProperties idstring Id dataobject Data property*object additionalProperties groupstring Group priceobject (Price) currencyobject (Currency) namestring Name idstring Id dataobject Data property*object additionalProperties amountinteger (int32) Amount contractstring Contract Valid values[ "DAY", "MONTH", "YEAR" ] freeCyclesobject (CycleCount) cyclestring Cycle Valid values[ "DAY", "MONTH", "YEAR" ] countinteger (int32) Count quotas Array of object (Quota) Quotas object targetstring Target Valid values[ "SIGNER", "SENDER", "DOCUMENT", "PACKAGE", "STORAGE" ] cyclestring Cycle Valid values[ "DAY", "MONTH", "YEAR" ] scopestring Scope Valid values[ "SENDER", "DOCUMENT", "PACKAGE", "ACCOUNT" ] limitinteger (int32) Limit originalstring Original companyobject (Company) addressobject (Address) statestring State countrystring Country citystring City address1string Address1 address2string Address2 zipcodestring Zipcode namestring Name idstring Id dataobject Data property*object additionalProperties updatedstring (date-time) The date and time that the account was updated. logoUrlstring Defines the logo that will be used for the account. logoAltTextKeystring Defines the key that will be used to determine the text read by a screen reader for the logo in ADA mode (used in signing ceremony). addressobject (Address) statestring State countrystring Country citystring City address1string Address1 address2string Address2 zipcodestring Zipcode createdstring (date-time) Created idstring Id dataobject Data property*object additionalProperties languagestring Language timezoneIdstring TimezoneId externalobject (External) idstring Id providerstring Provider providerNamestring ProviderName dataobject Data property*object additionalProperties companystring Company updatedstring (date-time) Updated phonestring Phone userCustomFields Array of object (UserCustomField) UserCustomFields object valuestring Value namestring Name idstring Id dataobject Data property*object additionalProperties translations Array of object (Translation) Translations object dataobject Data property*object additionalProperties descriptionstring Description idstring Id languagestring Language namestring Name professionalIdentityFields Array of object (ProfessionalIdentityField) ProfessionalIdentityFields object valuestring Value namestring Name typestring Type idstring Id dataobject Data property*object additionalProperties categorystring Category translations Array of object (Translation) Translations object dataobject Data property*object additionalProperties descriptionstring Description idstring Id languagestring Language namestring Name titlestring Title firstNamestring FirstName lastNamestring LastName emailstring Email lockedstring (date-time) Locked activatedstring (date-time) Activated memberships Array of object (GroupMembership) Memberships object groupIdstring GroupId groupNamestring GroupName memberTypestring MemberType Valid values[ "REGULAR", "MANAGER" ] specialTypes Array of string Special User Types string Valid values[ "NOTARY" ] hasDelegatesboolean Has Delegates 401 Not Authorized object codeinteger (int32) messageKeystring messagestring default Unexpected error object codeinteger (int32) messageKeystring messagestring