Skip to main content
POST
/
api
/
run
/
matching
/
index
/
getQueueStatus
getQueueStatus
curl --request POST \
  --url https://connvo-dev.convex.cloud/api/run/matching/index/getQueueStatus \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "args": {}
}'
{
  "status": "success",
  "errorMessage": "<string>",
  "errorData": {},
  "value": {
    "_creationTime": 123,
    "_id": "<string>",
    "availableFrom": 123,
    "availableTo": 123,
    "constraints": {
      "interests": [
        "<string>"
      ],
      "orgConstraints": "<string>",
      "roles": [
        "<string>"
      ]
    },
    "createdAt": 123,
    "estimatedWaitTime": 123,
    "matchedWith": "<string>",
    "potentialMatches": 123,
    "queuePosition": 123,
    "status": "waiting",
    "updatedAt": 123,
    "userId": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Standard user authentication token issued via WorkOS. Provide as Authorization: Bearer <user-token>.

Body

application/json
args
object
required

Response

Convex executed your request and returned a result

status
enum<string>
required
Available options:
success,
error
errorMessage
string
errorData
object
value
object | null