Get all linked relations

GET https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/relations

Gets all of an API version's relations.

Note:

In Qodex v10 and higher, this endpoint returns the following:

  • The unclassified relation is for documentation and testing. This is the default relation type.
  • The apiDefinition relation is the relation used for API definitions.

RESPONSES

status: OK

{"relations":{"apiDefintion":{"16bb367e-fafb-4ef3-933b-ee3d971866fb":{"id":"16bb367e-fafb-4ef3-933b-ee3d971866fb"}},"unclassified":{"b9bccf0f-e06a-433d-b556-a3cd158f0270":{"id":"b9bccf0f-e06a-433d-b556-a3cd158f0270","name":"Test Collection","createdAt":"2023-01-30T17:41:50.000Z","updatedAt":"2023-01-19T14:50:05.000Z"}},"schema":{"16bb367e-fafb-4ef3-933b-ee3d971866fb":{"id":"16bb367e-fafb-4ef3-933b-ee3d971866fb"}}}}