// fusionrest agent · sales and service (cx)
External Contacts
externalContacts Based on latest (2026.09)
Look up External Contacts. Read-only.
/crmRestApi/resources/11.13.18.05/externalContacts
- Operations
- GET (list)GET (one)
- Record key
RelationshipRecId- Required on create
- no create on this resource
- At a glance
- 16 fields1 finders0 children
Try it
Response fields ·
Filters (q)
Only attributes Oracle marks as searchable are offered.
Finder
Paging and options
limit
GET /crmRestApi/resources/11.13.18.05/externalContacts?fields=ContactId,ContactName,ContactNumber,ContactPointId,ContactPointType&limit=25&onlyData=true
Response shape (placeholders)
{
"items": [
{
"ContactId": 0,
"ContactName": "<string, max 360>",
"ContactNumber": "<string, max 30>",
"ContactPointId": 0,
"ContactPointType": "<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 16
| Attribute | Type | Use |
|---|---|---|
ContactId | number | Read-onlySearchable |
ContactName | text · max 360 | Read-onlySearchable |
ContactNumber | text · max 30 | Read-onlySearchable |
ContactPointId | number | Read-onlySearchable |
ContactPointType | text · max 30 | Read-onlySearchable |
Department | text · max 60 | Read-onlySearchable |
DirectionalFlag | yes/no · max 1 | Read-onlySearchable |
EmailAddress | text · max 320 | Read-onlySearchable |
JobTitle | text · max 100 | Read-onlySearchable |
OrgContactId | number | Read-onlySearchable |
PartyId1 | number | Read-onlySearchable |
PartyId1_1 | number | Read-onlySearchable |
PartyId2 | number | Read-onlySearchable |
PartyName1 | text · max 360 | Read-onlySearchable |
RelationshipRecId | number | Read-onlySearchable |
Status | text · max 1 | 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.
ExternalContactsbyPartyIdFinder·bindPartyId
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/externalContactsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
ExternalContactsbyPartyIdFinderfor 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:ContactId, notcontactid. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through.