Skip to main content

Quick start

Read your client's tours from a backend in three steps. Replace the pk_srv_… / sk_srv_… placeholders with the credentials issued to you.

1. Get a token​

TOKEN=$(curl -s -X POST https://api.noughtyreality.com/tours/v1/auth/server/token \
-H "Content-Type: application/json" \
-d '{
"grant_type": "client_credentials",
"client_id": "pk_srv_…",
"client_secret": "sk_srv_…"
}' | jq -r .access_token)

2. List tours​

curl https://api.noughtyreality.com/tours/v1/server/tours \
-H "Authorization: Bearer $TOKEN"

Filter to a single organisation:

curl "https://api.noughtyreality.com/tours/v1/server/tours?organisationId=org_123" \
-H "Authorization: Bearer $TOKEN"

3. Get one tour​

curl https://api.noughtyreality.com/tours/v1/server/tours/<tour-id> \
-H "Authorization: Bearer $TOKEN"

The single-tour response carries the full floor → room → scan tree. See Tours for the response shapes.