# List accounts

Endpoint: GET /v1/accounts
Version: v1
Security: x-api-key

## Security:

  - `x-api-key` (unknown)
    apiKey in header x-api-key

## Query parameters:

  - `email` (string)
    Filter by email address. Accepts partial email addresses for wildcard searches.

  - `appType` (string)
    Filter by the app associated with this account.

  - `employeeId` (string)
    Filter by an employee ID associated with this account.

  - `passwordId` (string)
    Filter by a password ID associated with this account.

  - `lastUsedTimestampAfter` (integer)
    Filter by when the account was last used by an employee - start time. This is a UNIX timestamp (in seconds).

  - `lastUsedTimestampBefore` (integer)
    Filter by when the account was last used by an employee - end time. This is a UNIX timestamp (in seconds).

  - `limit` (integer)
    Used for pagination. Number of objects to return.

  - `offset` (integer)
    Used for pagination. Number of objects to skip. Cannot be set when `nextToken` is also set.

  - `nextToken` (string)
    Used for pagination. Token to be used for the next request. Cannot be set when `offset` is also set.

## Response 200:

  - `200` (unknown)
    OK

## Response 200 fields (application/json):

  - `result` (array)

  - `result.id` (string)
    Unique identifier for the account
    Example: d6a32ba5-0532-4a66-8137-48cdf409c972

  - `result.employeeId` (string)
    Identifier of primary employee that this account belongs to
    Example: 72d0347a-2663-4ef5-b1c5-df39163f1603

  - `result.appType` (string)
    The app associated with this account
    Example: ATLASSIAN

  - `result.appId` (string)
    The ID of the app associated with this account
    Example: 2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0

  - `result.email` (string)
    The email address used to log into the account
    Example: john.hill@example.com

  - `result.mfaRegistered` (boolean)
    Whether MFA is registered or not. If unknown, `null` is provided.
    Example: true

  - `result.mfaMethods` (array)
    The MFA methods registered for this account

  - `result.passwordId` (string)
    Identifier of the password used on this account. The actual password is not sent up by the browser extension and so this is an identifier for it instead. This value is `null` if password authentication is not used.
    Example: 4c13674f-e88a-4411-bfa2-53a70468a898

  - `result.loginMethods` (object)

  - `result.loginMethods.passwordLogin` (boolean)
    Whether or not this account has been logged into with a password
    Example: true

  - `result.loginMethods.lastPasswordLoginTimestamp` (integer)
    When the account was last logged into using a password, formatted as a UNIX timestamp (in seconds)
    Example: 1698064423

  - `result.loginMethods.oidcLogin` (string)
    The identity provider that was used to do an OIDC login on this account. This is `null` if no OIDC login has been performed.
    Example: GOOGLE_WORKSPACE

  - `result.loginMethods.lastOidcLoginTimestamp` (integer)
    When the account was last logged into using OIDC, formatted as a UNIX timestamp (in seconds)
    Example: 1698064423

  - `result.loginMethods.samlLogin` (string)
    The identity provider that was used to do a SAML login on this account. This is `null` if no SAML login has been performed.
    Example: OKTA

  - `result.loginMethods.lastSamlLoginTimestamp` (integer)
    When the account was last logged into using SAML, formatted as a UNIX timestamp (in seconds)
    Example: 1698064423

  - `result.loginMethods.oktaSwaLogin` (boolean)
    Whether or not this account has been logged into with Okta SWA
    Example: true

  - `result.loginMethods.lastOktaSwaLoginTimestamp` (integer)
    When the account was last logged into using Okta SWA, formatted as a UNIX timestamp (in seconds)
    Example: 1698064423

  - `result.loginMethods.vendorSsoLogin` (string)
    Whether or not this account has an associated vendor SSO provider.
    Example: GOOGLE_WORKSPACE

  - `result.loginMethods.fedCmLogin` (string)
    The identity provider that was used to do a FedCM login on this account. This is `null` if no FedCM login has been performed.
    Example: GOOGLE_WORKSPACE

  - `result.loginMethods.lastFedCmLoginTimestamp` (integer)
    When the account was last logged into using FedCM, formatted as a UNIX timestamp (in seconds)
    Example: 1698064423

  - `result.creationTimestamp` (integer)
    When this account was created, formatted as a UNIX timestamp (in seconds)
    Example: 1698064423

  - `result.lastUsedTimestamp` (integer)
    When the account was last used by an employee, formatted as a UNIX timestamp (in seconds)
    Example: 1698669168

  - `paging` (object)

  - `paging.moreResults` (boolean)
    Whether there are more results available
    Example: true

  - `paging.next` (string)
    Start of the next page that can be used as the `offset` for the next request
    Example: 501

  - `paging.nextToken` (string)
    Start of the next page that can be used as the `nextToken` for the next request.
    Example: 0b9972aa-fe8d-4095-82d3-2e13cf3cfd43

## Response 400:

  - `400` (unknown)
    Bad Request

## Response 422:

  - `422` (unknown)
    The requested page of results is larger than the 1MB response size limit. Lower the `limit` parameter.

