Authentication

Every request to the PropertyPal APIs must be authenticated using the OAuth2 client credentials grant. Your client_id and client_secret are issued by the PropertyPal Feeds Team.

Request a token

Exchange your credentials for a short-lived access token at the token endpoint:

$
curl -X POST https://accounts.propertypal.com/oauth2/token \
>
  -H "Content-Type: application/x-www-form-urlencoded" \
>
  -d "grant_type=client_credentials" \
>
  -d "client_id=YOUR_CLIENT_ID" \
>
  -d "client_secret=YOUR_CLIENT_SECRET" \
>
  -d "scope=openid"

A successful response returns a bearer token:

1
{
2
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVC...",
3
  "token_type": "Bearer",
4
  "expires_in": 3600,
5
  "scope": "openid"
6
}

Use the token

Send the token in the Authorization header on every API request:

$
curl https://rightmove-feed.propertypal.com/v2/property/commercial/DEMO-001 \
>
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
>
  -H "Rightmove-Agent-ID: 12345"

Cache and reuse the token until it expires, then request a new one. Avoid requesting a fresh token on every call.

Errors

See the API reference for the full error model.