GET
/
api
/
v1
/
partnerships
Get Partners
curl --request GET \
  --url https://app.journeybee.io/api/v1/partnerships \
  --header 'Authorization: Bearer <token>'
[
  {
    "total": 1,
    "id": 789,
    "stage_id": 1,
    "stage_label": "Prospecting",
    "stage_series": 1,
    "partnership": {
      "id": 456,
      "created_at": "2024-01-15T10:30:00Z",
      "stage": "accepted",
      "partner_type": "referral"
    },
    "tier": {
      "id": 2,
      "label": "Gold",
      "background_color": "#FFD700",
      "text_color": "#000000"
    },
    "category": {
      "id": 3,
      "label": "Technology"
    },
    "partner": {
      "id": 234,
      "name": "TechCorp Solutions",
      "website_url": "https://techcorp.com",
      "logo": {
        "id": 567,
        "uuid": "logo-uuid-123"
      },
      "address": {
        "country_id": 1,
        "country_label": "United States"
      },
      "fallback_data": null
    },
    "assigned_users": [
      {
        "id": 456,
        "email": "john@company.com",
        "first_name": "John",
        "last_name": "Doe",
        "profile_image_id": 789,
        "profile_image_uuid": "profile-uuid-456",
        "color": "#3B82F6"
      }
    ],
    "tags": [
      {
        "id": 10,
        "label": "High Priority",
        "background_color": "#EF4444",
        "text_color": "#FFFFFF"
      }
    ],
    "customFields": [
      {
        "id": 5,
        "label": "Revenue Potential",
        "type": "number",
        "value": {
          "number": 100000
        },
        "custom_field_value_id": 123
      }
    ]
  }
]

​
Authentication

curl -X GET "https://app.journeybee.io/api/v1/partnerships" \
  -H "Authorization: Bearer your-api-key-uuid" \
  -H "Content-Type: application/json"

​
Query Parameters

​
userId
number
required
The ID of the user making the request (for authorization)
​
cursor
string
Pagination cursor for fetching the next set of results
​
search
string
Search partners by name, email, website, country, or assigned users
​
view
string
Filter by partner type or assignment status. Options: all, assigned, referral, reseller
​
stages
string
Comma-separated list of stage IDs to filter by
​
tags
string
Comma-separated list of tag IDs to filter by
​
categories
string
Comma-separated list of category IDs to filter by
​
tiers
string
Comma-separated list of tier IDs to filter by
​
users
string
Comma-separated list of user IDs to filter by assigned users
​
assigned
number
Filter by assignment status. Use 1 to show only assigned partners
​
unassigned
number
Filter by assignment status. Use 1 to show only unassigned partners
​
customFields
string
JSON string of custom field filters with format: [{"id": 123, "value": {"text": "search"}}]
​
sort
string
JSON string of sort options with format: [{"type": "stage", "asc": true}]. Types: stage, category, tier

​
Response Schema

​
partners
array
Array of partnership objects

​
Example Request

curl -X GET "https://app.journeybee.io/api/v1/partnerships?userId=456&view=referral&search=tech" \
  -H "Authorization: Bearer jb_api_1234567890abcdef" \
  -H "Content-Type: application/json"

​
Example Response

[
  {
    "total": 1,
    "id": 789,
    "stage_id": 1,
    "stage_label": "Prospecting",
    "stage_series": 1,
    "partnership": {
      "id": 456,
      "created_at": "2024-01-15T10:30:00Z",
      "stage": "accepted",
      "partner_type": "referral"
    },
    "tier": {
      "id": 2,
      "label": "Gold",
      "background_color": "#FFD700",
      "text_color": "#000000"
    },
    "category": {
      "id": 3,
      "label": "Technology"
    },
    "partner": {
      "id": 234,
      "name": "TechCorp Solutions",
      "website_url": "https://techcorp.com",
      "logo": {
        "id": 567,
        "uuid": "logo-uuid-123"
      },
      "address": {
        "country_id": 1,
        "country_label": "United States"
      },
      "fallback_data": null
    },
    "assigned_users": [
      {
        "id": 456,
        "email": "john@company.com",
        "first_name": "John",
        "last_name": "Doe",
        "profile_image_id": 789,
        "profile_image_uuid": "profile-uuid-456",
        "color": "#3B82F6"
      }
    ],
    "tags": [
      {
        "id": 10,
        "label": "High Priority",
        "background_color": "#EF4444",
        "text_color": "#FFFFFF"
      }
    ],
    "customFields": [
      {
        "id": 5,
        "label": "Revenue Potential",
        "type": "number",
        "value": {
          "number": 100000
        },
        "custom_field_value_id": 123
      }
    ]
  }
]

​
Error Responses

{
  "error": "Invalid API key or insufficient permissions"
}

{
  "error": "Read access required for this operation"
}

{
  "error": "Company not found or user not authorized"
}

​
Notes

  • Requires API key with read_access permission
  • Results are paginated using cursor-based pagination
  • Default view is determined by company’s enabled partner types
  • Custom field filters support complex querying by field type
  • Search functionality includes fuzzy matching across multiple fields