Relationship Types
relationshipTypes Based on latest (2026.09)
Look up Relationship Types. Read-only.
The record key relationshipTypesUniqID is a generated hash. Take it from the record's links (rel self) in a GET response; never build it yourself.
- Operations
- GET (list)GET (one)
- Record key
relationshipTypesUniqID- Required on create
- no create on this resource
- At a glance
- 23 fields1 finders0 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/relationshipTypes?fields=AllowCircularRelationships,BackwardRelationshipCode,CreatedByModule,Description,DirectionCode&limit=25&onlyData=true
{
"items": [
{
"AllowCircularRelationships": "<string, max 1>",
"BackwardRelationshipCode": "<string, max 30>",
"CreatedByModule": "<string, max 150>",
"Description": "<string, max 240>",
"DirectionCode": "<string, max 30>"
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0
}Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's latest (2026.09) REST specification.
Fields 23
| Attribute | Type | Use |
|---|---|---|
AllowCircularRelationships | text · max 1 | Read-onlySearchable |
BackwardRelationshipCode | text · max 30 | Read-onlySearchable |
CreatedByModule | text · max 150 | Read-onlySearchable |
Description | text · max 240 | Read-onlySearchable |
DirectionCode | text · max 30 | Read-onlySearchable |
EndDateActive | date | Read-onlySearchable |
ForwardRelationshipCode | text · max 30 | Read-onlySearchable |
Language | text · max 30 | Read-onlySearchable |
LookupCode | text · max 30 | Read-onlySearchable |
LookupType | text · max 30 | Read-onlySearchable |
Meaning | text · max 80 | Read-onlySearchable |
ObjectType | text · max 30 | Read-onlySearchable |
RelationshipType | text · max 30 | Read-onlySearchable |
RelationshipTypeId | number | Read-onlySearchable |
Role | text · max 30 | Read-onlySearchable |
SetId | number | Read-onlySearchable |
SourceLang | text · max 4 | Read-onlySearchable |
StartDateActive | date | Read-onlySearchable |
Status | text · max 1 | Read-onlySearchable |
SubjectType | text · max 30 | Read-onlySearchable |
Tag | text · max 150 | Read-onlySearchable |
TerritoryCode | text · max 2 | Read-onlySearchable |
ViewApplicationId | number | Read-onlySearchable |
Names, types, labels and flags from Oracle's REST specification (latest (2026.09)). Flexfield and custom attributes vary by pod: check /describe for yours.
Finders 1
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
RoleForSubjectObjectFinder·bindObjectTypebindRelationshipCodebindRelationshipGroupbindRelationshipTypebindSubjectType
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Use in AI Agent Studio
- Point a Business Object or REST tool at
/crmRestApi/resources/11.13.18.05/relationshipTypesand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
RoleForSubjectObjectFinderfor the agent's main search: its variables become clean tool parameters. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:AllowCircularRelationships, notallowcircularrelationships. onlyData=trueremoveslinks, and this resource's key only comes fromlinks. Leave it off when you need the key.- Send dates as
YYYY-MM-DD; date-time fields take ISO 8601 with a time zone. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through.