Authentication Guide

Choose the right authentication method for your Propstreet integration.

Propstreet helps brokers and investors close more deals. This API lets you sync your professional network with your CRM so you can focus on what matters: dealmaking.

Choosing an Auth Method

[!tip] Not sure what to pick? Start with a PAT for testing, then move to Bot User + Client Credentials for production.

Your goal	Use this auth method
Just want to try the API quickly	Personal Access Token (PAT)
Production integration for your own team	Bot User + Client Credentials (recommended)
App for multiple Propstreet customers	OAuth Authorization Code

Comparison

Method	Best For	Rate Limit	Expiry
Personal Access Token	Testing, scripts, quick prototypes	60 req/min	30 days
Bot + Client Credentials	Production integrations	600 req/min	Token-based
OAuth Authorization Code	Multi-tenant apps	600 req/min	Token-based

Personal Access Token (PAT)

Best for: Quick testing, single-user scripts, prototyping

Setup

Log into app.propstreet.com
Go to Settings → Personal Settings → Personal Access Tokens
Enter a descriptive name and click Generate
Copy the token immediately—it won't be shown again

Usage

curl "https://app.propstreet.com/api/v1/network/contacts" \
  -H "Authorization: Bearer YOUR_PAT_TOKEN"

[!warning] PATs expire after 30 days and are tied to your personal account. If you leave your company, integrations using your PAT will stop working. For production, use Bot User + Client Credentials.

Bot User + Client Credentials (Recommended)

Best for: Production integrations that sync your CRM with Propstreet

Bot Users are dedicated integration accounts that aren't tied to individual team members. When someone leaves, your integrations keep running.

Setup

Go to Settings → Company Settings → Client Registrations
Click Create Client
Enable Machine-to-Machine (M2M) Mode
Check Associate with Bot User and either:
- Select an existing bot user, or
- Click Create New Bot to create one inline
Store the client_id and client_secret securely

Get Access Token

curl -X POST "https://app.propstreet.com/openid/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=api:public"

Response:

{
  "access_token": "eyJhbG...",
  "token_type": "Bearer",
  "expires_in": 3600
}

Usage

curl "https://app.propstreet.com/api/v1/network/contacts" \
  -H "Authorization: Bearer ACCESS_TOKEN"

[!tip] Bot Users give you 600 requests/min—10x the PAT limit. Perfect for keeping your CRM in sync.

OAuth Authorization Code

Best for: Apps that connect multiple Propstreet customers

If you're building a product that multiple Propstreet customers will use, contact feedback@propstreet.com for Authorization Code flow setup.

Migrating from PAT to Bot User

When moving to production:

Create a Bot User + OAuth Client (see above)
Update your integration to use Client Credentials flow
Revoke the old PAT in Settings → Personal Access Tokens

Benefits:

10x higher rate limits (600 vs 60 req/min)
No dependency on individual team members
Proper audit trail for integration actions