GET
/
api
/
v1
/
users
Get Company Users
curl --request GET \
  --url https://app.journeybee.io/api/v1/users \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 456,
    "created_at": "2024-01-10T09:15:00Z",
    "email": "john.smith@company.com",
    "first_name": "John",
    "last_name": "Smith",
    "role": "admin",
    "position": "Partnership Manager",
    "email_verified": "2024-01-10T09:30:00Z",
    "disabled_at": null,
    "color": "#4F46E5",
    "profile_image_id": 789,
    "profile_image_uuid": "profile-uuid-789",
    "country_id": 1,
    "country_label": "United States",
    "country_code": "US"
  },
  {
    "id": 457,
    "created_at": "2024-01-12T14:20:00Z",
    "email": "sarah.johnson@company.com",
    "first_name": "Sarah",
    "last_name": "Johnson",
    "role": "partnerships",
    "position": "Business Development",
    "email_verified": "2024-01-12T14:45:00Z",
    "disabled_at": null,
    "color": "#059669",
    "profile_image_id": null,
    "profile_image_uuid": null,
    "country_id": 1,
    "country_label": "United States",
    "country_code": "US"
  }
]

​
Authentication

curl -X GET "https://app.journeybee.io/api/v1/users" \
  -H "Authorization: Bearer your-api-key-uuid"

​
Query Parameters

​
indirect
string
Include disabled/indirect users in the response. Accepts any value to enable.

​
Response Schema

​
users
array
Array of user objects

​
Example Request

curl -X GET "https://app.journeybee.io/api/v1/users" \
  -H "Authorization: Bearer jb_api_1234567890abcdef"

​
Example Response

[
  {
    "id": 456,
    "created_at": "2024-01-10T09:15:00Z",
    "email": "john.smith@company.com",
    "first_name": "John",
    "last_name": "Smith",
    "role": "admin",
    "position": "Partnership Manager",
    "email_verified": "2024-01-10T09:30:00Z",
    "disabled_at": null,
    "color": "#4F46E5",
    "profile_image_id": 789,
    "profile_image_uuid": "profile-uuid-789",
    "country_id": 1,
    "country_label": "United States",
    "country_code": "US"
  },
  {
    "id": 457,
    "created_at": "2024-01-12T14:20:00Z",
    "email": "sarah.johnson@company.com",
    "first_name": "Sarah",
    "last_name": "Johnson",
    "role": "partnerships",
    "position": "Business Development",
    "email_verified": "2024-01-12T14:45:00Z",
    "disabled_at": null,
    "color": "#059669",
    "profile_image_id": null,
    "profile_image_uuid": null,
    "country_id": 1,
    "country_label": "United States",
    "country_code": "US"
  }
]

​
Error Responses

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

{
  "error": "Access denied to company users"
}

{
  "error": "Company not found"
}

{
  "error": "Failed to retrieve company users"
}

​
Notes

  • Requires API key with read_access permission
  • Only returns users from the specified company (company-scoped access)
  • Disabled users are excluded by default unless explicitly requested