REST API Explorer

The REST API Explorer in TurboKit provides a powerful interface for testing and exploring Salesforce REST APIs directly from your browser, eliminating the need for external API tools.

Overview

Salesforce's REST API provides a powerful way to interact with your Salesforce data and metadata programmatically. The REST API Explorer in TurboKit makes it easy to test API endpoints, view responses, and understand how to use the API in your integrations.

Key Features

• Built-in Authentication: Automatically uses your current Salesforce session for authentication
• Multiple API Versions: Support for different Salesforce API versions
• Request Builder: Easily construct REST API requests
• Response Visualization: View API responses in a formatted JSON viewer
• Request History: Access your recent API requests for quick reuse
• Common Endpoints: Quick access to frequently used API endpoints
• Custom Headers: Add custom headers to your API requests

Using REST API Explorer

Making API Requests

1. Open TurboKit and select "REST API Explorer"
2. Select the API version you want to use
3. Enter the API endpoint path (e.g., /services/data/v55.0/sobjects/Account/describe)
4. Choose the HTTP method (GET, POST, PATCH, DELETE)
5. Add request body for POST/PATCH requests
6. Click "Send" to execute the request
7. View the formatted response

Common API Operations

Retrieving Object Metadata

GET /services/data/v55.0/sobjects/Account/describe

This request retrieves the metadata for the Account object, including fields, relationships, and other properties.

Creating a Record

POST /services/data/v55.0/sobjects/Account
Body: {
  "Name": "Test Account",
  "Industry": "Technology"
}

This request creates a new Account record with the specified field values.

Updating a Record

PATCH /services/data/v55.0/sobjects/Account/001XXXXXXXXXXXXXXX
Body: {
  "Industry": "Healthcare"
}

This request updates the Industry field of an existing Account record.

Deleting a Record

DELETE /services/data/v55.0/sobjects/Account/001XXXXXXXXXXXXXXX

This request deletes the specified Account record.

Advanced Features

• Custom Headers: Add custom headers to your requests, such as Sforce-Auto-Assign for controlling assignment rules
• Bulk API: Test Bulk API endpoints for large data operations
• Composite API: Test Composite API for multiple operations in a single request
• GraphQL API: Explore Salesforce's GraphQL API capabilities

Best Practices

• Always test API operations in a sandbox environment before using in production
• Use the appropriate API version for your needs
• Be mindful of API limits when making requests
• Use the response visualization to understand the structure of API responses
• Save complex API requests for future reference

Integration with Other Features

The REST API Explorer integrates with other TurboKit features:

• Use with Data Export to understand the API calls behind SOQL queries
• Combine with Event Monitor to track API usage and events
• Use alongside Metadata Retriever to understand metadata API operations