pollPairingSession

GET

/api/v1/player/pairing-sessions/{id}

const url = 'https://example.com/api/v1/player/pairing-sessions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/player/pairing-sessions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0

Poll a pairing session; the private poll secret authenticates this call. Never use the visible pairing code to poll.

Parameters

Path Parameters

required

string format: uuid

Responses

200

Pairing state or one-time enrollment result

application/json

object

data

required

object

status

required

string

Allowed values: pending claimed expired rejected

expiresAt

required

string format: date-time

screenId

string format: uuid

enrollmentToken

One-time enrollment token, present only on the first approved poll.

string

failureReason

string

Example

{
  "data": {
    "status": "pending"
  }
}

401

Poll secret missing or invalid