OneApp Partner API

Read-only access to the applicant, resident and default reports for your authorized portfolio.

Environments

EnvironmentBase URLData
Sandboxhttps://sandbox-api.oneapp.rentalsSynthetic test data only
Productionhttps://api.oneapp.rentalsYour live portfolio

Sandbox and Production use separate credentials. Build and test against Sandbox first.

Authentication

  1. We issue you a client ID and client secret for each environment, together with the token URL to use. The secret is shown once; store it like a password.
  2. Exchange them for an access token with the OAuth 2.0 client credentials grant, requesting the scopes you need.
  3. Send the token on every request as Authorization: Bearer <token>. Tokens expire after one hour; request a new one before then rather than per call.

Scopes

ScopeGrants
partner-data/applicants.readGET /api/partner/v1/applicants
partner-data/residents.readGET /api/partner/v1/residents
partner-data/defaults.readGET /api/partner/v1/defaults

Errors and rate limits