{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"c0b601ae-c2c1-4153-a6b0-49f6b5144e2f","name":"Rvops -  Documentação de API","description":"A **API da Rvops** é uma ferramenta que oferece aos desenvolvedores a capacidade de acessar dados de objetos e outras informações essenciais dentro da plataforma. Com ela, é possível criar soluções exclusivas que atendam às necessidades específicas de negócios, indo além das funcionalidades e recursos fornecidos pela Rvops. Além disso, é possível integrar os Serviços Rvops com outras plataformas. Essa abordagem resulta em uma maior satisfação e fidelidade do cliente, pois as empresas podem adaptar suas estratégias de engajamento para atender às demandas de seu público-alvo.\n\n---\n\n## Autenticação\n\nTodas as requisições à API da Rvops exigem autenticação via **API Key**. A chave deve ser enviada no header da requisição.\n\n**Header:**\n\n| Header | Valor |\n| --- | --- |\n| `rvops-apikey` | Sua chave de API |\n\nA API Key pode ser gerada e gerenciada dentro do CRM, na seção de configurações da conta.\n\n**Exemplo:**\n\n```\ncurl -X GET \"https://app.rvops.com/[CLIENT-ID]/api/v1/contacts\" \\\n  -H \"rvops-apikey: sua-api-key-aqui\"\n\n ```\n\n**Erros de autenticação:**\n\n- Sem header ou API Key inválida: `401 Unauthorized`\n    \n\n---\n\n## Formato de Resposta\n\n### Sucesso — Listagem e Busca (list / search)\n\nTodos os endpoints de listagem e busca retornam a mesma estrutura:\n\n``` json\n{\n  \"total\": 150,\n  \"results\": [\n    {\n      \"id\": 1,\n      \"properties\": {\n        \"firstname\": \"João\",\n        \"email\": \"joao@exemplo.com\"\n      }\n    }\n  ],\n  \"cursor\": {\n    \"next\": \"MTY4Nzg2ODQwMDAwMHw5ODI=\",\n    \"nextLink\": \"?cursor=MTY4Nzg2ODQwMDAwMHw5ODI=\"\n  },\n  \"hasMore\": true\n}\n\n ```\n\n| Campo | Tipo | Descrição |\n| --- | --- | --- |\n| `total` | number | Total de registros encontrados |\n| `results` | array | Array com os objetos retornados |\n| `cursor.next` | string | Cursor para a próxima página (vazio se não houver) |\n| `cursor.nextLink` | string | Query string pronta para usar na próxima requisição |\n| `hasMore` | boolean | `true` se existem mais páginas |\n\n### Sucesso — Criação (create)\n\nEndpoints de criação retornam status `201 Created` com a seguinte estrutura:\n\n``` json\n{\n  \"id\": 123,\n  \"properties\": {\n    \"firstname\": \"João\",\n    \"email\": \"joao@exemplo.com\"\n  },\n  \"associations\": {\n    \"deals\": [],\n    \"companies\": []\n  },\n  \"createdAt\": \"2026-03-15T12:00:00.000Z\",\n  \"updatedAt\": \"2026-03-15T12:00:00.000Z\"\n}\n\n ```\n\n### Erro\n\nTodas as respostas de erro seguem a mesma estrutura:\n\n``` json\n{\n  \"category\": \"BadRequestError\",\n  \"message\": \"Descrição do erro\",\n  \"timestamp\": \"2026-03-15T12:00:00.000Z\",\n  \"status\": \"error\"\n}\n\n ```\n\n**Códigos de erro possíveis:**\n\n| Código | Categoria | Descrição |\n| --- | --- | --- |\n| `400` | BadRequestError | Requisição malformada ou parâmetros inválidos |\n| `401` | UnauthorizedError | Credenciais inválidas ou ausentes |\n| `402` | LimitExceededError | Limite do plano atingido |\n| `403` | ForbiddenError | Sem permissão para acessar o recurso |\n| `404` | NotFoundError | Recurso não encontrado |\n| `409` | ConflictError | Conflito com estado atual do recurso (ex: registro duplicado) |\n| `422` | SemanticError | Requisição bem formada mas com erros semânticos |\n| `429` | ManyRequestError | Rate limit excedido |\n| `500` | InternalError | Erro interno do servidor |\n\n---\n\n## Paginação\n\nA API utiliza paginação baseada em **cursor**. Os parâmetros são passados via query string:\n\n| Parâmetro | Tipo | Default | Máximo | Descrição |\n| --- | --- | --- | --- | --- |\n| `limit` | number | 20 | 100 | Quantidade de registros por página |\n| `cursor` | string | — | — | Cursor da próxima página (retornado no campo `cursor.next`) |\n\n**Como paginar:**\n\n1. Faça a primeira requisição sem o parâmetro `cursor`\n    \n2. Se `hasMore` for `true`, use o valor de `cursor.next` como parâmetro `cursor` na próxima requisição\n    \n3. Repita até `hasMore` ser `false`\n    \n\n**Exemplo:**\n\n```\nGET /api/v1/contacts?limit=50\nGET /api/v1/contacts?limit=50&cursor=MTY4Nzg2ODQwMDAwMHw5ODI=\n\n ```\n\n---\n\n## Ordenação\n\nTodos os endpoints de listagem e busca suportam os seguintes parâmetros de ordenação via query string:\n\n| Parâmetro | Valores aceitos | Default | Descrição |\n| --- | --- | --- | --- |\n| `sort` | `date_modified`, `date_added`, `createdAt`, `updatedAt` | `date_modified` | Campo de ordenação |\n| `order` | `desc`, `asc` | `desc` | Direção da ordenação |\n\n---\n\n## Criação em Lote (Batch Create)\n\nOs endpoints de criação em lote permitem criar múltiplos registros em uma única requisição. Disponível para Contatos, Negócios e Empresas.\n\n**Endpoints:**\n\n- `POST /api/v1/contacts/batch/create`\n    \n- `POST /api/v1/deals/batch/create`\n    \n- `POST /api/v1/companies/batch/create`\n    \n\n**Formato do body:**\n\n``` json\n{\n  \"inputs\": [\n    {\n      \"properties\": {\n        \"firstname\": \"João\",\n        \"email\": \"joao@exemplo.com\"\n      },\n      \"associations\": {\n        \"deals\": [1],\n        \"companies\": [2]\n      }\n    },\n    {\n      \"properties\": {\n        \"firstname\": \"Maria\",\n        \"email\": \"maria@exemplo.com\"\n      }\n    }\n  ]\n}\n\n ```\n\nO campo `associations` é opcional em cada item. As mesmas regras de propriedades obrigatórias do create individual se aplicam.\n\n**Resposta:** Status `201 Created` com array dos objetos criados.\n\n---\n\n## Operators (Filtros de Busca)\n\nOs endpoints de **search** utilizam filtros para buscar registros com base nos valores das propriedades. Os filtros são passados como um array de objetos dentro do campo `filters`. Cada objeto no array é tratado como uma condição **E** (AND). Não há suporte para condição **OU** (OR).\n\n### Estrutura do filtro\n\n``` json\n{\n    \"filters\": [\n        {\n            \"propertyName\": \"nome_da_propriedade\",\n            \"operator\": \"OPERADOR\",\n            \"value\": \"valor\"\n        }\n    ]\n}\n\n ```\n\n### Operadores disponíveis\n\n| Operador | Descrição | Campo de valor | Tipo | Exemplo |\n| --- | --- | --- | --- | --- |\n| `EQ` | Igual a | `value` | string | `\"value\": \"São Paulo\"` |\n| `NEQ` | Diferente de | `value` | string | `\"value\": \"São Paulo\"` |\n| `GT` | Maior que | `value` | string | `\"value\": \"100\"` |\n| `GTE` | Maior ou igual a | `value` | string | `\"value\": \"100\"` |\n| `LT` | Menor que | `value` | string | `\"value\": \"50\"` |\n| `LTE` | Menor ou igual a | `value` | string | `\"value\": \"50\"` |\n| `IN` | Contido em uma lista | `values` | array | `\"values\": [\"1\", \"2\", \"3\"]` |\n| `NOT_IN` | Não contido em uma lista | `values` | array | `\"values\": [\"1\", \"2\"]` |\n| `HAS_PROPERTY` | Propriedade existe (tem valor) | — | — | sem campo de valor |\n| `NOT_HAS_PROPERTY` | Propriedade não existe (sem valor) | — | — | sem campo de valor |\n| `CONTAINS_TOKEN` | Contém a palavra (busca parcial) | `value` | string | `\"value\": \"Paulo\"` |\n| `NOT_CONTAINS_TOKEN` | Não contém a palavra | `value` | string | `\"value\": \"Paulo\"` |\n\n### Regras importantes\n\n- **`EQ`****,** **`NEQ`****,** **`GT`****,** **`GTE`****,** **`LT`****,** **`LTE`****,** **`CONTAINS_TOKEN`****,** **`NOT_CONTAINS_TOKEN`**: usam o campo `value` com tipo **string**.\n    \n- **`IN`****,** **`NOT_IN`**: usam o campo `values` com tipo **array de strings**.\n    \n- **`HAS_PROPERTY`****,** **`NOT_HAS_PROPERTY`**: **não precisam de campo de valor**. Apenas verificam se a propriedade possui ou não algum valor preenchido.\n    \n- **`CONTAINS_TOKEN`**: realiza busca parcial (equivalente a SQL `LIKE %valor%`). Exemplo: `\"value\": \"Paulo\"` encontra \"São Paulo\", \"Paulorama\", etc.\n    \n- **`NEQ`**: também retorna registros onde a propriedade é nula (não preenchida).\n    \n- **Campos** **`date`** **e** **`datetime`**: a comparação é feita apenas pela data (ignora hora). O valor deve estar no formato `YYYY-MM-DD` ou `YYYY-MM-DD HH:mm`.\n    \n- **Campos** **`number`** **e** **`currency`**: comparação numérica direta.\n    \n- **Múltiplos filtros**: todos os filtros no array são combinados com **AND**. Não há suporte para **OR** entre filtros.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"14009453","team":5322721,"collectionId":"c0b601ae-c2c1-4153-a6b0-49f6b5144e2f","publishedId":"2sBXigMZPC","public":true,"publicUrl":"https://developers.rvops.com","privateUrl":"https://go.postman.co/documentation/14009453-c0b601ae-c2c1-4153-a6b0-49f6b5144e2f","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/9d8b47f0-3bee-433f-ab95-66c28b32c856/TG9nb193aGl0ZV8gY29sb3IucG5n","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/b88b98a3-f07e-458b-af57-3516adff17d9/TG9nb19ibGFja18gY29sb3IucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2026-03-15T17:10:21.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/b88b98a3-f07e-458b-af57-3516adff17d9/TG9nb19ibGFja18gY29sb3IucG5n","logoDark":"https://content.pstmn.io/9d8b47f0-3bee-433f-ab95-66c28b32c856/TG9nb193aGl0ZV8gY29sb3IucG5n"}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/4e3fd8a7204affed407eba3ed9d174a522cd615d1eebcbfcf9947f6c9ad636fa","favicon":"https://rvops.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://developers.rvops.com/view/metadata/2sBXigMZPC"}