Content
JSON
List all contacts
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 contacts
Returns a list of contacts 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": {
"/contacts": {
"get": {
"tags": [
"Contacts"
],
"summary": "List all contacts",
"description": "Returns a list of contacts from your organization.",
"parameters": [
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/limit"
},
{
"in": "query",
"name": "search",
"required": false,
"style": "deepObject",
"explode": true,
"schema": {
"$ref": "#/components/schemas/ContactSearchParams"
}
},
{
"$ref": "#/components/parameters/contacts_search_statuses"
},
{
"$ref": "#/components/parameters/contacts_search_probability"
},
{
"$ref": "#/components/parameters/contacts_search_tag"
},
{
"$ref": "#/components/parameters/contacts_search_agent"
},
{
"$ref": "#/components/parameters/contacts_search_offices"
},
{
"$ref": "#/components/parameters/contacts_search_sources"
}
],
"responses": {
"200": {
"description": "Successful contact list request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactList"
}
}
}
},
"400": {
"description": "At least one search param has an invalid format",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "updated_before: has an invalid format"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
}
}
}
}
},
"components": {
"parameters": {
"contacts_search_tag": {
"in": "query",
"name": "search[tag]",
"required": false,
"description": "This parameter allows you to filter listings from one specific tag.",
"example": "priority",
"schema": {
"type": "string",
"default": ""
}
},
"contacts_search_agent": {
"in": "query",
"name": "search[email]",
"required": false,
"description": "This parameter allows you to filter contacts based on the assigned agent's email.",
"example": "email@example.com",
"schema": {
"type": "string",
"default": ""
}
},
"contacts_search_statuses": {
"in": "query",
"name": "search[statuses][]",
"required": false,
"explode": true,
"description": "This parameter allows you to filter contacts with the selected statuses. You must provide one of your account's status names exactly as they are shown on EasyBroker.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"contacts_search_probability": {
"in": "query",
"name": "search[probabilities][]",
"required": false,
"explode": true,
"description": "This parameter allows you to filter contacts with the selected probabilities",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"high",
"medium",
"low"
]
}
}
},
"contacts_search_offices": {
"in": "query",
"name": "search[offices][]",
"required": false,
"explode": true,
"description": "This parameter allows you to filter contacts by office names.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "Sucursal B"
}
}
},
"contacts_search_sources": {
"in": "query",
"name": "search[sources][]",
"required": false,
"explode": true,
"description": "Retrieve contact listing from multiple sources.",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "mywebsite.com"
}
}
},
"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
}
}
},
"ContactList": {
"properties": {
"pagination": {
"$ref": "#/components/schemas/Pagination"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactForList"
}
}
}
},
"ContactForList": {
"allOf": [
{
"properties": {
"id": {
"type": "integer",
"example": 123
},
"full_name": {
"type": "string",
"example": "John Smith"
},
"phone": {
"type": "string",
"example": "5559090909"
},
"email": {
"type": "string",
"example": "mail@example.com"
},
"agent": {
"type": "string",
"example": "Jane Johnson"
},
"source": {
"type": "string",
"example": "mydomain.com"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2020-03-01T23:26:53.402Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2020-03-01T23:26:53.402Z"
}
}
}
]
},
"ContactSearchParams": {
"type": "object",
"description": "Optional search parameters.",
"properties": {
"updated_after": {
"type": "string",
"format": "date-time",
"example": "2020-03-01T23:26:53.402Z",
"description": "Retrieve contacts updated after the given time."
},
"updated_before": {
"type": "string",
"format": "date-time",
"example": "2025-03-01T23:26:53.402Z",
"description": "Retrieve contacts updated before the given time."
},
"created_after": {
"type": "string",
"format": "date-time",
"example": "2020-03-01T23:26:53.402Z",
"description": "Retrieve contacts created after the given time."
},
"created_before": {
"type": "string",
"format": "date-time",
"example": "2025-03-01T23:26:53.402Z",
"description": "Retrieve contacts created before the given time."
}
}
}
},
"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
}
}
}