Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

List all received invitations

List all the business invitations you received.

get

List all business invitations you have received from other businesses. Business invitations cancelled by the sender will not be included in the response.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
Responses
200Success
application/json
idstringRequired

id of this entity

Example: 123e4567-e89b-12d3-a456-426614174000
emailstringRequired

email of the user that this invitation is for

Example: user@example.com
statusstring · enumRequired

status of this invitation

Possible values:
createdAtstringRequired

date this entity was created

Example: 2020-01-01T00:00:00.000Z
updatedAtstringRequired

date this entity was last updated

Example: 2020-01-01T00:00:00.000Z
sourceIsInviteebooleanRequired

describes if the invited business will share or receive data

Example: true
customDataobjectOptional

A customizable metadata field for storing additional information related to a business invitation in TradeAware. This field allows customers to associate their own identifiers or data with TradeAware's system.

  The `customData` field is returned unchanged and is visible only to the owners of the business invitation.

  Constraints:
    - Up to 10 keys per object
    - Key length: Maximum 255 characters
    - String value length: Maximum 255 characters
    - Values must be of type: string, number, or boolean
    - Nested objects are not allowed
    - Keys cannot contain: '__proto__', 'constructor', or 'prototype'

  Server-owned namespaces may additionally appear in responses; the constraints above apply to client-supplied data only.
Example: {"key1":"someValue","key2":true,"key3":1234}
get/business-invitations
GET /business-invitations HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "sentByUser": {
      "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
      "business": {
        "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
        "email": "user@example.com",
        "name": "Example Inc.",
        "username": "John Doe",
        "addressStreet": "Salawati 143",
        "addressZip": "98451",
        "addressPostcode": "12345",
        "addressArea": "Brandenburg",
        "addressCity": "West Papua",
        "addressCountryCode": "ID",
        "addressCountry": "Indonesia",
        "addressLine1": "Salawati 123",
        "addressLine2": "3rd floor",
        "createdAt": "2023-07-26T15:03:48Z",
        "updatedAt": "2023-07-28T09:13:37Z",
        "initialLocale": "id-ID",
        "units": "metric",
        "plots": "[Circular Reference]",
        "newlyCreated": "true",
        "members": "[Circular Reference]",
        "connectionsAsSource": "[Circular Reference]",
        "connectionsAsTarget": "[Circular Reference]",
        "businessInvitations": "[Circular Reference]",
        "contactPerson": "[Circular Reference]",
        "machineToMachineClientId": "1234567890asdfghjk",
        "eori": "text",
        "vat": "text",
        "tracesEnvironment": "ACCEPTANCE"
      },
      "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "firstName": "Paul",
      "lastName": "Smith",
      "locale": "id-ID",
      "createdAt": "2023-07-26T15:03:48Z",
      "updatedAt": "2023-07-28T09:13:37Z",
      "completed": "false",
      "businessInvitations": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "sentByUser": "[Circular Reference]",
          "business": "[Circular Reference]",
          "email": "user@example.com",
          "status": "PENDING",
          "createdAt": "2020-01-01T00:00:00.000Z",
          "updatedAt": "2020-01-01T00:00:00.000Z",
          "sourceIsInvitee": "true",
          "customData": {
            "key1": "someValue",
            "key2": true,
            "key3": 1234
          }
        }
      ],
      "userInvitations": [
        {
          "id": "text",
          "email": "some@email.com",
          "sentByUser": "[Circular Reference]",
          "inviteToBusiness": "[Circular Reference]",
          "status": "ACCEPTED",
          "createdAt": "2020-01-01T00:00:00.000Z",
          "updatedAt": "2020-01-01T00:00:00.000Z"
        }
      ],
      "email": "user@example.com",
      "consentedAt": "2023-07-28T09:13:37Z",
      "entitlements": {
        "canTriggerPrecisionAnalysis": false,
        "canManageTransactions": false,
        "canViewCmsSurveyResponsesOfTier1Suppliers": false,
        "canDownloadSurveyResponses": false,
        "canDownloadCmsSurveyResponses": false,
        "canManageWebhooks": false,
        "canAccessApi": false,
        "canManageCmsSupplierRiskAssessmentStatuses": false,
        "canViewCmsSurveys": false,
        "canViewSupplierRiskScore": false
      }
    },
    "business": {
      "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "email": "user@example.com",
      "name": "Example Inc.",
      "username": "John Doe",
      "addressStreet": "Salawati 143",
      "addressZip": "98451",
      "addressPostcode": "12345",
      "addressArea": "Brandenburg",
      "addressCity": "West Papua",
      "addressCountryCode": "ID",
      "addressCountry": "Indonesia",
      "addressLine1": "Salawati 123",
      "addressLine2": "3rd floor",
      "createdAt": "2023-07-26T15:03:48Z",
      "updatedAt": "2023-07-28T09:13:37Z",
      "initialLocale": "id-ID",
      "units": "metric",
      "plots": [
        {
          "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
          "createdAt": "2023-07-26T15:03:48Z",
          "updatedAt": "2023-07-28T09:13:37Z",
          "suppliers": "[Circular Reference]",
          "geometry": {
            "type": "Polygon",
            "coordinates": [
              [
                [
                  100,
                  0
                ],
                [
                  100.01,
                  0
                ],
                [
                  100.01,
                  0.01
                ],
                [
                  100,
                  0.01
                ],
                [
                  100,
                  0
                ]
              ]
            ]
          },
          "commodities": [
            "oil palm",
            "rubber"
          ],
          "name": "text",
          "surfaceArea": 1,
          "countryCode": "text",
          "mostRecentAnalysis": {
            "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "createdAt": "2023-07-26T15:03:48Z",
            "updatedAt": "2023-07-28T09:13:37Z",
            "status": "PENDING",
            "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "analysedAt": "2023-07-28T09:13:37Z",
            "version": "open-source-1.0.0",
            "deforestedArea": 123.45,
            "deforestedGeometry": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    13,
                    52.5
                  ],
                  [
                    13.5,
                    52.5
                  ],
                  [
                    13.5,
                    52
                  ],
                  [
                    13,
                    52
                  ],
                  [
                    13,
                    52.5
                  ]
                ]
              ]
            },
            "riskOfDeforestation": 0.3,
            "type": "OS",
            "customData": {
              "some": "metadata"
            },
            "name": "text"
          },
          "mostRecentAnalysesByType": {
            "EUFOROBS": {
              "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "createdAt": "2023-07-26T15:03:48Z",
              "updatedAt": "2023-07-28T09:13:37Z",
              "status": "PENDING",
              "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "analysedAt": "2023-07-28T09:13:37Z",
              "version": "open-source-1.0.0",
              "deforestedArea": 123.45,
              "deforestedGeometry": {
                "type": "Polygon",
                "coordinates": [
                  [
                    [
                      13,
                      52.5
                    ],
                    [
                      13.5,
                      52.5
                    ],
                    [
                      13.5,
                      52
                    ],
                    [
                      13,
                      52
                    ],
                    [
                      13,
                      52.5
                    ]
                  ]
                ]
              },
              "riskOfDeforestation": 0.3,
              "type": "OS",
              "customData": {
                "some": "metadata"
              },
              "name": "text"
            },
            "PRECISION": {
              "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "createdAt": "2023-07-26T15:03:48Z",
              "updatedAt": "2023-07-28T09:13:37Z",
              "status": "PENDING",
              "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "analysedAt": "2023-07-28T09:13:37Z",
              "version": "open-source-1.0.0",
              "deforestedArea": 123.45,
              "deforestedGeometry": {
                "type": "Polygon",
                "coordinates": [
                  [
                    [
                      13,
                      52.5
                    ],
                    [
                      13.5,
                      52.5
                    ],
                    [
                      13.5,
                      52
                    ],
                    [
                      13,
                      52
                    ],
                    [
                      13,
                      52.5
                    ]
                  ]
                ]
              },
              "riskOfDeforestation": 0.3,
              "type": "OS",
              "customData": {
                "some": "metadata"
              },
              "name": "text"
            }
          },
          "riskAssessmentStatus": "NEW",
          "riskLevel": "none",
          "species": [
            {
              "scientificName": "Tectona grandis",
              "commonName": "Teak"
            }
          ],
          "productionDateStart": {},
          "productionDateEnd": {},
          "filename": {},
          "description": "text",
          "ownerId": "text",
          "customData": {
            "key1": "someValue",
            "key2": true,
            "key3": 1234
          }
        }
      ],
      "newlyCreated": "true",
      "members": [
        {
          "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
          "business": {
            "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "email": "user@example.com",
            "name": "Example Inc.",
            "username": "John Doe",
            "addressStreet": "Salawati 143",
            "addressZip": "98451",
            "addressPostcode": "12345",
            "addressArea": "Brandenburg",
            "addressCity": "West Papua",
            "addressCountryCode": "ID",
            "addressCountry": "Indonesia",
            "addressLine1": "Salawati 123",
            "addressLine2": "3rd floor",
            "createdAt": "2023-07-26T15:03:48Z",
            "updatedAt": "2023-07-28T09:13:37Z",
            "initialLocale": "id-ID",
            "units": "metric",
            "plots": "[Circular Reference]",
            "newlyCreated": "true",
            "members": "[Circular Reference]",
            "connectionsAsSource": "[Circular Reference]",
            "connectionsAsTarget": "[Circular Reference]",
            "businessInvitations": "[Circular Reference]",
            "contactPerson": "[Circular Reference]",
            "machineToMachineClientId": "1234567890asdfghjk",
            "eori": "text",
            "vat": "text",
            "tracesEnvironment": "ACCEPTANCE"
          },
          "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
          "firstName": "Paul",
          "lastName": "Smith",
          "locale": "id-ID",
          "createdAt": "2023-07-26T15:03:48Z",
          "updatedAt": "2023-07-28T09:13:37Z",
          "completed": "false",
          "businessInvitations": "[Circular Reference]",
          "userInvitations": "[Circular Reference]",
          "email": "user@example.com",
          "consentedAt": "2023-07-28T09:13:37Z",
          "entitlements": {
            "canTriggerPrecisionAnalysis": false,
            "canManageTransactions": false,
            "canViewCmsSurveyResponsesOfTier1Suppliers": false,
            "canDownloadSurveyResponses": false,
            "canDownloadCmsSurveyResponses": false,
            "canManageWebhooks": false,
            "canAccessApi": false,
            "canManageCmsSupplierRiskAssessmentStatuses": false,
            "canViewCmsSurveys": false,
            "canViewSupplierRiskScore": false
          }
        }
      ],
      "connectionsAsSource": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "sourceBusiness": "[Circular Reference]",
          "targetBusiness": "[Circular Reference]",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "customData": {
            "foo": "bar"
          },
          "plotsCount": 1,
          "plotsCommodities": [
            "cattle",
            "cocoa"
          ]
        }
      ],
      "connectionsAsTarget": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "sourceBusiness": "[Circular Reference]",
          "targetBusiness": "[Circular Reference]",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "customData": {
            "foo": "bar"
          },
          "plotsCount": 1,
          "plotsCommodities": [
            "cattle",
            "cocoa"
          ]
        }
      ],
      "businessInvitations": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "sentByUser": {
            "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
            "business": {
              "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "email": "user@example.com",
              "name": "Example Inc.",
              "username": "John Doe",
              "addressStreet": "Salawati 143",
              "addressZip": "98451",
              "addressPostcode": "12345",
              "addressArea": "Brandenburg",
              "addressCity": "West Papua",
              "addressCountryCode": "ID",
              "addressCountry": "Indonesia",
              "addressLine1": "Salawati 123",
              "addressLine2": "3rd floor",
              "createdAt": "2023-07-26T15:03:48Z",
              "updatedAt": "2023-07-28T09:13:37Z",
              "initialLocale": "id-ID",
              "units": "metric",
              "plots": "[Circular Reference]",
              "newlyCreated": "true",
              "members": "[Circular Reference]",
              "connectionsAsSource": "[Circular Reference]",
              "connectionsAsTarget": "[Circular Reference]",
              "businessInvitations": "[Circular Reference]",
              "contactPerson": "[Circular Reference]",
              "machineToMachineClientId": "1234567890asdfghjk",
              "eori": "text",
              "vat": "text",
              "tracesEnvironment": "ACCEPTANCE"
            },
            "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "firstName": "Paul",
            "lastName": "Smith",
            "locale": "id-ID",
            "createdAt": "2023-07-26T15:03:48Z",
            "updatedAt": "2023-07-28T09:13:37Z",
            "completed": "false",
            "businessInvitations": [
              {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "sentByUser": "[Circular Reference]",
                "business": "[Circular Reference]",
                "email": "user@example.com",
                "status": "PENDING",
                "createdAt": "2020-01-01T00:00:00.000Z",
                "updatedAt": "2020-01-01T00:00:00.000Z",
                "sourceIsInvitee": "true",
                "customData": {
                  "key1": "someValue",
                  "key2": true,
                  "key3": 1234
                }
              }
            ],
            "userInvitations": [
              {
                "id": "text",
                "email": "some@email.com",
                "sentByUser": "[Circular Reference]",
                "inviteToBusiness": "[Circular Reference]",
                "status": "ACCEPTED",
                "createdAt": "2020-01-01T00:00:00.000Z",
                "updatedAt": "2020-01-01T00:00:00.000Z"
              }
            ],
            "email": "user@example.com",
            "consentedAt": "2023-07-28T09:13:37Z",
            "entitlements": {
              "canTriggerPrecisionAnalysis": false,
              "canManageTransactions": false,
              "canViewCmsSurveyResponsesOfTier1Suppliers": false,
              "canDownloadSurveyResponses": false,
              "canDownloadCmsSurveyResponses": false,
              "canManageWebhooks": false,
              "canAccessApi": false,
              "canManageCmsSupplierRiskAssessmentStatuses": false,
              "canViewCmsSurveys": false,
              "canViewSupplierRiskScore": false
            }
          },
          "business": "[Circular Reference]",
          "email": "user@example.com",
          "status": "PENDING",
          "createdAt": "2020-01-01T00:00:00.000Z",
          "updatedAt": "2020-01-01T00:00:00.000Z",
          "sourceIsInvitee": "true",
          "customData": {
            "key1": "someValue",
            "key2": true,
            "key3": 1234
          }
        }
      ],
      "contactPerson": {
        "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
        "business": {
          "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
          "email": "user@example.com",
          "name": "Example Inc.",
          "username": "John Doe",
          "addressStreet": "Salawati 143",
          "addressZip": "98451",
          "addressPostcode": "12345",
          "addressArea": "Brandenburg",
          "addressCity": "West Papua",
          "addressCountryCode": "ID",
          "addressCountry": "Indonesia",
          "addressLine1": "Salawati 123",
          "addressLine2": "3rd floor",
          "createdAt": "2023-07-26T15:03:48Z",
          "updatedAt": "2023-07-28T09:13:37Z",
          "initialLocale": "id-ID",
          "units": "metric",
          "plots": "[Circular Reference]",
          "newlyCreated": "true",
          "members": "[Circular Reference]",
          "connectionsAsSource": "[Circular Reference]",
          "connectionsAsTarget": "[Circular Reference]",
          "businessInvitations": "[Circular Reference]",
          "contactPerson": "[Circular Reference]",
          "machineToMachineClientId": "1234567890asdfghjk",
          "eori": "text",
          "vat": "text",
          "tracesEnvironment": "ACCEPTANCE"
        },
        "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
        "firstName": "Paul",
        "lastName": "Smith",
        "locale": "id-ID",
        "createdAt": "2023-07-26T15:03:48Z",
        "updatedAt": "2023-07-28T09:13:37Z",
        "completed": "false",
        "businessInvitations": "[Circular Reference]",
        "userInvitations": "[Circular Reference]",
        "email": "user@example.com",
        "consentedAt": "2023-07-28T09:13:37Z",
        "entitlements": {
          "canTriggerPrecisionAnalysis": false,
          "canManageTransactions": false,
          "canViewCmsSurveyResponsesOfTier1Suppliers": false,
          "canDownloadSurveyResponses": false,
          "canDownloadCmsSurveyResponses": false,
          "canManageWebhooks": false,
          "canAccessApi": false,
          "canManageCmsSupplierRiskAssessmentStatuses": false,
          "canViewCmsSurveys": false,
          "canViewSupplierRiskScore": false
        }
      },
      "machineToMachineClientId": "1234567890asdfghjk",
      "eori": "text",
      "vat": "text",
      "tracesEnvironment": "ACCEPTANCE"
    },
    "email": "user@example.com",
    "status": "PENDING",
    "createdAt": "2020-01-01T00:00:00.000Z",
    "updatedAt": "2020-01-01T00:00:00.000Z",
    "sourceIsInvitee": "true",
    "customData": {
      "key1": "someValue",
      "key2": true,
      "key3": 1234
    }
  }
]
PreviousUpdate a business invitation
NextList all sent invitations

Last updated