GET
/users
List Users
GET
/users/{username}
View User Info
The term user refers to anyone who has an account on MyJohnDeere and stores data in Operations Center. A user may be a grower, a trusted adviser, a John Deere Dealer, etc.
GET /users
List Users
This endpoint returns a list of up to fifty users. This call can only be used by a John Deere Dealer in a Customer Service role to view users in an Organization they are supporting. Dealers must embed emailAddresses, addresses, phoneNumbers, and organizations in the call to view that information about another user; the links in the response will not be followable for the Dealer.
  • profileState: View the status of this user's account.1 This information can also be embedded in the request.
  • applications: View a list of applications used by this person.2 This information can also be embedded in the request.
  • organizations: List of organizations the user belongs to. This information can also be embedded in the request.
  • addresses: Addresses for the user.This information can also be embedded in the request.
  • phoneNumbers: Phone numbers for the user. This information can also be embedded in the request.
 
Request URI
GET https://apicert.soa-proxy.deere.com/platform/users
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Request Parameters
Parameter Type Example Description Default Required?
username string JohnDoe Filter by username. N/A No.
firstName string John Filter by first name. N/A No.
lastName string Doe Filter by last name. N/A No.
city string Moline Filter users by city. N/A No.
state string IL Filter by state. Use the two-letter abbreviation. N/A No.
country string US Filter by country. Use the two-letter abbreviation. N/A No.
postalCode string 61265 Filter by postal code. N/A No.
phone string 5554443333 Filter by phone number. N/A No.
email string johndoe@smithfarms.com Filter by email address. N/A No.
embed string profileState Takes the following values: profileState, applications, organizations, addresses, and phoneNumbers.
Separate multiple embeds with commas.
N/A No.
 
Response Details
Field Type Example Description
accountName string JohnDoe User's account name.
givenName string John User's first name.
familyName string Doe User's last name.
lastLoggedInDate dateTime 2015-03-25T13:39:29.000Z Date and time of the user's last login to MyJohnDeere.
emailAddresses --- See sample response below. List of email addresses for this user.
 
Sample Response [JSON]
200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
   "links": [
      {
         "rel": "self",
         "uri": "https://apicert.soa-proxy.deere.com/platform/users?userName=johndoe"
      }
   ],
   "total": 1,
   "values": [
      {
         "accountName": "johndoe",
         "givenName": "JOHN",
         "familyName": "DOE",
         "lastLoggedInDate": "2013-11-27T20:01:59.000Z",
         "company": "Smith Farms",
         "emailAddresses": {             "emailAddresses": [
               {
                  "value": "johndoe@smithfarms.com",
                  "type": "Work",
                  "links": null
               }
            ],
            "links": null,
            "otherAttributes": {}
         },
         "links": [
            {
               "rel": "self",
               "uri": "https://apicert.soa-proxy.deere.com/platform/users/johndoe",
               "followable": true
            },
            {
               "rel": "files",
               "uri": "https://apicert.soa-proxy.deere.com/platform/users/johndoe/files",
               "followable": true
            },
            {
               "rel": "profileState",
               "uri": "https://apicert.soa-proxy.deere.com/platform/users/johndoe/profileState",
               "followable": true
            },
            {
               "rel": "applications",
               "uri": "https://apicert.soa-proxy.deere.com/platform/users/johndoe/applications",
               "followable": true
            },
            {
               "rel": "organizations",
               "uri": "https://apicert.soa-proxy.deere.com/platform/users/johndoe/organizations",
               "followable": true
            },
            {
               "rel": "addresses",
               "uri": "https://apicert.soa-proxy.deere.com/platform/users/johndoe/addresses",
               "followable": true
            },
            {
               "rel": "phoneNumbers",
               "uri": "https://apicert.soa-proxy.deere.com/platform/users/johndoe/phoneNumbers",
               "followable": true
            }
         ]
      }
   ]
}
 
[1] User Account Statuses: Validated; Validation Started; Not Validated.
[2] Applications: JD Link; Field Connect; My Equipment (Legacy); AgLogic; Operations Center; JD Financial Self Service; Stellar; JD University; JD Parts.
GET /users /{username}
View User Info
This endpoint returns information about the user, such as first and last name, the account name, etc. This call can be used by a logged-in user to view their own information.
 
The response also contains links to the following resources:
  • organizations: View a list of organizations to which the user belongs.
  • files: View a list of files belonging to the user.
 
Request URI
GET https://apicert.soa-proxy.deere.com/platform/users/{username}
Accept: application/vnd.deere.axiom.v3+xml OR application/vnd.deere.axiom.v3+json
 
Request Parameters
Parameter Type Example Description Default Required?
embed string emailAddresses You can embed emailAddresses, addresses, phoneNumbers, and organizations. N/A No.
 
Response Details
Field Type Example Description
accountName string JohnDoe User's account name.
givenName string John User's first name.
familyName string Doe User's last name.
 
Sample Response [JSON]
200 OK
Content-Type: application/vnd.deere.axiom.v3+json

{
   "links": [
      {
         "rel": "self",
         "uri": "https://apicert.soa-proxy.deere.com/platform/users/johndoe"
      },
      {
         "rel": "organizations",
         "uri": "https://apicert.soa-proxy.deere.com/platform/users/johndoe/organizations",
         "followable": true
      },
      {
         "rel": "files",
         "uri": "https://apicert.soa-proxy.deere.com/platform/users/johndoe/files",
         "followable": true
      },
      {
         "rel": "addresses",
         "uri": "https://apicert.soa-proxy.deere.com/platform/users/johndoe/addresses",
         "followable": true
      },
      {
         "rel": "phoneNumbers",
         "uri": "https://apicert.soa-proxy.deere.com/platform/users/johndoe/phoneNumbers",
         "followable": true
      }
   ],
   "accountName": "johndoe",
   "givenName": "John",
   "familyName": "Doe",
   "userType": "Customer"
}