PRproject44
Invitations

Get invitations matching a criteria

Get invitations request allows users to fetch a list of invitations sent to entities to join your network. This request is useful for monitoring the status of the invitations and understanding the relationships formed within the network. By providing specific query parameters, users can filter the results based on the invitee's identifier type, value, and the capability for which the invitations were created.

get/services/invitation/v1/invitations

Request

Query parameters

inviteeIdentifier.type'VAT' | 'SCAC' | 'DOT_NUMBER' | 'MC_NUMBER' | 'P44_EU'

Type of invitee identifier

inviteeIdentifier.valuestring

Value of invitee identifier

capability'TRUCKLOAD_ASSET_TRACKING'

The capability for which the invitations where created

pageNumberinteger

Page number for pagination. min: 1, max: 25

pageSizeinteger

Page size for pagination. min: 1, max: 25

Response

Paginated list of invitations matching the criteria

Example response

{
  "results": [
    {
      "capability": "TRUCKLOAD_ASSET_TRACKING",
      "createdDateTime": "2023-08-23T10:15:30Z",
      "invitee": {
        "identifiers": [
          {
            "type": "VAT",
            "value": "PL1234567890"
          }
        ]
      },
      "lastModifiedDateTime": "2023-08-23T10:15:30Z",
      "status": "ACCEPTED"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.