List Partners
GET
- fromPartnership: View the organization that initiated the partnership.
- toPartnership: View the organization that the partner request was sent to. If the partnership has not been accepted, only the invited users email address will be returned.
- delete: Use this link to delete the partnership.
- permissions: View the permissions assigned within the partnership.
- contactInvitation: The ID specific to the partnership request.
OAuth Scope Required: org1
Request URI
GET https://sandboxapi.deere.com/platform/partnerships
Accept: application/vnd.deere.axiom.v3+json
Parameters
Parameter | Type | Description & Example | In |
---|---|---|---|
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: 9f5396716e4b4e1c92018026f47109bb | 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: 3b6402615e4b4e1c92013026f47109bb |
status1 | string | View the status of the partnership Example: REJECTED |
Sample Response [JSON]
Content-Type: application/vnd.deere.axiom.v3+json
x-deere-signature: 3b6402615e4b4e1c92013026f47109bb
{ "links": [ { "rel": "self", "uri": "https://sandboxapi.deere.com/platform/partnerships" } ], "total": 2, "values": [ { "links": [ { "rel": "self", "uri": "https://sandboxapi.deere.com/platform/partnerships/2b1b34fc-2cc3-4a57-8120-28ea912113fc" }, { "rel": "fromPartnership", "uri": "https://sandboxapi.deere.com/platform/organizations/0987" }, { "rel": "toPartnership", "uri": "https://sandboxapi.deere.com/platform/organizations/1234" }, { "rel": "permissions", "uri": "https://sandboxapi.deere.com/platform/partnerships/2b1b34fc-2cc3-4a57-8120-28ea912113fc/permissions" }, { "rel": "contactInvitation", "uri": "https://sandboxapi.deere.com/platform/partnerships/c3cf441b-d814-400b-842c-44fb7ecad703" } ], "status": "ACCEPTED" }, { "links": [ { "rel": "self", "uri": "https://sandboxapi.deere.com/platform/partnerships/4ecbb066-bd4c-485e-bcf8-99a470364d5a" }, { "rel": "fromPartnership", "uri": "https://sandboxapi.deere.com/platform/organizations/7654" }, { "rel": "toPartnership", "uri": "https://sandboxapi.deere.com/platform/organizations/1234" }, { "rel": "permissions", "uri": "https://sandboxapi.deere.com/platform/partnerships/4ecbb066-bd4c-485e-bcf8-99a470364d5a/permissions" }, { "rel": "contactInvitation", "uri": "https://sandboxapi.deere.com/platform/partnerships/47f27b3a-2639-4bc4-a1c3-33dc0bce32ac" } ], "status": "ACCEPTED" } ] }