Sign in

v1

latestOpenAPI 3.0.02026-07-2421110121.4 KB
Relationship

List Relationships

Retrieves a paginated list of the Relationships for the current Organization.

get/v3/relationships

Query parameters

autoSend'ENABLED' | 'DISABLED'

Filter by the relationship auto-send configuration.

limitinteger

The number of items to return in the result set.

prevCursorstring

If results are <a href="https://docs.orderful.com/reference/pagination" target="_blank">paginated</a>, this will point to the previous set of results.

nextCursorstring

If results are <a href="https://docs.orderful.com/reference/pagination" target="_blank">paginated</a>, this will point to the next set of results.

Headers

orderful-api-keystring required

Your Orderful API key.

Response

List of relationships.

Example response

{
  "data": [
    {
      "id": 123,
      "createdAt": "2025-12-24T14:01:25.246Z",
      "updatedAt": "2025-12-24T14:01:25.246Z",
      "sender": {
        "ediAccountId": 123,
        "liveIsaId": "ISA_ID",
        "testIsaId": "TEST_ISA_ID",
        "organizationId": 123,
        "organizationName": "Organization_Name",
        "ediAccountName": "EDI_Account_Name"
      },
      "receiver": {
        "ediAccountId": 123,
        "liveIsaId": "ISA_ID",
        "testIsaId": "TEST_ISA_ID",
        "organizationId": 123,
        "organizationName": "Organization_Name",
        "ediAccountName": "EDI_Account_Name"
      },
      "transactionType": {
        "name": "810_INVOICE"
      },
      "status": "READY"
    }
  ]
}