Quick Start

Make your first Propstreet API call in under 5 minutes.

1. Create a Test Token

1. Log into app.propstreet.com
2. Go to Settings → Personal Settings → Personal Access Tokens
3. Enter a name (e.g., "API Testing") and click Generate
4. Copy the token immediately—it won't be shown again

2. Make Your First Request

Fetch your first 10 contacts:

curl "https://app.propstreet.com/api/v1/network/contacts?page_size=10" \
  -H "Authorization: Bearer YOUR_TOKEN"

You'll get a response like:

{
  "data": [
    {
      "id": "con_abc123",
      "firstName": "Jane",
      "lastName": "Smith",
      "email": "jane@example.com"
    }
  ],
  "hasMore": true,
  "nextCursor": "eyJ..."
}

Node.js Example

const response = await fetch(
  "https://app.propstreet.com/api/v1/network/contacts?page_size=10",
  {
    headers: {
      Authorization: "Bearer YOUR_TOKEN",
    },
  }
);
const { data, hasMore, nextCursor } = await response.json();
console.log(`Fetched ${data.length} contacts`);

3. Next Steps

[!warning] Personal Access Tokens expire after 30 days and are tied to your account. For production integrations, use Bot User + Client Credentials.

Now that you've made your first call:

1. Choose your auth method — Read the Authentication Guide to set up production credentials
2. Sync your data — Learn Sync Patterns for pagination and delta sync
3. Handle errors — See Errors & Retries for robust error handling
4. Explore the API — Browse the full API Reference for all endpoints