Skip to main content
GET
/
users
[
  {
    "id": "user-123",
    "name": "John Smith",
    "email": "john@example.com"
  },
  {
    "id": "user-456",
    "name": "Jane Doe",
    "email": "jane@example.com"
  },
  {
    "id": "user-789",
    "name": "Sales Bot"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.enginy.ai/llms.txt

Use this file to discover all available pages before exploring further.

Your Implementation Required

This endpoint must be implemented on your server
Optional Endpoint: This endpoint is optional. If not implemented, Enginy will gracefully disable owner selection features. Return 404, 501, or 405 to indicate the endpoint is not available.
Enginy calls this endpoint to fetch the list of users/owners that can be assigned to contacts, companies, tasks, and activities in your CRM.

​
Detection

When you connect your Custom CRM to Enginy, we test this endpoint:
  • 2xx response - Users feature enabled, owner selection available in exports
  • 404/501/405 - Users feature disabled gracefully (not an error)
  • Other errors - Users feature disabled, connection proceeds normally

​
Request

No request body required. Enginy will send the API key in the configured header.
bash GET /users X-API-Key: your-api-key

​
Response

Return an array of user objects.
​
id
string
required
Unique identifier for the user in your CRM
​
name
string
required
Display name of the user
​
email
string
Email address of the user (optional, used for display)
[
  {
    "id": "user-123",
    "name": "John Smith",
    "email": "john@example.com"
  },
  {
    "id": "user-456",
    "name": "Jane Doe",
    "email": "jane@example.com"
  },
  {
    "id": "user-789",
    "name": "Sales Bot"
  }
]

​
Error Responses

StatusMeaning
200Success - users returned
401Invalid or missing API key
404Endpoint not implemented (disables owner selection)
405Method not allowed (disables owner selection)
501Not implemented (disables owner selection)
500Server error
If you don’t want to support owner selection, simply don’t implement this endpoint or return 404. Enginy will detect this during connection and hide owner-related UI elements.

​
Usage

When users are available, Enginy shows an owner dropdown in:
  • Export modal (assign owner to exported contacts)
  • Task creation (assign task owner)
  • Activity logging (associate activities with owners)
The id field from your response will be sent back when creating tasks or activities that should be assigned to a specific owner.