Skip to main content
POST
Information Query

Overview

Sends an Information Query (iq) to an entity on the XMPP network, given its Full JID. For connected entities, you need to have an presence subscription to that entity, approved by the entity, to get the Full JID. You get the Full JID using the Presence Probe resource.

Authentication

Requires a valid JWT bearer token.

Notes

This endpoint uses the request schema notation described in Pattern matching.

Authorizations

Authorization
string
header
required

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

Headers

Referer
string<uri>
required

Your application's HTTPS URL, for example https://app.example.com/. Include this header on every Agent API request, including backend calls, login, and account creation. Browser clients must use a referrer policy that sends the application origin. See /neuron-api/api-basics#required-referer-header.

Body

application/json
to
string
required
type
string
required
xml
string
required

XML query element serialized as a string, as accepted by the resource's Xml pattern.

Response

200 - application/json

Success

ok
boolean
required
errorCode
integer
errorText
string
errorType
string
ErrorElement
object
Stanza
object