>  Switch To Link 5 and API v2 Documentation

Profiles

Learn about the /profiles endpoint.

Profile objects contain information related to the identity of the user: name, address, contact details, etc. The data in a profile is tied to a payroll account that the user has connected via Argyle Link.


#The profile object

Attributes
  • #
    idstring (uuid)

    Unique ID of the profile associated with a user's payroll account.

  • #
    accountstring (uuid)

    ID of the payroll account associated with the profile.

  • #
    employerstring

    The name of the company or entity that employs the user.

  • #
    first_namestring

    The legal first name of the user.

  • #
    last_namestring

    The legal last name of the user.

  • #
    full_namestring

    The full legal name of the user.

  • #
    emailstring

    Email address.

  • #
    phone_numberstring

    Phone number. Value is returned in the E.164 international phone number format.

  • #
    birth_datestring

    Date of birth. Timestamps follow the ISO 8601 standard.

    In some cases, the payroll provider will obfuscate the birth year and the returned value will be formatted with having a dash instead of the year number: --01-20.

  • #
    picture_urlstring

    Profile picture of the user (if available from the Link item). The value is a URL pointing to the internal storage where the image is held.

  • #
    address.line1string

    Address line 1—for example, street, PO Box, or company name.

  • #
    address.line2string

    Address line 2—for example, apartment, suite, unit, or building.

  • #
    address.citystring

    City, district, suburb, town, or village.

  • #
    address.statestring

    State, county, province, or region.

  • #
    address.postal_codestring

    ZIP or postal code.

  • #
    address.countrystring

    Two-letter country code returned in the ISO 3166-1 alpha-2 format.

  • #
    ssnstring

    Social Security Number.

  • #
    marital_statusstring

    Marital status of the user.

  • #
    genderstring

    Gender of the user.

  • #
    metadataobject

    Metadata holds additional available, often unstructured, information about this data resource.

  • #
    created_atstring (timestamp)

    Time at which the profile object was created. Timestamps follow the ISO 8601 standard.

  • #
    updated_atstring (timestamp)

    Time at which the profile object was last updated. Timestamps follow the ISO 8601 standard.

  • #
    employment_status *DEPRECATEDstring

    Status of employment.


    Now returned in the status field of the /employments endpoint.

  • #
    employment_type *DEPRECATEDstring

    Type of employment (e.g. contractor, part-time, full-time).


    Now returned in the type field of the /employments endpoint.

  • #
    job_title *DEPRECATEDstring

    Current job title.


    Now returned in the job_title field of the /employments endpoint.

  • #
    platform_user_id *DEPRECATEDstring

    A unique ID assigned to a user by a payroll provider.


    Now returned in the platform_user_id field of the /employments endpoint.

  • #
    hire_dates *DEPRECATEDarray of strings

    The dates when the user was hired by the employer.


    Now returned in the hire_datetime field of the /employments endpoint.

  • #
    terminations *DEPRECATEDarray of strings

    Dates and reasons for termination.


    Now returned in the termination_datetime and termination_reason fields of the /employments endpoint.



Example
1{
2  "id": "47b216e2-d334-4235-bc1e-185d15ab18d0",
3  "account": "010db8b4-a724-47fc-a17e-733b656312a2",
4  "employer": "walmart",
5  "created_at": "2019-11-29T09:00:16.384575Z",
6  "updated_at": "2019-11-29T09:00:16.384624Z",
7  "first_name": "John",
8  "last_name": "Smith",
9  "full_name": "John Smith",
10  "email": "[email protected]",
11  "phone_number": "+11234567890",
12  "birth_date": "1990-04-28",
13  "picture_url": "https://profile.picture.com/picture.jpeg",
14  "address": {
15    "line1": "4 Jackson St",
16    "line2": "Apt C",
17    "city": "Norton",
18    "state": "MA",
19    "postal_code": "27660",
20    "country": "US"
21  },
22  "ssn": "***-**-**15",
23  "marital_status": "married",
24  "gender": "male",
25  "metadata": {}
26}

#Retrieve a profile

get/v1/profiles/{id}
  • Retrieve a profile object with the supplied ID.
  • This request returns a profile object if a valid identifier was provided.
Path parameters
  • #
    idstring (uuid)
    required

    The identifier of the profile to be retrieved.

Example Request
1curl --request GET \
2     --url https://api.argyle.com/v1/profiles/{id} \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
1{
2  "id": "0180421b-955a-9f53-6175-ff120a6cd6fc",
3  "account": "0180421b-8908-2251-32a6-8c664912a9f5",
4  "address": {
5    "city": "New York",
6    "line1": "759 Victoria Plaza",
7    "line2": null,
8    "state": "NY",
9    "country": "US",
10    "postal_code": "10014"
11  },
12  "birth_date": "1980-10-10",
13  "email": "[email protected]",
14  "first_name": "Bob",
15  "last_name": "Jones",
16  "full_name": "Bob Jones",
17  "phone_number": "+18009000010",
18  "picture_url": "https://res.cloudinary.com/argyle-media/image/upload/c_lfill,w_auto,g_auto,q_auto,dpr_auto,f_auto/v1566809938/bob-portrait.png",
19  "employment_status": "active",
20  "employment_type": "full-time",
21  "job_title": "1635 - Helpline Agent",
22  "ssn": "522-09-1191",
23  "platform_user_id": "YIIDBLCZDDTGM5IE",
24  "hire_dates": [
25    "2010-08-09T23:10:37Z"
26  ],
27  "terminations": [],
28  "marital_status": "Married filing jointly",
29  "gender": "Male",
30  "employer": "gnomedepot",
31  "metadata": {},
32  "created_at": "2022-04-19T13:55:45.627193Z",
33  "updated_at": "2022-04-19T13:55:45.627232Z"
34}

#List profiles

get/v1/profiles
  • List profile objects.
  • This request returns an object with a results property that contains an array of up to limit profile objects.
Query parameters
  • #
    accountstring (uuid)
    optional

    Return only the profile for the account with the provided ID.

  • #
    userstring (uuid)
    optional

    Return only profiles for the user with the provided ID.

  • #
    limitinteger
    optional

    The number of profile objects to be returned. The default is 10. Max value is 200.

Example Request
1curl --request GET \
2     --url https://api.argyle.com/v1/profiles?limit=2 \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
1[
2  {
3    "id": "0180519e-7123-9871-864a-468ac6198292",
4    "account": "0180519e-64f5-0107-603a-a460f85c2c50",
5    "address": {
6      "city": "New York",
7      "line1": "250 Vesey Street",
8      "line2": null,
9      "state": "NY",
10      "country": "US",
11      "postal_code": "10281"
12    },
13    "birth_date": "1985-04-17",
14    "email": "[email protected]",
15    "first_name": "Sarah",
16    "last_name": "Longfield",
17    "full_name": "Sarah Longfield",
18    "phone_number": "+18009000020",
19    "picture_url": "https://res.cloudinary.com/argyle-media/image/upload/c_lfill,w_auto,g_auto,q_auto,dpr_auto,f_auto/v1566809938/sarah-portrait.png",
20    "employment_status": "active",
21    "employment_type": "part-time",
22    "job_title": "1635 - Helpline Agent",
23    "ssn": "213-53-7066",
24    "platform_user_id": "3TLS6GT3XIKJNZRQ",
25    "hire_dates": [
26      "2014-07-30T19:27:57Z"
27    ],
28    "terminations": [
29      {
30        "date": "2022-05-22T14:12:58Z",
31        "reason": "Poor quality of work."
32      }
33    ],
34    "marital_status": "Married filing jointly",
35    "gender": "Female",
36    "employer": "amazin",
37    "metadata": {},
38    "created_at": "2022-04-22T14:12:59.812165Z",
39    "updated_at": "2022-04-22T14:12:59.812213Z"
40  },
41  {
42    "id": "01805174-19f2-3969-687e-462106a2642b",
43    "account": "01805161-796d-b3f1-a0c0-8250dc01efe4",
44    "address": {
45      "city": "New York",
46      "line1": "759 Victoria Plaza",
47      "line2": null,
48      "state": "NY",
49      "country": "US",
50      "postal_code": "10014"
51    },
52    "birth_date": "1980-10-10",
53    "email": "[email protected]",
54    "first_name": "Bob",
55    "last_name": "Jones",
56    "full_name": "Bob Jones",
57    "phone_number": "+18009000010",
58    "picture_url": "https://res.cloudinary.com/argyle-media/image/upload/c_lfill,w_auto,g_auto,q_auto,dpr_auto,f_auto/v1566809938/bob-portrait.png",
59    "employment_status": "active",
60    "employment_type": "contractor",
61    "job_title": null,
62    "ssn": "522-09-1191",
63    "platform_user_id": "418IMWASXATWBW2X",
64    "hire_dates": [],
65    "terminations": [],
66    "marital_status": "Married filing jointly",
67    "gender": "Male",
68    "employer": "dre",
69    "metadata": {},
70    "created_at": "2022-04-22T13:26:44.978650Z",
71    "updated_at": "2022-04-22T13:26:44.978700Z"
72  }
73]
Updating Argyle status...
© 2024 Argyle Systems Inc.argyle.com