Retrieve sample employment data

Learn how to retrieve employment data in the sandbox.

Argyle provides you with two ways to access employment data:

Follow this tutorial to learn how to use these methods.

Prerequisites

Before retrieving employment data, you must:

See sample data in Console

Accessing user employment data in Console is easy. Follow these steps:

  1. Navigate to the Your users section of Console.
  2. Select a user to see their employment data.

Retrieve sample data via the API

After your users connect their payroll accounts, your application can start using the Argyle API to retrieve information in their payroll accounts.

The Argyle API uses basic access authentication—you must specify your credentials with every request you make to the API.

Here's an example API call using curl:

curl https://api-sandbox.argyle.com/v1/activities?account=account_id \
-u your_client_id:your_client_secret

Before running the curl command make sure to replace your_client_id and your_client_secret with your own credentials, which you can access in the Argyle Console.

The API call returns a JSON object that contains a list of activities performed by your users such as Uber trips or Instacart deliveries.

Here’s an example response for the example request:

{
    "next": "http://api-sandbox.argyle.com/v1/activities?cursor=YMWjb3...",
    "previous": null,
    "results": [
        {
            "id": "0018cf02-f8d9-4a7b-9876-2f2167a4c0f5",
            "account": "f15eec4c-7b39-48ac-8577-7385456591f4",
            "created_at": "2019-04-19T11:14:13.708Z",
            "start_date": "2018-04-10T06:46:00Z",
            "end_date": "2018-04-10T06:46:00Z",
            "income": {
                "currency": "USD",
                "total_charge": "67.93",
                "fees": "0.00",
          ...
            },
            "income_rates": {
                "hour": "36.18",
                "mile": "6.32",
        ...
            },
        },
     ...
    ]
}

This specific API call returns activities for all of your customers who have connected their payroll accounts through Argyle Link.

To learn more about how to filter activities for a specific user, retrieve other data such as user profiles or a list of your customer's vehicles, refer to the API Reference and Argyle Link documentation.