Skip to main content
GET
/
api
/
v1
/
context
/
items
/
{uid}
/
values
List values extracted from a context item at the given JSON path
curl --request GET \
  --url https://api.staging.getmodus.com/api/v1/context/items/{uid}/values \
  --header 'Authorization: Bearer <token>'
{
  "values": [
    "<unknown>"
  ],
  "nextPageToken": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

uid
string
required

UUID of the context item (unused on the underlying reader but kept for URL consistency).

Example:

"7a3f9d2c-1111-4000-a000-000000000abc"

Query Parameters

contextType
string
required

Context type of the item (required for partition-aware reads).

Example:

"salesforce_object_field"

contentKeyPath
string
required

Dot-separated JSON path to the array of values inside content. Example: enumValues or sample.values.

Example:

"enumValues"

pageSize
number
default:25

Max values per page. Defaults to 25 (the legacy get-context-values action defaulted to 50; the new clampPageSize helper standardises every modus-api list surface on 25). Clamped to 200. AIP-158.

Required range: 1 <= x <= 200
Example:

25

offset
number

Cursor offset (numeric). Legacy semantics — prefer pageToken for deep pages.

Required range: x >= 0
Example:

0

pageToken
string

Opaque page token from a previous response's nextPageToken. AIP-158.

searchQuery
string

Case-insensitive substring search over each value.

Example:

"open"

dataPathPrefix
string[]

Optional prefix path applied to the data-path filter before slicing values (advanced).

Example:
["salesforce", "Account"]

Response

values
any[]
required

Page of values extracted from the context item at the supplied contentKeyPath. Each entry is opaque JSON whose shape depends on the source item.

Arbitrary JSON value.

nextPageToken
string | null
required

Opaque token for the next page, or null if no more pages. Pass back as pageToken. AIP-158.