Core API

The Core API allows you to programmatically manage your RequestRocket account with complete access to all resources.

Overview

Use the Core API to:

• Create and manage organisations (clients)
• Manage users and team members
• Create credentials, targets, and proxies
• Configure authorization rules
• Query request history and analytics
• Manage notifications

Base URL

https://api.requestrocket.com

Authentication

All Core API requests require authentication using your personal user token.

Getting Your User Token

1. Navigate to Settings in the RequestRocket dashboard
2. Click on the "Keys" tab
3. Copy your user token (prefixed with u-)

Using Authentication

Include your user token in the Authorization header:

curl -X GET "https://api.requestrocket.com/clients" \
  -H "Content-Type: application/json" \
  -H "Authorization: {your_user_token}"

Learn more about authentication →

Available Resources

Common Request Patterns

List Resources

Get a list of resources for a client:

GET /clients/{clientId}/credentials
GET /clients/{clientId}/targets
GET /clients/{clientId}/proxies

Get Single Resource

Retrieve a specific resource:

GET /clients/{clientId}/credentials/{credentialId}
GET /clients/{clientId}/targets/{targetId}
GET /clients/{clientId}/proxies/{proxyId}

Create Resource

Create a new resource:

POST /clients/{clientId}/credentials
POST /clients/{clientId}/targets
POST /clients/{clientId}/proxies

Update Resource

Update an existing resource:

PUT /clients/{clientId}/credentials/{credentialId}
PUT /clients/{clientId}/targets/{targetId}
PUT /clients/{clientId}/proxies/{proxyId}

Delete Resource

Remove a resource:

DELETE /clients/{clientId}/credentials/{credentialId}
DELETE /clients/{clientId}/targets/{targetId}
DELETE /clients/{clientId}/proxies/{proxyId}

Response Format

All responses use JSON format:

Success Response

{
  "clientId": "550e8400-e29b-41d4-a716-446655440000",
  "clientName": "My Organisation",
  "createdAt": "2024-01-15T10:30:00Z"
}

Error Response

{
  "error": "Invalid client ID",
  "code": "INVALID_CLIENT_ID",
  "status": 400
}

HTTP Status Codes

The Core API uses standard HTTP status codes:

Rate Limiting

Rate limits are applied per user token:

When rate limits are exceeded, you'll receive a 429 response with a Retry-After header.

Pagination

List endpoints support pagination using query parameters:

GET /clients/{clientId}/requests?page=1&limit=20

Parameters

• page: Page number (default: 1)
• limit: Items per page (default: 20, max: 100)

Response

{
  "data": [...],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "pages": 8
  }
}

Resource Identifiers

All resources use UUID v4 identifiers:

550e8400-e29b-41d4-a716-446655440000

API Collections

Download ready-to-use API collections:

• Postman Collection: Download
• Import into Postman or Insomnia
• Pre-configured requests for all endpoints
• Environment variables for easy configuration

OAuth2 Callback URL

For OAuth2 target credentials using the authorization_code flow:

https://api.requestrocket.com/webhooks/oauth2

Use this as your callback URL when configuring OAuth2 applications.

Next Steps