Sign in
Users

List all users

The endpoint returns a list of users.

get/v1/users/

Query parameters

created_at__ltestring

Filter created_at less than or equal (ISO-8601)

created_at__gtestring

Filter created_at greater than or equal (ISO-8601)

product_type'income' | 'employment' | 'deposit_switch' | 'pll' | 'insurance' | 'transactions' | 'assets'
Example:income

Filter by product type.

providerstring

Filter by provider id.

querystring

Search query by the following fields: id, external_user_id, email, first_name, last_name, link_id.

link_existsboolean

If not set, returns all users; otherwise, returns users with/without attempts.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

external_user_idstring

Filter by user external identifier.

list_linksboolean

When set to true, for each user adds the payload from the account links endpoint.

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "results": [
    {
      "id": "24d7e80942ce4ad58a93f70ce4115f5c",
      "external_user_id": "12345",
      "first_name": "John",
      "last_name": "Doe",
      "email": "john.doe@example.com",
      "phone": "+14155554193",
      "ssn": "*****3333",
      "created_at": "2022-05-04T11:30:00Z",
      "updated_at": "2022-05-04T12:00:00Z",
      "links": [
        {
          "id": "48427a36d43c4d5aa6324bc06c692456",
          "access_token": "****************************7610",
          "created_at": "2022-06-07T15:00:00Z",
          "updated_at": "2022-06-30T15:00:00Z",
          "deleted_at": "2022-06-30T15:00:00Z",
          "tracking_info": "user123456",
          "status": "new",
          "user_external_id": "user123456",
          "provider_id": "adp",
          "provider": {
            "id": "adp",
            "name": "ADP"
          },
          "company_mapping": {
            "id": "meta",
            "name": "Meta"
          },
          "link_hash": "bc917458a3da4b2c8cc8282aa1707aaa",
          "allowed_products": [
            "income"
          ],
          "initial_product_type": "income",
          "data_source": "payroll"
        }
      ]
    }
  ]
}

Changes

Changed in 1 of the 11 revisions of this API.56

  • e58688835e2556See the full diff
    • ▲

      the response property results/items/external_user_id became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property results/items/first_name became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property results/items/last_name became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property results/items/ssn became nullable for the status 200

      response-property-became-nullable

    • ▲

      the results/items/links/items/company_mapping/name response property's maxLength was increased from 128 to 255 for the response status 200

      response-property-max-length-increased

    • ●

      added the new credit enum value to the results/items/links/items/allowed_products/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new credit enum value to the results/items/links/items/data_source response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new credit enum value to the results/items/links/items/initial_product_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new education enum value to the results/items/links/items/allowed_products/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new education enum value to the results/items/links/items/data_source response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new education enum value to the results/items/links/items/initial_product_type response property for the response status 200

      response-property-enum-value-added