Welcome to the JourneyBee API documentation. The JourneyBee API allows you to access and manage your account data programmatically. You can use our API to create, read, update, and delete resources such as users, partners, and leads. If you have any question or feedback please contact us at support@journeybee.io

​
OpenAPI Specification

For developers who want to integrate programmatically, you can download our complete OpenAPI specification: Download OpenAPI Spec - Use this with your favorite API tools (Postman, Insomnia, code generators, etc.)

​
Base URL

https://app.journeybee.io/api/v1

​
Authentication

All API endpoints are authenticated using Bearer tokens. To create an api key, visit your JourneyBee account settings and click on the API Keys tab. You can create multiple keys and revoke them at any time. 
"Authorization": "Bearer {api_key}"

​
Permissions

API keys can be assigned basic read or write permissions. Read permissions allow you to access data, while write permissions allow you to create, update, and delete data.

​
Pagination

All list endpoints support pagination. You can specify the page number and page size using the page and pageSize query parameters. Default page size is 10. Maximum page size is 50. 
{base_url}/users?page=1&pageSize=10

​
Example response

{
  "id": "1",
  "name": "John Doe",
  "meta": {
    "record-count": 2,
    "page-count": 1
  }
}

​
Rate Limiting

API requests are rate limited to prevent abuse. If you exceed the rate limit, you will receive a 429 Too Many Requests response. The rate limit is 100 requests per minute.

​
Versioning

API endpoints are versioned using the v1 prefix. For example, the users endpoint is available at /v1/users. When we make backwards-incompatible changes to the API, we will release a new version.

​
Errors

Errors are returned as JSON objects with an error key. The value of the error key is a human-readable error message.

​
Example error response

{
  "error": "Invalid API key"
}

​
Status Codes

The API uses standard HTTP status codes to indicate the success or failure of a request. Here are our most used status codes:
  • 200 OK - The request was successful
  • 201 Created - The resource was created
  • 400 Bad Request - The request was invalid
  • 401 Unauthorized - The request was not authenticated
  • 403 Forbidden - The request was not authorized
  • 404 Not Found - The resource was not found
  • 429 Too Many Requests - The request was rate limited
  • 500 Internal Server Error - An unexpected error occurred

​
Content Types

The API only supports JSON content type. You must include the Content-Type: application/json header in your requests. 
"Content-Type": "application/json"

​
Supported Resources

​
Core Resources

  • Partners: Manage partnership relationships and partner companies
  • Leads: Track and manage leads with partner attribution
  • Deals: Monitor deal progress with commission calculations
  • Contacts: Maintain partner contact databases

​
Organization & Workflow

  • Stages: Customize partner and deal pipeline stages
  • Tags: Organize resources with flexible tagging
  • Categories & Tiers: Classify partners by type and tier level
  • Custom Fields: Add custom data fields to any resource

​
Collaboration

  • Notes: Add contextual notes to leads and deals
  • Users: Manage company and partner users

​
Key Features

  • Full CRUD Operations: Complete create, read, update, and delete operations for all resources
  • Partnership Management: Manage complex partner relationships, referrals, and reseller networks
  • Lead & Deal Tracking: Track leads through your sales pipeline with partner attribution
  • Custom Fields: Flexible custom field support for all resource types
  • Real-time Collaboration: Support for real-time updates and notifications
  • Webhook Integration: Real-time webhook notifications for all major events
  • CRM Synchronization: Built-in support for Salesforce, HubSpot, Pipedrive, and more

​
Getting Started

  1. Authentication: Set up API key authentication (see above)
  2. Quickstart: Try your first API calls using the examples below
  3. Explore: Browse the endpoint documentation for your use case

​
Need Help?

  • Check our Status Page for API uptime
  • Visit the main JourneyBee Dashboard to manage your account
  • Review the comprehensive endpoint documentation in the sidebar
Let’s get started with authentication and your first API calls!