Argyle9a25 Employments API
The Employments API from Argyle9a25 — 1 operation(s) for employments.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/argyle9a25:argyle9a25-employments-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Argyle Employments API
description: Argyle OpenAPI spec
version: 1.0.111
servers:
- url: https://api-sandbox.argyle.com/v2
description: Sandbox
- url: https://api.argyle.com/v2
description: Production
security:
- basicAuth: []
tags:
- name: Employments
paths:
/employments:
get:
summary: List all employments
description: Returns a paginated list of all employment objects.
parameters:
- in: query
name: user
schema:
type: string
format: uuid
required: false
description: Filter by user ID.
- in: query
name: account
schema:
type: string
format: uuid
required: false
description: Filter by account ID.
- in: query
name: limit
schema:
type: integer
description: 'Number of employment objects returned [per page](/api-guide/overview#pagination). Default: 10. Maximum: 200.'
- in: query
name: cursor
schema:
type: string
description: The URL returned in `next` or `previous` used to retrieve another [page](/api-guide/overview#pagination) of results.
responses:
'200':
description: A list of employment objects.
content:
application/json:
schema:
type: object
properties:
next:
type:
- string
- 'null'
format: uri
description: URL for the next page of results, if available.
previous:
type:
- string
- 'null'
format: uri
description: URL for the previous page of results, if available.
results:
type: array
items:
$ref: '#/components/schemas/Employment'
example:
next: https://api-sandbox.argyle.com/v2/employments?cursor=ZXhhbXBsZV9jdXJzb3I
previous: null
results:
- id: 0186a27d-e5c6-735a-a359-6315b34d544c
user: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
account: 0187c66e-e7e5-811c-b006-2232f00f426a
created_at: '2023-01-30T12:53:24.561Z'
employer: Whole Goods
employment_status: active
origin: retrieved
- id: 0183d52a-d3b2-331d-c753-3662a20e352b
user: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
account: 0183d52b-a0c3-599a-e901-3676a20a533f
created_at: '2023-01-30T12:53:24.561Z'
employer: Double Double
employment_status: inactive
origin: acquired
- id: 0183d52a-d3b2-331d-c753-3662a20e352b
user: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
account: 0175a40a-b3b4-622b-a339-8855c57b226e
created_at: '2023-01-30T12:53:24.561Z'
employer: Half Bads
employment_status: inactive
origin: retrieved
- id: 0183d52a-d3b2-331d-c753-3662a20e352b
user: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
account: 0175a40a-b3b4-622b-a339-8855c57b226e
created_at: '2023-01-30T12:53:24.561Z'
employer: Stardollars LLC
employment_status: inactive
origin: retrieved
operationId: getEmployments
tags:
- Employments
components:
schemas:
Employment:
type: object
example:
id: 0183d52a-d3b2-331d-c753-3662a20e352b
user: 018051aa-f7a9-a0db-2f38-6cfa325e9d69
account: 0187c66e-e7e5-811c-b006-2232f00f426a
created_at: '2023-01-30T12:53:24.561Z'
employer: Whole Goods
employment_status: active
origin: retrieved
properties:
id:
type: string
format: uuid
description: 'Unique ID of the employment.
Can be used to filter the following data sets:
- [Identities](/api-reference/identities#list)
- [Paystubs](/api-reference/paystubs#list)
- [Payroll Documents](/api-reference/payroll-documents#list)
'
account:
type: string
format: uuid
description: ID of the account associated with the employment.
user:
type: string
format: uuid
description: ID of the user associated with the employment.
created_at:
type: string
format: date-time
description: Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the employment object was created.
employer:
type: string
description: Employer name on the most recent <a href="/api-reference/paystubs#object-employer">paystub</a> associated with the employment.
employment_status:
type: string
enum:
- active
- inactive
- terminated
description: 'Job status of the employment.
`inactive` and `terminated` definitions vary by Item and can overlap.
`inactive` typically indicates the employee left voluntarily, is on leave, or has not been active for a certain period of time.
`terminated` typically indicates the employee is no longer employed. Specific reasons for termination, if available, are returned in the `termination_reason` field.
We recommend using data from the `/paystubs` and `/gigs` endpoints to construct a more wholistic timeline of employment history.
'
origin:
type: string
enum:
- retrieved
- acquired
description: 'Whether the employment was defined by the connected payroll system or paystubs.
- `retrieved` - Employment defined by the connected payroll system.
- `acquired` - Employment defined by retrieved paystubs.
'
securitySchemes:
basicAuth:
type: http
scheme: basic
description: Username = api_key_id, Password = api_key_secret
x-provenance:
method: harvested
publisher: Argyle9a25
source: https://docs.argyle.com/openAPI/argyle-all.yaml
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)