Authentication
Copy
curl -X GET "https://app.journeybee.io/api/v1/partnerships/{partnershipId}/users" \
-H "Authorization: Bearer your-api-key-uuid"
Path Parameters
The unique identifier of the partnership whose partner users you want to retrieve
Response Schema
Array of partner user objects
Show Partner User Object Properties
Show Partner User Object Properties
Total count of partner users (included in each user object)
Unique identifier for the user
User’s email address
User’s first name
User’s last name
Hex color code assigned to the user for UI purposes
User’s job title/position
User’s phone number
Asset ID of the user’s profile image
UUID of the user’s profile image asset
ID of the partner company this user belongs to
User’s personal meeting/calendar link
Name of the partner company this user belongs to
Name of the user’s country
Name of the user’s city
Example Request
Copy
curl -X GET "https://app.journeybee.io/api/v1/partnerships/456/users" \
-H "Authorization: Bearer jb_api_1234567890abcdef"
Example Response
Copy
[
{
"total": 3,
"id": 789,
"email": "alex.partner@partnerco.com",
"first_name": "Alex",
"last_name": "Partner",
"color": "#F59E0B",
"position": "Senior Sales Manager",
"phone_number": "+1-555-987-6543",
"profile_image_id": 456,
"profile_image_uuid": "partner-profile-uuid-456",
"company_id": 234,
"meeting_link": "https://calendly.com/alex-partner",
"company_name": "PartnerCorp Solutions",
"country_label": "United States",
"city_label": "San Francisco"
},
{
"total": 3,
"id": 790,
"email": "maria.rodriguez@partnerco.com",
"first_name": "Maria",
"last_name": "Rodriguez",
"color": "#8B5CF6",
"position": "Business Development Rep",
"phone_number": "+1-555-987-6544",
"profile_image_id": null,
"profile_image_uuid": null,
"company_id": 234,
"meeting_link": null,
"company_name": "PartnerCorp Solutions",
"country_label": "United States",
"city_label": "Los Angeles"
},
{
"total": 3,
"id": 791,
"email": "david.kim@partnerco.com",
"first_name": "David",
"last_name": "Kim",
"color": "#10B981",
"position": "Partnership Coordinator",
"phone_number": null,
"profile_image_id": 458,
"profile_image_uuid": "partner-profile-uuid-458",
"company_id": 234,
"meeting_link": "https://meet.google.com/david-kim",
"company_name": "PartnerCorp Solutions",
"country_label": "Canada",
"city_label": "Toronto"
}
]
Error Responses
Copy
{
"error": "Partnership ID is required"
}
Copy
{
"error": "Invalid API key or insufficient permissions"
}
Copy
{
"error": "Access denied to partnership users"
}
Copy
{
"error": "Partnership not found or not accessible"
}
Copy
{
"error": "Failed to retrieve partnership users"
}
Notes
- Requires API key with
read_accesspermission - Only returns users from partner companies (excludes your own company users)
- Disabled and inactive users are automatically filtered out