Content
JSON
List all users
Documentation Index
Fetch the complete documentation index at: https://easybroker-staging.readme.io/llms.txt
Use this file to discover all available pages before exploring further.
List all users
Returns a list of active users from your organization.
OpenAPI definition
{
"openapi": "3.0.0",
"info": {
"version": "1.0",
"title": "EasyBroker API",
"description": "API for accessing and working with EasyBroker accounts. To get started click the Authorize button below and enter your API key."
},
"externalDocs": {
"description": "View the getting started guide in Spanish",
"url": "https://dev.easybroker.com/docs/api-de-easybroker"
},
"security": [
{
"ApiKeyAuth": []
}
],
"servers": [
{
"url": "https://api.stagingeb.com/v1",
"description": "API URL"
}
],
"paths": {
"/users": {
"get": {
"tags": [
"Users"
],
"summary": "List all users",
"description": "Returns a list of active users from your organization.",
"parameters": [
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/limit"
}
],
"responses": {
"200": {
"description": "Successful user list request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserList"
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
}
}
}
}
},
"components": {
"parameters": {
"page": {
"name": "page",
"in": "query",
"required": false,
"description": "Content's page",
"schema": {
"type": "integer",
"default": 1
}
},
"limit": {
"name": "limit",
"in": "query",
"required": false,
"description": "Max results per page (Maximum: 50)",
"schema": {
"type": "integer",
"maximum": 50,
"default": 20
}
}
},
"responses": {
"UnauthorizedError": {
"description": "API key is missing or invalid",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "Your API key is invalid"
}
}
}
}
}
}
},
"schemas": {
"Pagination": {
"required": [
"limit",
"page",
"total,",
"next_page"
],
"properties": {
"limit": {
"type": "integer",
"format": "int64",
"maximum": 50,
"example": 20
},
"page": {
"type": "integer",
"format": "int64",
"example": 1
},
"total": {
"type": "integer",
"format": "int64",
"example": 1
},
"next_page": {
"type": "string",
"example": null
}
}
},
"UserList": {
"properties": {
"pagination": {
"$ref": "#/components/schemas/Pagination"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserForList"
}
}
}
},
"UserForList": {
"allOf": [
{
"properties": {
"first_name": {
"type": "string",
"example": "John"
},
"last_name": {
"type": "string",
"example": "Smith"
},
"email": {
"type": "string",
"example": "john@smith.com"
},
"title": {
"type": "string",
"example": "Agent"
},
"mobile_phone": {
"type": "string",
"example": "+525555550000"
},
"profile_image_url": {
"type": "string",
"example": "https://www.easybroker.com/assets/product/logo-be4da843987ccd1c05e26f8703f1787847471b36d08bdb1ec8a91ce4007b0e98.svg"
}
}
}
]
}
},
"securitySchemes": {
"ApiKeyAuth": {
"type": "apiKey",
"in": "header",
"name": "X-Authorization",
"description": "You can find your API key in the general settings section of your EasyBroker account. It's only accessible for account administrators."
}
}
},
"x-readme": {
"explorer-enabled": true,
"proxy-enabled": true
},
"_id": {
"buffer": {
"0": 99,
"1": 142,
"2": 110,
"3": 111,
"4": 217,
"5": 194,
"6": 135,
"7": 0,
"8": 24,
"9": 185,
"10": 196,
"11": 37
}
}
}