Skip to content
Interu API Reference/
/
Retrieve Connection List

Interu API (v2_28)

Download OpenAPI description
api.json
api.yaml
Languages
Servers
Mock server
https://developer.interu.io/_mock/reference/api/
UAT
https://api.uat.interu.io/

Validation

Apis related to Validation.

Operations

Base Units

Apis related to Base Units.

Operations

Country List

Apis related to Country List.

Operations

Standards

Apis related to Standards.

Operations

Document Types

Apis related to Document Types.

Operations

Location Types

Apis related to Location Types.

Operations

Process Types

Apis related to Process Types.

Operations

Attachments

Apis related to Attachments.

Operations

Documents

Apis related to Documents.

Operations

EUDR

Apis related to EUDR and Due Diligence Statement Submission.

Operations

Connections

Apis related to Connections.

Operations

Create ConnectionUDID

Request

Adds a new connection.

Security
ApiKeyAuth
Path
orgIdstringrequired

The organisation identity

Headers
contentTypestringrequired
Default application/json
Bodyapplication/jsonrequired
namestringrequired

The name of the connected organisation.

publicUristring

This is the public organisation URI. Once organisation is on the system as well and are connected then this will be populated. Before that happens an organisation can record for themselves but later have them linked if a given organisation then signs up.

parentUristring

If this connection is actually part of your group of companies then this should point to your organisation URI.

websitestring

The corporate website for this organisation.

emailstring

Contact email address for the organisation.

addressobjectrequired
address.​streetstring

The mainline of the address.

address.​regionstring

Region of the address.

address.​zipCodestring

Zip/postal code for the address.

address.​countrystringrequired
Enum"AF""AX""AL""DZ""AS""AD""AO""AI""AQ""AG"
idstring

System assigned or user defined id field.

curl -i -X POST \
  'https://developer.interu.io/_mock/reference/api/organisations/{orgId}/connections' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -H 'contentType: application/json' \
  -d '{
    "name": "string",
    "publicUri": "string",
    "parentUri": "string",
    "website": "string",
    "email": "string",
    "address": {
      "street": "string",
      "region": "string",
      "zipCode": "string",
      "country": "AF"
    },
    "id": "string"
  }'

Responses

The request has succeeded and will either return the newly created resource or where appropriate a record that reflects the success of the action.

Headers
Locationstring

Location of the created resource

Bodyapplication/json
namestringrequired

The name of the connected organisation.

publicUristring

This is the public organisation URI. Once organisation is on the system as well and are connected then this will be populated. Before that happens an organisation can record for themselves but later have them linked if a given organisation then signs up.

parentUristring

If this connection is actually part of your group of companies then this should point to your organisation URI.

websitestring

The corporate website for this organisation.

emailstring

Contact email address for the organisation.

addressobjectrequired
address.​streetstring

The mainline of the address.

address.​regionstring

Region of the address.

address.​zipCodestring

Zip/postal code for the address.

address.​countrystringrequired
Enum"AF""AX""AL""DZ""AS""AD""AO""AI""AQ""AG"
connectStatusstringrequired
Enum"CONNECTED""DISCONNECTED"
connectStatusUpdatedTimestring(date-time)

The time and date when the connection status was updated.

idstring

System assigned or user defined id field.

createdBystring

User who created the record.

createdTimestring(date-time)

Date & Time that the record was created.

updatedBystring

Last updated by user.

updatedTimestring(date-time)

Date & Time that the record was last updated.

Response
application/json
{
  "name": "string",
  "publicUri": "string",
  "parentUri": "string",
  "website": "string",
  "email": "string",
  "address": {
    "street": "string",
    "region": "string",
    "zipCode": "string",
    "country": "AF"
  },
  "connectStatus": "CONNECTED",
  "connectStatusUpdatedTime": "2019-08-24T14:15:22Z",
  "id": "string",
  "createdBy": "string",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "updatedTime": "2019-08-24T14:15:22Z"
}

Retrieve Connection List

Request

Gets the list of connections.

Security
ApiKeyAuth
Path
orgIdstringrequired

The organisation identity

Query
namestring

The name of the Connection.

countrystring

The country that the Connection is based in.

parentUristring

The parent Uri if set.

publicUristring

This is the public organisation URI.

hasPublicUriboolean

Will return all connections where they have a public URI.

recordStatestring(Common.Enums.RecordState)

The record 'State' of the Connection

Enum"ACTIVE""ARCHIVED"
connectStatusstring(Static.ConnectStatus)

Whether or not the Connection has an established link between their Interu account and yours.

Enum"CONNECTED""DISCONNECTED"
sizeinteger(int32)>= 1

The number of elements to return in each page. Minimum value must be 1, defaults to 20.

Default 20
pageinteger(int32)>= 0

The pageNo to return. (Zero-based)

Default 0
curl -i -X GET \
  'https://developer.interu.io/_mock/reference/api/organisations/{orgId}/connections?name=string&country=string&parentUri=string&publicUri=string&hasPublicUri=true&recordState=ACTIVE&connectStatus=CONNECTED&size=20&page=0' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The request has succeeded.

Bodyapplication/json
contentArray of objects(Static.Connection)required
content[].​namestringrequired

The name of the connected organisation.

content[].​publicUristring

This is the public organisation URI. Once organisation is on the system as well and are connected then this will be populated. Before that happens an organisation can record for themselves but later have them linked if a given organisation then signs up.

content[].​parentUristring

If this connection is actually part of your group of companies then this should point to your organisation URI.

content[].​websitestring

The corporate website for this organisation.

content[].​emailstring

Contact email address for the organisation.

content[].​addressobjectrequired
content[].​address.​streetstring

The mainline of the address.

content[].​address.​regionstring

Region of the address.

content[].​address.​zipCodestring

Zip/postal code for the address.

content[].​address.​countrystringrequired
Enum"AF""AX""AL""DZ""AS""AD""AO""AI""AQ""AG"
content[].​connectStatusstringrequired
Enum"CONNECTED""DISCONNECTED"
content[].​connectStatusUpdatedTimestring(date-time)

The time and date when the connection status was updated.

content[].​idstring

System assigned or user defined id field.

content[].​createdBystring

User who created the record.

content[].​createdTimestring(date-time)

Date & Time that the record was created.

content[].​updatedBystring

Last updated by user.

content[].​updatedTimestring(date-time)

Date & Time that the record was last updated.

pageobject(iov42.Core.Paging.Page)required
page.​sizeinteger(int32)required
page.​pageinteger(int32)required
page.​totalElementsinteger(int32)required
page.​totalPagesinteger(int32)required
Response
application/json
{
  "content": [
    { … }
  ],
  "page": {
    "size": 0,
    "page": 0,
    "totalElements": 0,
    "totalPages": 0
  }
}

Retrieve Connection

Request

Retrieve an existing connection.

Security
ApiKeyAuth
Path
connectionIdstringrequired
orgIdstringrequired

The organisation identity

curl -i -X GET \
  'https://developer.interu.io/_mock/reference/api/organisations/{orgId}/connections/{connectionId}' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The request has succeeded.

Bodyapplication/json
namestringrequired

The name of the connected organisation.

publicUristring

This is the public organisation URI. Once organisation is on the system as well and are connected then this will be populated. Before that happens an organisation can record for themselves but later have them linked if a given organisation then signs up.

parentUristring

If this connection is actually part of your group of companies then this should point to your organisation URI.

websitestring

The corporate website for this organisation.

emailstring

Contact email address for the organisation.

addressobjectrequired
address.​streetstring

The mainline of the address.

address.​regionstring

Region of the address.

address.​zipCodestring

Zip/postal code for the address.

address.​countrystringrequired
Enum"AF""AX""AL""DZ""AS""AD""AO""AI""AQ""AG"
connectStatusstringrequired
Enum"CONNECTED""DISCONNECTED"
connectStatusUpdatedTimestring(date-time)

The time and date when the connection status was updated.

idstring

System assigned or user defined id field.

createdBystring

User who created the record.

createdTimestring(date-time)

Date & Time that the record was created.

updatedBystring

Last updated by user.

updatedTimestring(date-time)

Date & Time that the record was last updated.

Response
application/json
{
  "name": "string",
  "publicUri": "string",
  "parentUri": "string",
  "website": "string",
  "email": "string",
  "address": {
    "street": "string",
    "region": "string",
    "zipCode": "string",
    "country": "AF"
  },
  "connectStatus": "CONNECTED",
  "connectStatusUpdatedTime": "2019-08-24T14:15:22Z",
  "id": "string",
  "createdBy": "string",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "updatedTime": "2019-08-24T14:15:22Z"
}

Locations

Apis related to Locations.

Operations

Materials

Apis related to Materials.

Operations

Products

Apis related to Products.

Operations

Deliveries

Apis related to Deliveries.

Operations

Items

Apis related to Items.

Operations

Orders

Apis related to Orders.

Operations

Processes

Apis related to Processes.

Operations

Outbound Delivery Workflow

Operations
Copyright © iov42 Limited.