v3

latestSwagger 2.02026-08-067506752.0 MB

query

Create a live query token

post/v1/org/{orgId}/query

Path parameters

orgIdstring required

Org identifier (either id or slug)

Request body

typestring required

query type

paramsobject required

query params

Response

successful operation

idstring required

globally unique id for query token

tokenstring required

globally unique random token string

orgIdstring required

id of org

userIdstring required

id of user

labelstring

query details on data that is being synced

typestring required

query type

pathstring

query path (deprecated)

paramsobject required

query params

accessCountinteger

total number of uses

createAtstring

created timestamp

expireAtstring

expire timestamp

activeAtstring

last active timestamp

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "userId": "588f7ee98f138b19220041a7",
  "createAt": "2016-11-16T13:40:47Z",
  "expireAt": "2016-11-16T13:40:47Z",
  "activeAt": "2016-11-16T13:40:47Z"
}