> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.erp.olist.com/llms.txt > Use this file to discover all available pages before exploring further. # Obter Assunto do CRM > Serviço destinado a obter os dados de um assunto do CRM. ## Endpoint ``` POST https://api.tiny.com.br/api2/crm.obter.assunto.php ``` ## Parâmetros | Parâmetro | Tipo | Ocorrência | Descrição | | --------- | ------ | ----------- | ----------------------------------------- | | token | string | obrigatório | Chave gerada para identificar sua empresa | | id | int | obrigatório | Número de identificação do assunto do CRM | | formato | string | obrigatório | Formato do retorno (json) | ## Retorno | Campo | Tipo | Tamanho | Ocorrência | Descrição | | ---------------------------------------------- | ------ | ------- | ----------- | ----------------------------------------- | | retorno | object | - | obrigatório | Elemento raiz do retorno | | retorno.status\_processamento | int | - | obrigatório | Conforme tabela "Status de Processamento" | | retorno.status | string | - | obrigatório | "OK" ou "Erro" | | retorno.codigo\_erro | int | - | condicional | Conforme tabela "Códigos de erro" (1) | | retorno.erros\[] | list | - | condicional | Lista dos erros encontrados \[0..n] (1) | | retorno.erros\[].erro | string | - | condicional | Descrição do erro (1) | | retorno.assunto | object | - | condicional | Dados do assunto (2) | | retorno.assunto.id | int | - | condicional | Número de identificação do assunto | | retorno.assunto.texto\_assunto | string | - | condicional | Texto do assunto do CRM | | retorno.assunto.proxima\_acao | string | - | condicional | Próxima ação do assunto | | retorno.assunto.estagio\_assunto | string | 1 | condicional | Código do estágio do assunto (3) | | retorno.assunto.situacao\_assunto | string | 1 | condicional | Conforme tabela de Situações do Assunto | | retorno.assunto.status\_negociacao | string | 1 | condicional | Conforme tabela de Status de Negociação | | retorno.assunto.cliente | object | - | condicional | Dados do cliente | | retorno.assunto.cliente.id\_cliente | int | - | condicional | Identificação do cliente | | retorno.assunto.cliente.codigo | string | 30 | condicional | Código do cliente | | retorno.assunto.cliente.nome | string | 30 | condicional | Nome do cliente | | retorno.assunto.cliente.nome\_fantasia | string | 60 | condicional | Nome fantasia | | retorno.assunto.cliente.tipo\_pessoa | string | 1 | condicional | F/J/E (Física/Jurídica/Estrangeiro) | | retorno.assunto.cliente.cpf\_cnpj | string | 18 | condicional | CPF ou CNPJ do cliente | | retorno.assunto.cliente.ie | string | 18 | condicional | Inscrição estadual | | retorno.assunto.cliente.rg | string | 10 | condicional | RG do cliente | | retorno.assunto.cliente.endereco | string | 50 | condicional | Endereço | | retorno.assunto.cliente.numero | string | 10 | condicional | Número do endereço | | retorno.assunto.cliente.complemento | string | 50 | condicional | Complemento do endereço | | retorno.assunto.cliente.bairro | string | 30 | condicional | Bairro | | retorno.assunto.cliente.cep | string | 10 | condicional | CEP | | retorno.assunto.cliente.cidade | string | 30 | condicional | Conforme Tabela de Cidades | | retorno.assunto.cliente.uf | string | 30 | condicional | UF do cliente | | retorno.assunto.cliente.pais | string | 50 | condicional | Conforme Tabela de Países | | retorno.assunto.cliente.fone | string | 40 | condicional | Telefone | | retorno.assunto.cliente.estagio\_cliente | string | 50 | condicional | Código do estágio do cliente | | retorno.assunto.acoes\[] | list | - | condicional | Lista de ações do assunto | | retorno.assunto.acoes\[].acao.id\_acao | int | - | condicional | Identificação da ação | | retorno.assunto.acoes\[].acao.descricao\_acao | string | - | condicional | Descrição da ação | | retorno.assunto.acoes\[].acao.tipo\_data\_acao | string | 1 | condicional | Conforme tabela de Tipos de data | | retorno.assunto.acoes\[].acao.data\_acao | date | 20 | condicional | Data da ação (dd/mm/yyyy) (4) | | retorno.assunto.acoes\[].acao.situacao\_acao | string | - | condicional | Conforme tabela de Situações da ação | > (1) Erros e código de erro aparecem apenas quando status for "Erro" > (2) Dados do assunto aparecem apenas quando status for "OK" > (3) Códigos de estágio são configuráveis conforme conta Olist (obter via "Lista de estágios de assuntos do CRM") > (4) Campo data\_acao terá valor apenas se tipo\_data\_acao = "D", formato: dd/mm/yyyy ## Exemplo de chamada ```bash theme={null} curl -X POST https://api.tiny.com.br/api2/crm.obter.assunto.php \ -d "token=SEU_TOKEN&id=123456&formato=json" ``` ## Exemplos de retorno ### Erro - Token inválido ```json theme={null} { "retorno": { "status_processamento": 1, "status": "Erro", "codigo_erro": 2, "erros": [ { "erro": "token invalido" } ] } } ``` ### Erro - Consulta sem resultados ```json theme={null} { "retorno": { "status_processamento": 2, "status": "Erro", "codigo_erro": 20, "erros": [ { "erro": "A Consulta não retornou registros" } ] } } ``` ### Sucesso ```json theme={null} { "retorno": { "status_processamento": 3, "status": "OK", "assunto": { "id": 123456, "cliente": { "id_cliente": "1234", "codigo": "1235", "nome": "Contato Teste 2", "nome_fantasia": "Fantasia Contato Teste 2", "tipo_pessoa": "F", "cpf_cnpj": "22755777850", "ie": "", "rg": "1234567890", "endereco": "Rua Teste", "numero": "123", "complemento": "sala 2", "bairro": "Teste", "cep": "95700000", "cidade": "Bento Gonçalves", "uf": "RS", "fone": "5412345678", "estagio_cliente": "C" }, "texto_assunto": "Teste", "proxima_acao": "ligar", "estagio_assunto": "2", "situacao_assunto": "A", "status_negociacao": "0", "acoes": [ { "acao": { "id_acao": "15555", "descricao_acao": "Realizar contato", "tipo_data_acao": "Q", "situacao_acao": "1" } }, { "acao": { "id_acao": "15556", "descricao_acao": "Ligar", "tipo_data_acao": "D", "data_acao": "2015/01/01", "situacao_acao": "0" } } ] } } } ```