Skip to main content
POST
Run a public RPC action

Authorizations

x-api-key
string
header
required

Use a secret org API key. Do not expose this key in browser code.

Body

application/json
action
string
required

Public RPC action name, for example list_contacts or create_call.

input
object

Action-specific input object.

identity
object

Identity payload for actions that target a specific resource.

fields
(string | object)[]

Field names or nested field-selection objects, depending on the action.

filter
object
sort

Action-specific sort expression.

page
object

Pagination options for list actions.

metadataFields
string[]

Response

200 - application/json

Action executed successfully or returned a structured RPC error.

success
boolean
required
data
required

Action-specific success payload.