---
title: "List Relationships"
method: GET
path: "/v3/relationships"
tags: ["Relationship"]
---

# List Relationships

`GET /v3/relationships`

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

## Query parameters

- `autoSend` 'ENABLED' | 'DISABLED'
- `limit` integer
- `prevCursor` string
- `nextCursor` string

## Headers

- `orderful-api-key` string, required

## Response `200`

List of relationships.

- ListRelationshipsResponseV3Dto
  - `metadata` ListRelationshipsResponseV3MetadataDto, required
    - `pagination` PaginationV3, required
      - `links` PaginationLinkV3, required
        - `next` string, nullable, required — Next URL which you can use to fetch the next page.
        - `prev` string, nullable, required — Previous URL which you can use to fetch the previous page.
  - `data` RelationshipResponseV3Dto[], required — List of relationships.
    - `id` number, required — Unique relationship identifier.
    - `createdAt` string, date-time, required — Datetime relationship was created.
    - `updatedAt` string, date-time, required — Datetime relationship was last updated.
    - `sender` RelationshipIdentityV3Dto, required
      - `ediAccountId` number, required — EDI account ID.
      - `liveIsaId` string, required — Live ISA ID.
      - `testIsaId` string, nullable, required — Test ISA ID.
      - `organizationId` number, required — Organization ID.
      - `organizationName` string, required — Organization name.
      - `ediAccountName` string, required — EDI account name.
    - `receiver` RelationshipIdentityV3Dto, required
      - `ediAccountId` number, required — EDI account ID.
      - `liveIsaId` string, required — Live ISA ID.
      - `testIsaId` string, nullable, required — Test ISA ID.
      - `organizationId` number, required — Organization ID.
      - `organizationName` string, required — Organization name.
      - `ediAccountName` string, required — EDI account name.
    - `transactionType` RelationshipTransactionTypeV3Dto, required
      - `name` string, required — Transaction type name.
    - `status` 'BLOCKED' | 'PENDING' | 'SETUP' | 'TEST' | 'READY' | 'LIVE', required — Relationship status.
    - `autoSend` 'ENABLED' | 'DISABLED' — Auto-send configuration.

---

[API](https://skmtc.dev/orderful/apis/orderful-api.md) · [All operations](https://skmtc.dev/orderful/apis/orderful-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/orderful/orderful-api/revisions/c2e12b39b4e1/schema)