EndpointsInventory structureRelation types
List configured relationship types
The API runs on your application instance. Schemas and field names come directly from the OpenAPI specification. Session-authenticated requests require a session on that instance.
GET
Requires the read scope. Administrators may include archived definitions.
bearerAuthheader
AuthorizationBearer <inv_ token>includeArchived?booleanInclude archived definitions when authenticated as an administrator.
Default
falseX-Organization-ID?stringOrganization membership selected for this request. User-bound credentials may select any active membership; standalone tokens may only repeat their pinned organization ID.
Format
uuidRelationship type definitions
application/json- response
relationTypes*array<>curl -X GET 'https://inventory.example.com/api/v1/relation-types'Example Response
{ "relationTypes": [ { "key": "string", "label": "string", "inverseLabel": "string", "description": "string", "allowManual": true, "spatial": true, "position": 0, "isSystem": true, "createdBy": "string", "updatedBy": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "archivedAt": "2019-08-24T14:15:22Z" } ]}