Employer Search

Dedicated endpoint for free-text search implementations.

Use the employer search endpoint to create free-text employer search inputs in your applications.

  • The endpoint returns a list of Items that best match the user's query.
  • Visually display the Item results in your search dropdown. Search results can be continuously updated real-time as the user enters their employer name letter-by-letter.
  • When the user selects the Item that represents their employer, the Item's id returned by the endpoint can be used to directly connect users to that specific Item in Link using the direct login method.

Visit our Employer Search Guide for an in-depth overview, example search demo, and Github sample project.



#The employer search object

Attributes
  • #
    idstring

    Unique ID of the Item. ID format — item_123456789

  • #
    namestring
    Name of the Item.
  • #
    logo_urlstring
    URL location of the Item's logo image file.
  • #
    kindstring (enum)

    Type of Item.

  • #
    mapping_statusstring (enum)

    Verification status of the Item.

  • #
    statusstring (enum)

    Health status of the Item.

Example
1{
2  "id": "item_000000003",
3  "name": "GigAndGo",
4  "logo_url": "argyle.com/image-holdings",
5  "kind": "gig",
6  "mapping_status": "verified",
7  "status": "healthy"
8}

#List all employers

get/v2/employer-search

Returns an array of all Item objects, representing the most relevant search results.

Query parameters
  • #
    qstring
    optional

    Free-text search filter.

  • #
    kindstring
    optional

    Filter by kind value.

  • #
    mapping_statusstring(s)
    optional

    Filter by mapping_status value.

    Multiple mapping_status values can also be searched at once using either method:

    1. /v2/items?mapping_status=verified,mapped
    2. /v2/items?mapping_status=verified&mapping_status=mapped
  • #
    statusstring(s)
    optional

    Filter by status value.

    Multiple status values can also be searched at once using either method:

    1. /v2/items?status=healthy,issues
    2. /v2/items?status=healthy&status=issues

    Filtering by both healthy and issues will return all Items that currently support new payroll connections.

  • #
    limitinteger
    optional

    Number of Item objects returned per page. Default: 10. Maximum: 200.

Example Request
1curl --request GET \
2     --url https://api.argyle.com/v2/employer-search?limit=2 \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
1[
2  {
3    "id": "item_000000002",
4    "name": "Bullseye",
5    "logo_url": "argyle.com/image-holdings",
6    "kind": "employer",
7    "mapping_status": "verified",
8    "status": "unavailable"
9  },
10  {
11    "id": "item_000000003",
12    "name": "Triple",
13    "logo_url": "argyle.com/image-holdings",
14    "kind": "platform",
15    "mapping_status": "mapped",
16    "status": "healthy"
17  }
18]
Updating Argyle status...
© 2025 Argyle Systems Inc.argyle.com