Overview

​

Introduction

• The Argyle API is built on RESTful principles.
• The API operates over HTTPS to ensure the security of data being transferred.
• All requests and responses are sent in JSON.

• Visit our API Reference to learn more about each endpoint, and see example requests and responses.
• Subscribe to our Changelog to receive updates on changes to the API.

​

Creating API keys

​

Authentication

• username — api_key_id
• password — api_key_secret

​

Example

$ curl https://api-sandbox.argyle.com/v2/accounts \
  -u api_key_id: api_key_secret

​

Environments

​

Data availability

​

Fact data

• Available soon after a payroll connection.
• Static information that tends to change less over time.

​

Event data

• Retrieved and made available from most recent to least recent.
• Time-dependent information that can go back a number of years.

​

Breaking changes

• Changing authentication or authorization requirements
• Removing or re-naming an endpoint
• Removing or re-naming a webhook
• Removing or re-naming a required request parameter
• Adding a required request parameter (including previously optional parameters)
• Removing or re-naming any field name (including objects, arrays, or individual properties)
• Changing the type of any field, request parameter, or query parameter

• Adding an endpoint
• Adding a webhook
• Adding an optional request parameter
• Adding additional response fields (including objects, arrays, or individual properties)
• Returning new response field values
• Returning additional enum values, including new errors
• Changes to error messages
• Fixes to HTTP response codes from an incorrect code to a correct code

​

Security

• Only invoke the Argyle API from your own server-side applications.
• Avoid including or adding checks for your API keys in client-side code.
• Store API keys in environment variables or files outside your application’s source tree, instead of embedding them directly in your application.
  Storing API keys outside your application’s source tree is particularly important if you use a public source code management system such as Github.
• Use one set of API keys for each backend system on your platform. This limits the scope of compromised API keys.
• Delete unused API keys.

​

System status

​

Status codes

​

Error responses

​

Example

{ "detail": "Authentication credentials were not provided." }

​

Example

// Example error response when creating a new webhook:
{ "name": ["This field may not be blank."], "url": ["Enter a valid URL."] }

​

Null values

• The data source does not support that field.
• The data source supports the field, but no information is present.

​

Example

{
    "...",
        "address": {
            "line1": "759 Victoria Plaza",
            "line2": null,
            "state": "NY",
            "country": "US",
            "postal_code": "10014"
        },
        "first_name": "Bob",
        "last_name": "Jones",
        "marital_status": null,
    "..."
}

​

Pagination

// List users - GET https://api-sandbox.argyle.com/v2/users

{
    "next": "https://api-sandbox.argyle.com/v2/users?cursor=bC0yMDIzLTAyLTA5KzE2JTNCMzAlM0EzNC43MDU0MDMlMkIwMCUzQTAw",
    "previous": null,
    "results": [
        { "..." },
        { "..." }
    [
}

​

Rate limiting

​

Concurrency