Product DocumentationConga Community
API Reference

Query lookup field data

post
https://rls.congacloud.com/api/cart/v1/lookupfield-data/query

This API retrieves lookup field data for a specified object and field combination. The API queries the configured lookup object based on the lookup field settings and returns matching records. Supports additional filter criteria to narrow down results. Requires both ObjectName and FieldName in the request.

Required Fields:

  • dataRequest.ObjectName - required
  • dataRequest.FieldName - required

Responses

  • 200 OK: matching lookup field records are returned.
  • 400 Bad Request: ObjectName or FieldName is missing.
  • 500 Internal Server Error: an unexpected error occurred.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request model for querying lookup field data on a Salesforce object.

string | null

Context Object Name

string | null

Lookup field name in Context Object

string | null

Search text to perform on indexed fields in lookup object

ObjectData
object
string | null

Context Object Data Type

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses
200

OK

500

Internal Server Error

Updated 11 days ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 days ago

Did this page help you?