---
agentTools:
projectIndex: https://piperun-atendimentos.readme.io/llms.txt
---
# Listar organizações
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "Versão 1.0",
"version": "1.0"
},
"servers": [
{
"url": "https://{subdominio}.cxm.pipe.run",
"variables": {
"subdominio": {
"default": "subdominio"
}
}
}
],
"components": {
"securitySchemes": {
"sec0": {
"type": "apiKey",
"in": "header",
"name": "Authorization",
"x-bearer-format": "bearer"
}
}
},
"security": [
{
"sec0": []
}
],
"paths": {
"/api/customer_organizations": {
"get": {
"summary": "Listar organizações",
"description": "",
"operationId": "listar-organizacoes",
"parameters": [
{
"name": "search",
"in": "query",
"description": "Campo para pesquisa simples ou dinâmica.
Pesquisa simples: Valor para procurar.
Pesquisa dinâmica: Formato [campo:valor]
Campos permitidos:- id (ID da organização)
- document_number (CNPJ)
- legal_name (Razão social)
- trade_name (Nome fantasia)
Ex: id:1",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "search_field",
"in": "query",
"description": "Nome do campo para pesquisar.
Utilizado apenas na pesquisa simples, na pesquisa dinâmica este parâmetro é ignorado.",
"required": true,
"schema": {
"type": "string",
"enum": [
"id",
"trade_name",
"legal_name",
"document_number"
]
}
},
{
"name": "Accept",
"in": "header",
"required": true,
"schema": {
"type": "string",
"default": "application/json"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"schema": {
"type": "string",
"default": "application/json"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Listar todas as organizações": {
"value": "[\n {\n \"id\": 2,\n \"trade_name\": \"5Hub Comunicação Inteligente\",\n \"legal_name\": \"5 HUB TECNOLOGIA DA INFORMACAO LTDA\",\n \"document_number\": \"36722740000189\",\n \"zip_code\": \"90560002\",\n \"address\": \"Avenida Cristóvão Colombo, 2948 - Conj 711\",\n \"complement\": null,\n \"borough\": \"Floresta\",\n \"city\": \"Porto Alegre\",\n \"state_id\": 23,\n \"country_id\": 1,\n \"created_at\": \"2023-04-25T23:38:17.000000Z\"\n },\n {\n \"id\": 1,\n \"trade_name\": \"CRM PipeRun\",\n \"legal_name\": \"ODIG - SOLUCOES DIGITAIS LTDA\",\n \"document_number\": \"08692236000148\",\n \"zip_code\": \"90560002\",\n \"address\": \"Avenida Cristóvão Colombo, 2948 / Conj 711\",\n \"complement\": null,\n \"borough\": \"Floresta\",\n \"city\": \"Porto Alegre\",\n \"state_id\": 23,\n \"country_id\": 1,\n \"created_at\": \"2023-04-25T23:37:03.000000Z\"\n }\n]"
},
"Filtrar organizações usando pesquisa simples": {
"value": "[\n {\n \"id\": 1,\n \"trade_name\": \"CRM PipeRun\",\n \"legal_name\": \"ODIG - SOLUCOES DIGITAIS LTDA\",\n \"document_number\": \"08692236000148\",\n \"zip_code\": \"90560002\",\n \"address\": \"Avenida Cristóvão Colombo, 2948 / Conj 711\",\n \"complement\": null,\n \"borough\": \"Floresta\",\n \"city\": \"Porto Alegre\",\n \"state_id\": 23,\n \"country_id\": 1,\n \"created_at\": \"2023-04-25T23:37:03.000000Z\"\n }\n]"
},
"Filtrar organizações usando pesquisa dinâmica": {
"value": "[\n {\n \"id\": 2,\n \"trade_name\": \"5Hub Comunicação Inteligente\",\n \"legal_name\": \"5 HUB TECNOLOGIA DA INFORMACAO LTDA\",\n \"document_number\": \"36722740000189\",\n \"zip_code\": \"90560002\",\n \"address\": \"Avenida Cristóvão Colombo, 2948 - Conj 711\",\n \"complement\": null,\n \"borough\": \"Floresta\",\n \"city\": \"Porto Alegre\",\n \"state_id\": 23,\n \"country_id\": 1,\n \"created_at\": \"2023-04-25T23:38:17.000000Z\"\n }\n]"
}
},
"schema": {
"oneOf": [
{
"title": "Listar todas as organizações",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 2,
"default": 0
},
"trade_name": {
"type": "string",
"example": "5Hub Comunicação Inteligente"
},
"legal_name": {
"type": "string",
"example": "5 HUB TECNOLOGIA DA INFORMACAO LTDA"
},
"document_number": {
"type": "string",
"example": "36722740000189"
},
"zip_code": {
"type": "string",
"example": "90560002"
},
"address": {
"type": "string",
"example": "Avenida Cristóvão Colombo, 2948 - Conj 711"
},
"complement": {},
"borough": {
"type": "string",
"example": "Floresta"
},
"city": {
"type": "string",
"example": "Porto Alegre"
},
"state_id": {
"type": "integer",
"example": 23,
"default": 0
},
"country_id": {
"type": "integer",
"example": 1,
"default": 0
},
"created_at": {
"type": "string",
"example": "2023-04-25T23:38:17.000000Z"
}
}
}
},
{
"title": "Filtrar organizações usando pesquisa simples",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1,
"default": 0
},
"trade_name": {
"type": "string",
"example": "CRM PipeRun"
},
"legal_name": {
"type": "string",
"example": "ODIG - SOLUCOES DIGITAIS LTDA"
},
"document_number": {
"type": "string",
"example": "08692236000148"
},
"zip_code": {
"type": "string",
"example": "90560002"
},
"address": {
"type": "string",
"example": "Avenida Cristóvão Colombo, 2948 / Conj 711"
},
"complement": {},
"borough": {
"type": "string",
"example": "Floresta"
},
"city": {
"type": "string",
"example": "Porto Alegre"
},
"state_id": {
"type": "integer",
"example": 23,
"default": 0
},
"country_id": {
"type": "integer",
"example": 1,
"default": 0
},
"created_at": {
"type": "string",
"example": "2023-04-25T23:37:03.000000Z"
}
}
}
},
{
"title": "Filtrar organizações usando pesquisa dinâmica",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 2,
"default": 0
},
"trade_name": {
"type": "string",
"example": "5Hub Comunicação Inteligente"
},
"legal_name": {
"type": "string",
"example": "5 HUB TECNOLOGIA DA INFORMACAO LTDA"
},
"document_number": {
"type": "string",
"example": "36722740000189"
},
"zip_code": {
"type": "string",
"example": "90560002"
},
"address": {
"type": "string",
"example": "Avenida Cristóvão Colombo, 2948 - Conj 711"
},
"complement": {},
"borough": {
"type": "string",
"example": "Floresta"
},
"city": {
"type": "string",
"example": "Porto Alegre"
},
"state_id": {
"type": "integer",
"example": 23,
"default": 0
},
"country_id": {
"type": "integer",
"example": 1,
"default": 0
},
"created_at": {
"type": "string",
"example": "2023-04-25T23:38:17.000000Z"
}
}
}
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error\": \"Invalid token.\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "Invalid token."
}
}
}
}
}
}
},
"deprecated": false,
"x-readme": {
"code-samples": [
{
"language": "curl",
"code": "curl --request GET \\\n --url 'https://{subdominio}.cxm.pipe.run/api/customer_organizations' \\\n --header 'Accept: application/json' \\\n --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxNCIsImp0aSI6Ijc4Yjc4YjJjMTY0MzRiNzllNWQ2MDhmYWU0ZjZkYjEyZGUxN2ZiNzc2NzQzOTMwYjU3YjI0ZmYxMmU1MWU4MTkwODA1Mjc4NzA4MGI2Y2FiIiwiaWF0IjoxNjcyNzU1NDA2LjcxOTI1OSwibmJmIjoxNjcyNzU1NDA2LjcxOTI2MywiZXhwIjoxNjcyODQxODA2LjY0NjE0MSwic3ViIjoiMjAiLCJzY29wZXMiOltdfQ.dsi59lzVPsf8Ysl-l1AbjCV1G0eoEKLyIg6H0k3lpxPdtWuGSOIzkAdxxISkukitg8XY72nMxl6lfaP2zsh9qomlBczSDm_gW0HpqFkfHCu_5YX6IiakYl_MLRWEauI1PUiiBbqhjWzJCIxnMfZK-SeZtdp8zRiUAf1M1R-6S1DdWydcBvTZ0MGzw2792LpJ7zFG6zs-lHA_fI256-j_SUjVtnDLOY4ElczlpZ8ldyJp-C47dgUjSed6CLSaZoRzQsGfFINu-VEbzf7suSFSTI7UJomrr8cRVM8e49W8jygX3Nadyn3UGTN7XbtrQ1DnI_3EvLHDDeAnhWlACaytHKx5SdWmW0IeFjRfjwXdohvKqNm4AZVDUjAL_vz1dmmPAbpkXMbI8iBx2B9CBoyE2JGo0jWLcNLBz3udqjIul0JFTtrBzNpTvdu1HBGmuzQVRiE1cT763D9MSOO8KnsLEdkRluR0eNbAdBtAIRI_aR8PxmZmy1o_PXNoCkhcEj8ZKVw9GPCuIZiLg6ij1HCXHwNQcaMjKS-gaTdous_4LGc11XLIVcsecgNc1xWfqyg-_DnGKPK_uUWbGz9BpJAINhwL18d2j75Bobx05TE3hXyn466oq1T9LvRlqMXGrLOn8h3qM6D6uLqrtw0EAyeP0NAJUUT-zhRQOjlPEPuBcQ8' \\\n --header 'Content-Type: application/json'",
"name": "Listar todas as organizações"
},
{
"language": "curl",
"code": "curl --request GET \\\n --url 'https://{subdominio}.cxm.pipe.run/api/customer_organizations?search=1&searchFields=id' \\\n --header 'Accept: application/json' \\\n --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxNCIsImp0aSI6Ijc4Yjc4YjJjMTY0MzRiNzllNWQ2MDhmYWU0ZjZkYjEyZGUxN2ZiNzc2NzQzOTMwYjU3YjI0ZmYxMmU1MWU4MTkwODA1Mjc4NzA4MGI2Y2FiIiwiaWF0IjoxNjcyNzU1NDA2LjcxOTI1OSwibmJmIjoxNjcyNzU1NDA2LjcxOTI2MywiZXhwIjoxNjcyODQxODA2LjY0NjE0MSwic3ViIjoiMjAiLCJzY29wZXMiOltdfQ.dsi59lzVPsf8Ysl-l1AbjCV1G0eoEKLyIg6H0k3lpxPdtWuGSOIzkAdxxISkukitg8XY72nMxl6lfaP2zsh9qomlBczSDm_gW0HpqFkfHCu_5YX6IiakYl_MLRWEauI1PUiiBbqhjWzJCIxnMfZK-SeZtdp8zRiUAf1M1R-6S1DdWydcBvTZ0MGzw2792LpJ7zFG6zs-lHA_fI256-j_SUjVtnDLOY4ElczlpZ8ldyJp-C47dgUjSed6CLSaZoRzQsGfFINu-VEbzf7suSFSTI7UJomrr8cRVM8e49W8jygX3Nadyn3UGTN7XbtrQ1DnI_3EvLHDDeAnhWlACaytHKx5SdWmW0IeFjRfjwXdohvKqNm4AZVDUjAL_vz1dmmPAbpkXMbI8iBx2B9CBoyE2JGo0jWLcNLBz3udqjIul0JFTtrBzNpTvdu1HBGmuzQVRiE1cT763D9MSOO8KnsLEdkRluR0eNbAdBtAIRI_aR8PxmZmy1o_PXNoCkhcEj8ZKVw9GPCuIZiLg6ij1HCXHwNQcaMjKS-gaTdous_4LGc11XLIVcsecgNc1xWfqyg-_DnGKPK_uUWbGz9BpJAINhwL18d2j75Bobx05TE3hXyn466oq1T9LvRlqMXGrLOn8h3qM6D6uLqrtw0EAyeP0NAJUUT-zhRQOjlPEPuBcQ8' \\\n --header 'Content-Type: application/json'",
"name": "Filtrar organizações usando pesquisa simples"
},
{
"language": "curl",
"code": "curl --request GET \\\n --url 'https://{subdominio}.cxm.pipe.run/api/customer_organizations?search=trade_name:hub' \\\n --header 'Accept: application/json' \\\n --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxNCIsImp0aSI6Ijc4Yjc4YjJjMTY0MzRiNzllNWQ2MDhmYWU0ZjZkYjEyZGUxN2ZiNzc2NzQzOTMwYjU3YjI0ZmYxMmU1MWU4MTkwODA1Mjc4NzA4MGI2Y2FiIiwiaWF0IjoxNjcyNzU1NDA2LjcxOTI1OSwibmJmIjoxNjcyNzU1NDA2LjcxOTI2MywiZXhwIjoxNjcyODQxODA2LjY0NjE0MSwic3ViIjoiMjAiLCJzY29wZXMiOltdfQ.dsi59lzVPsf8Ysl-l1AbjCV1G0eoEKLyIg6H0k3lpxPdtWuGSOIzkAdxxISkukitg8XY72nMxl6lfaP2zsh9qomlBczSDm_gW0HpqFkfHCu_5YX6IiakYl_MLRWEauI1PUiiBbqhjWzJCIxnMfZK-SeZtdp8zRiUAf1M1R-6S1DdWydcBvTZ0MGzw2792LpJ7zFG6zs-lHA_fI256-j_SUjVtnDLOY4ElczlpZ8ldyJp-C47dgUjSed6CLSaZoRzQsGfFINu-VEbzf7suSFSTI7UJomrr8cRVM8e49W8jygX3Nadyn3UGTN7XbtrQ1DnI_3EvLHDDeAnhWlACaytHKx5SdWmW0IeFjRfjwXdohvKqNm4AZVDUjAL_vz1dmmPAbpkXMbI8iBx2B9CBoyE2JGo0jWLcNLBz3udqjIul0JFTtrBzNpTvdu1HBGmuzQVRiE1cT763D9MSOO8KnsLEdkRluR0eNbAdBtAIRI_aR8PxmZmy1o_PXNoCkhcEj8ZKVw9GPCuIZiLg6ij1HCXHwNQcaMjKS-gaTdous_4LGc11XLIVcsecgNc1xWfqyg-_DnGKPK_uUWbGz9BpJAINhwL18d2j75Bobx05TE3hXyn466oq1T9LvRlqMXGrLOn8h3qM6D6uLqrtw0EAyeP0NAJUUT-zhRQOjlPEPuBcQ8' \\\n --header 'Content-Type: application/json'",
"name": "Filtrar organizações usando pesquisa dinâmica"
}
],
"samples-languages": [
"curl"
]
}
}
}
},
"x-readme": {
"headers": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"explorer-enabled": true,
"proxy-enabled": true
},
"x-readme-fauxas": true,
"_id": "639b9eee56a9f8002b83200b:6448602f87a8cb00455dedc6"
}
```