Developer Mode

Developer Mode lets you view and manage test records created by test API keys.

What Is Developer Mode?

When you use a test API key (ypk_test_...) to create records, those records are marked as test data and hidden from your normal dashboard views. Developer Mode reveals these test records so you can verify your integrations are working correctly.

Why Use Developer Mode?

• Test your integrations safely - See exactly what your test API calls create
• Verify data accuracy - Ensure fields are mapping correctly
• Debug issues - Identify problems before going live
• Keep your dashboard clean - Test data is separated from real data

Enabling Developer Mode

1. Go to Settings in the main navigation
2. Click API Keys in the settings sidebar
3. Find the Developer Mode toggle at the top of the page
4. Toggle it ON

TIP

Developer Mode is a company-wide setting. All users with access to API Keys settings can enable or disable it.

Viewing Test Records

Once Developer Mode is enabled, you'll see a new filter option in your list views:

Show Test Records Toggle

In any list view (Work Requests, Quotes, Contacts, Properties, Jobs), you'll see:

1. A "Show test records" toggle appears in the filters section
2. Toggle it ON to include test records in the list
3. Test records display with an orange TEST badge

Identifying Test Records

Test records are clearly marked:

Indicator	Description
TEST badge	Orange badge next to the record name/number
Filter	Only visible when "Show test records" is enabled

Test Record Behaviour

Records created with test API keys have special behaviour:

Feature	Behaviour
Visibility	Hidden by default, shown when filter is enabled
Notifications	No emails or push notifications sent
Events	No webhooks or integrations triggered
Audit logs	Recorded normally for debugging
Relationships	Can link to other test records

Workflow: Testing Your Integration

Here's a recommended workflow for testing:

1. Set Up Test Environment

1. Generate a test API key from Settings → API Keys
2. Enable Developer Mode
3. Configure your development environment to use the test key

2. Send Test Requests

# Example: Create a test work request
curl -X POST https://app.yardpilot.io/api/v1/integration/requests \
  -H "Content-Type: application/json" \
  -H "X-Company-Key: ypk_test_YOUR_TEST_KEY" \
  -d '{
    "customer_name": "Test Customer",
    "customer_email": "test@example.com",
    "customer_phone": "+61400000000",
    "message": "This is a test request"
  }'

3. Verify in Dashboard

1. Go to Work Requests
2. Toggle "Show test records" ON
3. Find your test request with the TEST badge
4. Verify all fields are correct

4. Switch to Live

Once testing is complete:

1. Replace your test key with a live key (ypk_live_...)
2. Disable Developer Mode if no longer needed
3. Your production requests will appear normally

Frequently Asked Questions

Can I delete test records?

Yes, you can delete test records the same way you delete any other record. The test status doesn't prevent deletion.

Do test records count toward my usage limits?

No, test records created with test API keys don't count toward your plan limits.

Can I convert a test record to a real record?

No, once a record is created as test data, it remains test data. Create a new record with a live key instead.

Will test records affect my reports?

No, test records are excluded from all reports and analytics by default.

Can I use test keys in production?

Technically yes, but it's not recommended. Test records have limited functionality and won't trigger notifications or integrations.

Troubleshooting

I don't see the "Show test records" toggle

Make sure Developer Mode is enabled in Settings → API Keys.

Test records aren't appearing

1. Verify Developer Mode is ON
2. Check the "Show test records" toggle is ON in your list view
3. Confirm your API request used a test key (ypk_test_...)
4. Check the API response was successful (201 Created)

I see the TEST badge but Developer Mode is off

This shouldn't happen normally. If you see test badges without Developer Mode enabled, contact support.

Security Considerations

• Developer Mode is a company-wide setting - all users can see test records when enabled
• Test API keys have the same permissions as live keys - they can create real-looking data
• Never use test keys on public websites - use them only in development environments

Next Steps

• API Key Setup - Generate your test and live API keys
• Work Requests API - Test your contact form integration
• Quotes API - Test quote creation