Content
JSON
Retrieve a contact
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.
Retrieve a contact
Returns the detailed information of a contact from your EasyBroker account.
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/{contact_id}": {
"parameters": [
{
"name": "contact_id",
"in": "path",
"required": true,
"description": "The ID of the specified contact",
"schema": {
"type": "number"
}
}
],
"get": {
"tags": [
"Contacts"
],
"summary": "Retrieve a contact",
"description": "Returns the detailed information of a contact from your EasyBroker account.",
"responses": {
"200": {
"description": "Successful contact request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactSingle"
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedError"
},
"404": {
"$ref": "#/components/responses/contact_not_found"
}
}
}
}
},
"components": {
"responses": {
"contact_not_found": {
"description": "No contact was found with the provided ID",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "The contact couldn't be found"
}
}
}
}
}
},
"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": {
"Agent": {
"properties": {
"id": {
"type": "integer",
"example": 1234
},
"name": {
"type": "string",
"example": "John Smith"
},
"full_name": {
"type": "string",
"example": "John Smith Doe"
},
"mobile_phone": {
"type": "string",
"example": "5555550000"
},
"profile_image_url": {
"type": "string",
"example": "https://www.easybroker.com/assets/product/logo-be4da843987ccd1c05e26f8703f1787847471b36d08bdb1ec8a91ce4007b0e98.svg"
},
"email": {
"type": "string",
"example": "john@smith.com"
}
}
},
"ContactSingle": {
"properties": {
"id": {
"type": "number",
"example": "123"
},
"full_name": {
"type": "string",
"example": "John Smith"
},
"first_name": {
"type": "string",
"example": "John"
},
"last_name": {
"type": "string",
"example": "Smith"
},
"title": {
"type": "string",
"example": "Accountant"
},
"company": {
"type": "string",
"example": "Smith LLC"
},
"private_description": {
"type": "string",
"example": "One of our top clients."
},
"tags": {
"type": "array",
"example": [
"top_client",
"priority"
],
"items": {
"type": "string"
}
},
"source": {
"type": "string",
"example": "mywebsite.com"
},
"probability": {
"type": "string",
"nullable": true,
"enum": [
"low",
"medium",
"high"
],
"example": "high"
},
"agent": {
"$ref": "#/components/schemas/Agent"
},
"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"
},
"emails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactEmails"
}
},
"phones": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactPhones"
}
},
"addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactAddresses"
}
}
}
},
"ContactEmails": {
"properties": {
"type": {
"type": "string",
"example": "Work",
"enum": [
"Personal",
"Work",
"Other"
],
"description": "The contact email type"
},
"email": {
"type": "string",
"example": "mail@example.com"
}
}
},
"ContactPhones": {
"properties": {
"type": {
"type": "string",
"example": "Work",
"enum": [
"Home",
"Work",
"Mobile",
"Home fax",
"Work fax",
"Pager",
"Nextel",
"WhatsApp"
],
"description": "The contact phone type"
},
"phone": {
"type": "string",
"example": "5559090909"
}
}
},
"ContactAddresses": {
"properties": {
"type": {
"type": "string",
"example": "Work",
"enum": [
"Home",
"Work",
"Other"
],
"description": "The contact addresses type"
},
"street": {
"type": "string",
"example": "Main Street 19"
},
"city": {
"type": "string",
"example": "Portland"
},
"administrative_division": {
"type": "string",
"example": "Oregon"
},
"country": {
"type": "string",
"example": "United States of America"
},
"postal_code": {
"type": "string",
"example": "01234"
}
}
}
},
"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
}
}
}