List Orgs
GET
Request URI
GET https://sandboxapi.deere.com/platform/organizations
Accept: application/vnd.deere.axiom.v3+json
Parameters
Parameter | Type | Description & Example | In |
---|---|---|---|
userName | string | Returns a list of organizations of which a particular user is a member. Example: JohnDoe | query |
orgId | string | Returns the name of the organization that corresponds with the given organization ID. Example: 2101 | query |
orgName | string | Returns a list of organizations that contain the given string in their name. Example: Smith Farms | query |
x-deere-signature | string | x-deere-signature should be managed by the client per user per API. For a new user/new API, the first request will have a blank value for x-deere-signature. Changes can be tracked with the x-deere-signature returned in the response. If the response has not changed since the last API call, the value of x-deere-signature is not changed and the client should use the same String Token next time. Example: 7r5392615e4b4e1c92018026f47109bb | header |
Response Details
Field | Type | Description & Example |
---|---|---|
x-deere-signature | string | A new x-deere-signature response header will be included if the response has changed since last api call. Example: 3b5392015e4b4e1c92013026f47109bb |
id | string | The organization ID. Example: 1234 |
name | string | The organization name. Example: Smith Farms |
type | string | The organization type: customer or dealer. Example: customer |
member | boolean | TRUE means that the user is a member of the org. Example: true |
Sample Response [JSON]
Content-Type: application/vnd.deere.axiom.v3+json
x-deere-signature: 3b5392015e4b4e1c92013026f47109bb
{ "links": [ { "rel": "self", "uri": "https://sandboxapi.deere.com/platform/organizations" } ], "total": 2, "values": [ { "@type": "Organization", "name": "A First Org Name (Is Enabled)", "type": "customer", "member": true, "internal": false, "id": "1234", "links": [ { "rel": "self", "uri": "https://sandboxapi.deere.com/platform/organizations/1234" }, { "rel": "manage_connections", "uri": "https://connections.deere.com/connections/28efb3cb-cbd5-4888-8570-99465ea8860e/connections-dialog?orgId=1234" } ] }, { "@type": "Organization", "name": "A Second Org Name (Not Enabled)", "type": "customer", "member": true, "internal": false, "id": "4321", "links": [ { "rel": "self", "uri": "https://sandboxapi.deere.com/platform/organizations/4321" }, { "rel": "connections", "uri": "https://connections.deere.com/connections/28efb3cb-cbd5-4888-8570-99465ea8860e/select-organizations" } ] } ] }