Ctrl+K

List users in an enterprise with pagination support

get/api/v2/internal/enterprise/{enterpriseId}/users

Path Parameters

  • enterpriseIdstringRequired
    The enterprise id
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
    Min length: >= 1 characters

Query Parameters

  • prevIdstring
    Previous user ID for cursor-based pagination
  • limitstring<number>Default: 500
    Maximum number of users to return
    Minimum: >= 1
    Maximum: <= 500
  • allowInactiveUsersbooleanDefault: false
    Include inactive users in the response

200 Response

userIds array[string] required
Array of user IDs belonging to the enterprise
Example: ["59cd72485007a239fb00282ed480da1f","59cd72485007a239fb00282ed480da2f"]
nextBatchPrevId string
The last user ID in the current batch, used as prevId for fetching the next batch. Undefined if there are no more results.
Example: 59cd72485007a239fb00282ed480da1f

400 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

401 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

403 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

404 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

500 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id