API v1 documentation API Reference

Autenticação

Para utilizar a nossa API RESTful é necessário gerar uma ApiKey dentro de seu Moskit CRM em Marketplace > API pública do Moskit CRM.

Todos os requests devem conter um header chamadado "apikey" com o valor da apikey gerada.

Limite de Requisições

Por questões de segurança a API conta com um limite de 5 requisições por segundo. Qualquer requisição que ultrapasse esse limite vai falhar resultando no código de erro 429 (Too Many Requests).

Domínio da API

Atualmente nossa API está na versão v1 por isso utilize o domínio https://api.moskitcrm.com/v1 seguido do endpoint que deseja.

Por exemplo: Listagem de contatos => [GET] https://api.moskitcrm.com/v1/contacts

ContentType

Por padrão todo Request e Response utiliza o tipo json, por isso sempre que enviar seus dados para API ou sempre que receber a resposta para ser trabalhada, utilize o padrão json.

Paginação

A paginação é baseada em deslocamento assim como os bancos de dados relacionais (offset e limit). O limite máximo de registros por página é de 100 registros.

Por exemplo, supondo uma páginação de 20 resultados por página:
Página 1 => start=0, limit=20
Página 2 => start=20, limit=20
Página 3 => start=40, limit=20
.

Campos de Data

As datas na API utilizam timestamps em milissegundos, e por esse motivo seus valores são inteiros e devem estar de acordo com o fuso horário UTC.

Por exemplo: dia 4 de Outubro de 2017 as 09:00h horário de Brasília (UTC-3) = 04/10/2017 09:00 horário de Brasília (UTC-3) = 04/10/2017 12:00 (UTC+0) = 1507118400000. Portanto o valor a ser inserido seria 1507118400000.

Dúvidas

Qualquer dúvida entre em contato com nosso suporte.

API Endpoint
https://api.moskitcrm.com/v1
Schemes: https
Version: v1

Authentication

apikey

name
apikey
in
header

Activity

POST /activities

Criação de nova atividade

dateCreated: Data de criação

doneDate: Data de conclusão

dueDate: Data da atividade

duration: Duração em minutos

totalDays: Duração em dias

notes: Observações

title: Assunto

createdBy: Usuário criador (/users)

responsible: Usuário responsável (/users)

type: Tipo de atividade (/activityTypes)

contacts: Contatos relacionados (/contacts)

companies: Empresas relacionadas (/companies)

deals: Negócios relacionados (/deals)

projects: Projetos relacionados (/projects)

customFieldValues: Valores dos campos personalizados

Request Content-Types: application/json
Request Example
{
  "dateCreated": "integer (int64)",
  "doneDate": "integer (int64)",
  "dueDate": "integer (int64)",
  "duration": "integer (int32)",
  "totalDays": "integer (int32)",
  "notes": "string",
  "title": "string",
  "createdBy": {
    "id": "integer (int64)"
  },
  "responsible": {
    "id": "integer (int64)"
  },
  "type": {
    "id": "integer (int64)"
  },
  "contacts": [
    {
      "id": "integer (int64)"
    }
  ],
  "companies": [
    {
      "id": "integer (int64)"
    }
  ],
  "deals": [
    {
      "id": "integer (int64)"
    }
  ],
  "projects": [
    {
      "id": "integer (int64)"
    }
  ],
  "customFieldValues": [
    {
      "value": "string",
      "customField": {
        "id": "integer (int64)"
      }
    }
  ]
}
200 OK

successful operation

403 Forbidden

unauthorized

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /activities

Exibe a listagem de todas as atividades

start

Deslocamento (offset) de registros para paginação

type
integer (int64)
in
query
limit

Número de registros da página (no máximo 100)

type
integer (int64)
in
query
sort

Nome do campo para ordernar a busca

type
string
in
query
order

Tipo de ordenação feita no campo, ascendente (asc) ou descendente (desc)

type
string asc, desc
in
query
200 OK

successful operation

403 Forbidden

unauthorized

Response Content-Types: application/json

DELETE /activities/{id}

Remove a atividade Importante: a atividade só pode ser removida se ainda não tiver data de conclusão

id

(no description)

type
integer (int64)
in
path
204 No Content

successful operation

404 Not Found

not found

PUT /activities/{id}

Atualização de atividade Importante: a atividade só pode ser editada se ainda não tiver data de conclusão

dateCreated: Data de criação

doneDate: Data de conclusão

dueDate: Data da atividade

duration: Duração em minutos

totalDays: Duração em dias

notes: Observações

title: Assunto

createdBy: Usuário criador (/users)

responsible: Usuário responsável (/users)

type: Tipo de atividade (/activityTypes)

contacts: Contatos relacionados (/contacts)

companies: Empresas relacionadas (/companies)

deals: Negócios relacionados (/deals)

projects: Projetos relacionados (/projects)

customFieldValues: Valores dos campos personalizados

id

(no description)

type
integer (int64)
in
path
Request Content-Types: application/json
Request Example
{
  "dateCreated": "integer (int64)",
  "doneDate": "integer (int64)",
  "dueDate": "integer (int64)",
  "duration": "integer (int32)",
  "totalDays": "integer (int32)",
  "notes": "string",
  "title": "string",
  "createdBy": {
    "id": "integer (int64)"
  },
  "responsible": {
    "id": "integer (int64)"
  },
  "type": {
    "id": "integer (int64)"
  },
  "contacts": [
    {
      "id": "integer (int64)"
    }
  ],
  "companies": [
    {
      "id": "integer (int64)"
    }
  ],
  "deals": [
    {
      "id": "integer (int64)"
    }
  ],
  "projects": [
    {
      "id": "integer (int64)"
    }
  ],
  "customFieldValues": [
    {
      "value": "string",
      "customField": {
        "id": "integer (int64)"
      }
    }
  ]
}
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /activities/{id}

Exibe os detalhes da atividade

id

(no description)

type
integer (int64)
in
path
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

Response Content-Types: application/json

ActivityType

POST /activityTypes

Criação de novo tipo de atividade

name: Nome

Request Content-Types: application/json
Request Example
{
  "name": "string"
}
200 OK

successful operation

403 Forbidden

unauthorized

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /activityTypes

Exibe a listagem de todos os tipos atividades

start

Deslocamento (offset) de registros para paginação

type
integer (int64)
in
query
limit

Número de registros da página (no máximo 100)

type
integer (int64)
in
query
sort

Nome do campo para ordernar a busca

type
string
in
query
order

Tipo de ordenação feita no campo, ascendente (asc) ou descendente (desc)

type
string asc, desc
in
query
200 OK

successful operation

403 Forbidden

unauthorized

Response Content-Types: application/json

DELETE /activityTypes/{id}

Remove o tipo de atividade

id

(no description)

type
integer (int64)
in
path
204 No Content

successful operation

404 Not Found

not found

PUT /activityTypes/{id}

Atualização do tipo de atividade

name: Nome

id

(no description)

type
integer (int64)
in
path
Request Content-Types: application/json
Request Example
{
  "name": "string"
}
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /activityTypes/{id}

Exibe os detalhes do tipo de atividade

id

(no description)

type
integer (int64)
in
path
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

Response Content-Types: application/json

Attachment

POST /attachments

Adiciona um anexo ao contato, empresa, negócio ou projeto

url: Endereço URL do arquivo

contact: Contato relacionado (/contacts)

company: Empresa relacionada (/companies)

deal: Negócio relacionado (/deals)

project: Projeto relacionado (/projects)

Request Content-Types: application/json
Request Example
{
  "url": "string",
  "contact": {
    "id": "integer (int64)"
  },
  "company": {
    "id": "integer (int64)"
  },
  "deal": {
    "id": "integer (int64)"
  },
  "project": {
    "id": "integer (int64)"
  }
}
200 OK

successful operation

403 Forbidden

unauthorized

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

Board

POST /boards

Criação de um novo painel

name: Nome

Request Content-Types: application/json
Request Example
{
  "name": "string"
}
200 OK

successful operation

403 Forbidden

unauthorized

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /boards

Exibe a listagem de todos os painéis

start

Deslocamento (offset) de registros para paginação

type
integer (int64)
in
query
limit

Número de registros da página (no máximo 100)

type
integer (int64)
in
query
sort

Nome do campo para ordernar a busca

type
string
in
query
order

Tipo de ordenação feita no campo, ascendente (asc) ou descendente (desc)

type
string asc, desc
in
query
200 OK

successful operation

403 Forbidden

unauthorized

Response Content-Types: application/json

DELETE /boards/{id}

Remove o painel

id

(no description)

type
integer (int64)
in
path
204 No Content

successful operation

404 Not Found

not found

PUT /boards/{id}

Atualização do painel

name: Nome

id

(no description)

type
integer (int64)
in
path
Request Content-Types: application/json
Request Example
{
  "name": "string"
}
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /boards/{id}

Exibe os detalhes do painel

id

(no description)

type
integer (int64)
in
path
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

Response Content-Types: application/json

Company

POST /companies

Criação de nova empresa

name: Nome

domain: Site

notes: Observações

picture: Endereço URL da imagem

dateCreated: Data de criação

createdBy: Usuário criador (/users)

responsible: Usuário responsável (/users)

emails: Emails da empresa

phones: Telefones da empresa

socialProfiles: Mídias sociais

employees: Contatos empregados na empresa (/contacts)

customFieldValues: Valores dos campos personalizados

Request Content-Types: application/json
Request Example
{
  "name": "string",
  "domain": "string",
  "notes": "string",
  "picture": "string",
  "dateCreated": "integer (int64)",
  "createdBy": {
    "id": "integer (int64)"
  },
  "responsible": {
    "id": "integer (int64)"
  },
  "emails": [
    {
      "id": "integer (int64)",
      "address": "string",
      "type": {
        "id": "integer (int64)"
      }
    }
  ],
  "phones": [
    {
      "id": "integer (int64)",
      "number": "string",
      "type": {
        "id": "integer (int64)"
      }
    }
  ],
  "socialProfiles": [
    {
      "id": "integer (int64)",
      "url": "string",
      "type": {
        "id": "integer (int64)"
      }
    }
  ],
  "employees": [
    {
      "id": "integer (int64)",
      "jobTitle": "string",
      "contact": {
        "id": "integer (int64)"
      },
      "company": {
        "id": "integer (int64)"
      }
    }
  ],
  "customFieldValues": [
    {
      "value": "string",
      "customField": {
        "id": "integer (int64)"
      }
    }
  ]
}
200 OK

successful operation

403 Forbidden

unauthorized

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /companies

Exibe a listagem de todas as empresas

start

Deslocamento (offset) de registros para paginação

type
integer (int64)
in
query
limit

Número de registros da página (no máximo 100)

type
integer (int64)
in
query
sort

Nome do campo para ordernar a busca

type
string
in
query
order

Tipo de ordenação feita no campo, ascendente (asc) ou descendente (desc)

type
string asc, desc
in
query
email

Parâmetro usado para encontrar uma empresa que possua o valor exato passado em algum de seus endereços emails

type
string
in
query
200 OK

successful operation

403 Forbidden

unauthorized

Response Content-Types: application/json

DELETE /companies/{id}

Remove a empresa

id

(no description)

type
integer (int64)
in
path
204 No Content

successful operation

404 Not Found

not found

PUT /companies/{id}

Atualização de empresa

name: Nome

domain: Site

notes: Observações

picture: Endereço URL da imagem

dateCreated: Data de criação

createdBy: Usuário criador (/users)

responsible: Usuário responsável (/users)

emails: Emails da empresa

phones: Telefones da empresa

socialProfiles: Mídias sociais

employees: Contatos empregados na empresa (/contacts)

customFieldValues: Valores dos campos personalizados

id

(no description)

type
integer (int64)
in
path
Request Content-Types: application/json
Request Example
{
  "name": "string",
  "domain": "string",
  "notes": "string",
  "picture": "string",
  "dateCreated": "integer (int64)",
  "createdBy": {
    "id": "integer (int64)"
  },
  "responsible": {
    "id": "integer (int64)"
  },
  "emails": [
    {
      "id": "integer (int64)",
      "address": "string",
      "type": {
        "id": "integer (int64)"
      }
    }
  ],
  "phones": [
    {
      "id": "integer (int64)",
      "number": "string",
      "type": {
        "id": "integer (int64)"
      }
    }
  ],
  "socialProfiles": [
    {
      "id": "integer (int64)",
      "url": "string",
      "type": {
        "id": "integer (int64)"
      }
    }
  ],
  "employees": [
    {
      "id": "integer (int64)",
      "jobTitle": "string",
      "contact": {
        "id": "integer (int64)"
      },
      "company": {
        "id": "integer (int64)"
      }
    }
  ],
  "customFieldValues": [
    {
      "value": "string",
      "customField": {
        "id": "integer (int64)"
      }
    }
  ]
}
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /companies/{id}

Exibe os detalhes da empresa

id

(no description)

type
integer (int64)
in
path
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

Response Content-Types: application/json

Contact

POST /contacts

Criação de novo contato

name: Nome

notes: Observações

picture: Endereço URL da imagem

dateCreated: Data de criação

createdBy: Usuário criador (/users)

responsible: Usuário responsável (/users)

emails: Emails do contato

phones: Telefones do contato

socialProfiles: Mídias sociais

employers: Empresas empregadoras do contato (/companies)

customFieldValues: Valores dos campos personalizados

Request Content-Types: application/json
Request Example
{
  "name": "string",
  "notes": "string",
  "picture": "string",
  "dateCreated": "integer (int64)",
  "createdBy": {
    "id": "integer (int64)"
  },
  "responsible": {
    "id": "integer (int64)"
  },
  "emails": [
    {
      "id": "integer (int64)",
      "address": "string",
      "type": {
        "id": "integer (int64)"
      }
    }
  ],
  "phones": [
    {
      "id": "integer (int64)",
      "number": "string",
      "type": {
        "id": "integer (int64)"
      }
    }
  ],
  "socialProfiles": [
    {
      "id": "integer (int64)",
      "url": "string",
      "type": {
        "id": "integer (int64)"
      }
    }
  ],
  "employers": [
    {
      "id": "integer (int64)",
      "jobTitle": "string",
      "contact": {
        "id": "integer (int64)"
      },
      "company": {
        "id": "integer (int64)"
      }
    }
  ],
  "customFieldValues": [
    {
      "value": "string",
      "customField": {
        "id": "integer (int64)"
      }
    }
  ]
}
200 OK

successful operation

403 Forbidden

unauthorized

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /contacts

Exibe a listagem de todos os contatos

start

Deslocamento (offset) de registros para paginação

type
integer (int64)
in
query
limit

Número de registros da página (no máximo 100)

type
integer (int64)
in
query
sort

Nome do campo para ordernar a busca

type
string
in
query
order

Tipo de ordenação feita no campo, ascendente (asc) ou descendente (desc)

type
string asc, desc
in
query
email

Parâmetro usado para encontrar um contato que possua o valor exato passado em algum de seus endereços emails

type
string
in
query
200 OK

successful operation

403 Forbidden

unauthorized

Response Content-Types: application/json

DELETE /contacts/{id}

Remove o contato

id

(no description)

type
integer (int64)
in
path
204 No Content

successful operation

404 Not Found

not found

PUT /contacts/{id}

Atualização do contato

name: Nome

notes: Observações

picture: Endereço URL da imagem

dateCreated: Data de criação

createdBy: Usuário criador (/users)

responsible: Usuário responsável (/users)

emails: Emails do contato

phones: Telefones do contato

socialProfiles: Mídias sociais

employers: Empresas empregadoras do contato (/companies)

customFieldValues: Valores dos campos personalizados

id

(no description)

type
integer (int64)
in
path
Request Content-Types: application/json
Request Example
{
  "name": "string",
  "notes": "string",
  "picture": "string",
  "dateCreated": "integer (int64)",
  "createdBy": {
    "id": "integer (int64)"
  },
  "responsible": {
    "id": "integer (int64)"
  },
  "emails": [
    {
      "id": "integer (int64)",
      "address": "string",
      "type": {
        "id": "integer (int64)"
      }
    }
  ],
  "phones": [
    {
      "id": "integer (int64)",
      "number": "string",
      "type": {
        "id": "integer (int64)"
      }
    }
  ],
  "socialProfiles": [
    {
      "id": "integer (int64)",
      "url": "string",
      "type": {
        "id": "integer (int64)"
      }
    }
  ],
  "employers": [
    {
      "id": "integer (int64)",
      "jobTitle": "string",
      "contact": {
        "id": "integer (int64)"
      },
      "company": {
        "id": "integer (int64)"
      }
    }
  ],
  "customFieldValues": [
    {
      "value": "string",
      "customField": {
        "id": "integer (int64)"
      }
    }
  ]
}
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /contacts/{id}

Exibe os detalhes do contato

id

(no description)

type
integer (int64)
in
path
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

Response Content-Types: application/json

CustomField

POST /customFields/activities

Criação de novo campo personalizado

name: Nome

type: Tipo

options: Opções da lista (apenas para campos do tipo lista)

priority: Prioridade (determina a ordem dos campos)

pipelines: Funis em qual será exibido (/pipelines). Caso o valor seja null o campo aparecerá em todos os funis

boards: Painel

Request Content-Types: application/json
Request Example
{
  "name": "string",
  "type": "string",
  "options": [
    {
      "id": "integer (int64)",
      "label": "string"
    }
  ],
  "priority": "integer (int32)",
  "pipelines": [
    {
      "id": "integer (int64)"
    }
  ],
  "boards": [
    {
      "id": "integer (int64)"
    }
  ],
  "category": {
    "name": "string"
  }
}
200 OK

successful operation

403 Forbidden

unauthorized

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /customFields/activities

Exibe a listagem de todos os campos personalizados

start

Deslocamento (offset) de registros para paginação

type
integer (int64)
in
query
limit

Número de registros da página (no máximo 100)

type
integer (int64)
in
query
sort

Nome do campo para ordernar a busca

type
string
in
query
order

Tipo de ordenação feita no campo, ascendente (asc) ou descendente (desc)

type
string asc, desc
in
query
200 OK

successful operation

403 Forbidden

unauthorized

Response Content-Types: application/json

DELETE /customFields/activities/{id}

Remove o campo personalizado

id

(no description)

type
integer (int64)
in
path
204 No Content

successful operation

404 Not Found

not found

PUT /customFields/activities/{id}

Atualização do campo personalizado

name: Nome

type: Tipo

options: Opções da lista (apenas para campos do tipo lista)

priority: Prioridade (determina a ordem dos campos)

pipelines: Funis em qual será exibido (/pipelines). Caso o valor seja null o campo aparecerá em todos os funis

boards: Painel

id

(no description)

type
integer (int64)
in
path
Request Content-Types: application/json
Request Example
{
  "name": "string",
  "type": "string",
  "options": [
    {
      "id": "integer (int64)",
      "label": "string"
    }
  ],
  "priority": "integer (int32)",
  "pipelines": [
    {
      "id": "integer (int64)"
    }
  ],
  "boards": [
    {
      "id": "integer (int64)"
    }
  ],
  "category": {
    "name": "string"
  }
}
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /customFields/activities/{id}

Exibe os detalhes do campo personalizado

id

(no description)

type
integer (int64)
in
path
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

Response Content-Types: application/json

POST /customFields/companies

Criação de novo campo personalizado

name: Nome

type: Tipo

options: Opções da lista (apenas para campos do tipo lista)

priority: Prioridade (determina a ordem dos campos)

pipelines: Funis em qual será exibido (/pipelines). Caso o valor seja null o campo aparecerá em todos os funis

boards: Painel

Request Content-Types: application/json
Request Example
{
  "name": "string",
  "type": "string",
  "options": [
    {
      "id": "integer (int64)",
      "label": "string"
    }
  ],
  "priority": "integer (int32)",
  "pipelines": [
    {
      "id": "integer (int64)"
    }
  ],
  "boards": [
    {
      "id": "integer (int64)"
    }
  ],
  "category": {
    "name": "string"
  }
}
200 OK

successful operation

403 Forbidden

unauthorized

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /customFields/companies

Exibe a listagem de todos os campos personalizados

start

Deslocamento (offset) de registros para paginação

type
integer (int64)
in
query
limit

Número de registros da página (no máximo 100)

type
integer (int64)
in
query
sort

Nome do campo para ordernar a busca

type
string
in
query
order

Tipo de ordenação feita no campo, ascendente (asc) ou descendente (desc)

type
string asc, desc
in
query
200 OK

successful operation

403 Forbidden

unauthorized

Response Content-Types: application/json

DELETE /customFields/companies/{id}

Remove o campo personalizado

id

(no description)

type
integer (int64)
in
path
204 No Content

successful operation

404 Not Found

not found

PUT /customFields/companies/{id}

Atualização do campo personalizado

name: Nome

type: Tipo

options: Opções da lista (apenas para campos do tipo lista)

priority: Prioridade (determina a ordem dos campos)

pipelines: Funis em qual será exibido (/pipelines). Caso o valor seja null o campo aparecerá em todos os funis

boards: Painel

id

(no description)

type
integer (int64)
in
path
Request Content-Types: application/json
Request Example
{
  "name": "string",
  "type": "string",
  "options": [
    {
      "id": "integer (int64)",
      "label": "string"
    }
  ],
  "priority": "integer (int32)",
  "pipelines": [
    {
      "id": "integer (int64)"
    }
  ],
  "boards": [
    {
      "id": "integer (int64)"
    }
  ],
  "category": {
    "name": "string"
  }
}
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /customFields/companies/{id}

Exibe os detalhes do campo personalizado

id

(no description)

type
integer (int64)
in
path
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

Response Content-Types: application/json

POST /customFields/contacts

Criação de novo campo personalizado

name: Nome

type: Tipo

options: Opções da lista (apenas para campos do tipo lista)

priority: Prioridade (determina a ordem dos campos)

pipelines: Funis em qual será exibido (/pipelines). Caso o valor seja null o campo aparecerá em todos os funis

boards: Painel

Request Content-Types: application/json
Request Example
{
  "name": "string",
  "type": "string",
  "options": [
    {
      "id": "integer (int64)",
      "label": "string"
    }
  ],
  "priority": "integer (int32)",
  "pipelines": [
    {
      "id": "integer (int64)"
    }
  ],
  "boards": [
    {
      "id": "integer (int64)"
    }
  ],
  "category": {
    "name": "string"
  }
}
200 OK

successful operation

403 Forbidden

unauthorized

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /customFields/contacts

Exibe a listagem de todos os campos personalizados

start

Deslocamento (offset) de registros para paginação

type
integer (int64)
in
query
limit

Número de registros da página (no máximo 100)

type
integer (int64)
in
query
sort

Nome do campo para ordernar a busca

type
string
in
query
order

Tipo de ordenação feita no campo, ascendente (asc) ou descendente (desc)

type
string asc, desc
in
query
200 OK

successful operation

403 Forbidden

unauthorized

Response Content-Types: application/json

DELETE /customFields/contacts/{id}

Remove o campo personalizado

id

(no description)

type
integer (int64)
in
path
204 No Content

successful operation

404 Not Found

not found

PUT /customFields/contacts/{id}

Atualização do campo personalizado

name: Nome

type: Tipo

options: Opções da lista (apenas para campos do tipo lista)

priority: Prioridade (determina a ordem dos campos)

pipelines: Funis em qual será exibido (/pipelines). Caso o valor seja null o campo aparecerá em todos os funis

boards: Painel

id

(no description)

type
integer (int64)
in
path
Request Content-Types: application/json
Request Example
{
  "name": "string",
  "type": "string",
  "options": [
    {
      "id": "integer (int64)",
      "label": "string"
    }
  ],
  "priority": "integer (int32)",
  "pipelines": [
    {
      "id": "integer (int64)"
    }
  ],
  "boards": [
    {
      "id": "integer (int64)"
    }
  ],
  "category": {
    "name": "string"
  }
}
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /customFields/contacts/{id}

Exibe os detalhes do campo personalizado

id

(no description)

type
integer (int64)
in
path
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

Response Content-Types: application/json

POST /customFields/deals

Criação de novo campo personalizado

name: Nome

type: Tipo

options: Opções da lista (apenas para campos do tipo lista)

priority: Prioridade (determina a ordem dos campos)

pipelines: Funis em qual será exibido (/pipelines). Caso o valor seja null o campo aparecerá em todos os funis

boards: Painel

Request Content-Types: application/json
Request Example
{
  "name": "string",
  "type": "string",
  "options": [
    {
      "id": "integer (int64)",
      "label": "string"
    }
  ],
  "priority": "integer (int32)",
  "pipelines": [
    {
      "id": "integer (int64)"
    }
  ],
  "boards": [
    {
      "id": "integer (int64)"
    }
  ],
  "category": {
    "name": "string"
  }
}
200 OK

successful operation

403 Forbidden

unauthorized

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /customFields/deals

Exibe a listagem de todos os campos personalizados

start

Deslocamento (offset) de registros para paginação

type
integer (int64)
in
query
limit

Número de registros da página (no máximo 100)

type
integer (int64)
in
query
sort

Nome do campo para ordernar a busca

type
string
in
query
order

Tipo de ordenação feita no campo, ascendente (asc) ou descendente (desc)

type
string asc, desc
in
query
200 OK

successful operation

403 Forbidden

unauthorized

Response Content-Types: application/json

DELETE /customFields/deals/{id}

Remove o campo personalizado

id

(no description)

type
integer (int64)
in
path
204 No Content

successful operation

404 Not Found

not found

PUT /customFields/deals/{id}

Atualização do campo personalizado

name: Nome

type: Tipo

options: Opções da lista (apenas para campos do tipo lista)

priority: Prioridade (determina a ordem dos campos)

pipelines: Funis em qual será exibido (/pipelines). Caso o valor seja null o campo aparecerá em todos os funis

boards: Painel

id

(no description)

type
integer (int64)
in
path
Request Content-Types: application/json
Request Example
{
  "name": "string",
  "type": "string",
  "options": [
    {
      "id": "integer (int64)",
      "label": "string"
    }
  ],
  "priority": "integer (int32)",
  "pipelines": [
    {
      "id": "integer (int64)"
    }
  ],
  "boards": [
    {
      "id": "integer (int64)"
    }
  ],
  "category": {
    "name": "string"
  }
}
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /customFields/deals/{id}

Exibe os detalhes do campo personalizado

id

(no description)

type
integer (int64)
in
path
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

Response Content-Types: application/json

POST /customFields/projects

Criação de novo campo personalizado

name: Nome

type: Tipo

options: Opções da lista (apenas para campos do tipo lista)

priority: Prioridade (determina a ordem dos campos)

pipelines: Funis em qual será exibido (/pipelines). Caso o valor seja null o campo aparecerá em todos os funis

boards: Painel

Request Content-Types: application/json
Request Example
{
  "name": "string",
  "type": "string",
  "options": [
    {
      "id": "integer (int64)",
      "label": "string"
    }
  ],
  "priority": "integer (int32)",
  "pipelines": [
    {
      "id": "integer (int64)"
    }
  ],
  "boards": [
    {
      "id": "integer (int64)"
    }
  ],
  "category": {
    "name": "string"
  }
}
200 OK

successful operation

403 Forbidden

unauthorized

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /customFields/projects

Exibe a listagem de todos os campos personalizados

start

Deslocamento (offset) de registros para paginação

type
integer (int64)
in
query
limit

Número de registros da página (no máximo 100)

type
integer (int64)
in
query
sort

Nome do campo para ordernar a busca

type
string
in
query
order

Tipo de ordenação feita no campo, ascendente (asc) ou descendente (desc)

type
string asc, desc
in
query
200 OK

successful operation

403 Forbidden

unauthorized

Response Content-Types: application/json

DELETE /customFields/projects/{id}

Remove o campo personalizado

id

(no description)

type
integer (int64)
in
path
204 No Content

successful operation

404 Not Found

not found

PUT /customFields/projects/{id}

Atualização do campo personalizado

name: Nome

type: Tipo

options: Opções da lista (apenas para campos do tipo lista)

priority: Prioridade (determina a ordem dos campos)

pipelines: Funis em qual será exibido (/pipelines). Caso o valor seja null o campo aparecerá em todos os funis

boards: Painel

id

(no description)

type
integer (int64)
in
path
Request Content-Types: application/json
Request Example
{
  "name": "string",
  "type": "string",
  "options": [
    {
      "id": "integer (int64)",
      "label": "string"
    }
  ],
  "priority": "integer (int32)",
  "pipelines": [
    {
      "id": "integer (int64)"
    }
  ],
  "boards": [
    {
      "id": "integer (int64)"
    }
  ],
  "category": {
    "name": "string"
  }
}
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /customFields/projects/{id}

Exibe os detalhes do campo personalizado

id

(no description)

type
integer (int64)
in
path
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

Response Content-Types: application/json

Deal

POST /deals

Criação de novo negócio

dateCreated: Data de criação

name: Nome

price: Valor em centavos

previsionCloseDate: Data previsa

createdBy: Usuário criador (/users)

responsible: Usuário responsável (/users)

stage: Fase do negócio (/stages)

status: Status do negócio

contacts: Contatos relacionados (/contacts)

companies: Empresas relacionadas (/companies)

won: Dados do ganhou

lost: Dados do perdeu

customFieldValues: Valores dos campos personalizados

products: Protudos relacionadas

Request Content-Types: application/json
Request Example
{
  "dateCreated": "integer (int64)",
  "name": "string",
  "price": "integer (int64)",
  "previsionCloseDate": "integer (int64)",
  "createdBy": {
    "id": "integer (int64)"
  },
  "responsible": {
    "id": "integer (int64)"
  },
  "stage": {
    "id": "integer (int64)"
  },
  "status": "string",
  "contacts": [
    {
      "id": "integer (int64)"
    }
  ],
  "companies": [
    {
      "id": "integer (int64)"
    }
  ],
  "won": {
    "closeDate": "integer (int64)"
  },
  "lost": {
    "closeDate": "integer (int64)",
    "lostReason": {
      "id": "integer (int64)"
    }
  },
  "customFieldValues": [
    {
      "value": "string",
      "customField": {
        "id": "integer (int64)"
      }
    }
  ],
  "products": [
    {
      "id": "integer (int64)",
      "quantity": "integer (int32)",
      "price": "integer (int64)",
      "product": {
        "id": "integer (int64)"
      }
    }
  ]
}
200 OK

successful operation

403 Forbidden

unauthorized

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /deals

Exibe a listagem de todos os negócios

start

Deslocamento (offset) de registros para paginação

type
integer (int64)
in
query
limit

Número de registros da página (no máximo 100)

type
integer (int64)
in
query
sort

Nome do campo para ordernar a busca

type
string
in
query
order

Tipo de ordenação feita no campo, ascendente (asc) ou descendente (desc)

type
string asc, desc
in
query
200 OK

successful operation

403 Forbidden

unauthorized

Response Content-Types: application/json

DELETE /deals/{id}

Remove o negócio

id

(no description)

type
integer (int64)
in
path
204 No Content

successful operation

404 Not Found

not found

PUT /deals/{id}

Atualização do negócio

dateCreated: Data de criação

name: Nome

price: Valor em centavos

previsionCloseDate: Data previsa

createdBy: Usuário criador (/users)

responsible: Usuário responsável (/users)

stage: Fase do negócio (/stages)

status: Status do negócio

contacts: Contatos relacionados (/contacts)

companies: Empresas relacionadas (/companies)

won: Dados do ganhou

lost: Dados do perdeu

customFieldValues: Valores dos campos personalizados

products: Protudos relacionadas

id

(no description)

type
integer (int64)
in
path
Request Content-Types: application/json
Request Example
{
  "dateCreated": "integer (int64)",
  "name": "string",
  "price": "integer (int64)",
  "previsionCloseDate": "integer (int64)",
  "createdBy": {
    "id": "integer (int64)"
  },
  "responsible": {
    "id": "integer (int64)"
  },
  "stage": {
    "id": "integer (int64)"
  },
  "status": "string",
  "contacts": [
    {
      "id": "integer (int64)"
    }
  ],
  "companies": [
    {
      "id": "integer (int64)"
    }
  ],
  "won": {
    "closeDate": "integer (int64)"
  },
  "lost": {
    "closeDate": "integer (int64)",
    "lostReason": {
      "id": "integer (int64)"
    }
  },
  "customFieldValues": [
    {
      "value": "string",
      "customField": {
        "id": "integer (int64)"
      }
    }
  ],
  "products": [
    {
      "id": "integer (int64)",
      "quantity": "integer (int32)",
      "price": "integer (int64)",
      "product": {
        "id": "integer (int64)"
      }
    }
  ]
}
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /deals/{id}

Exibe os detalhes do negócio

id

(no description)

type
integer (int64)
in
path
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

Response Content-Types: application/json

POST /deals/{id}/contacts

Relaciona um contato existente com um negócio existente

id: Contato a ser relacionado (/contacts)

dealId

(no description)

type
integer (int64)
in
path
Request Content-Types: application/json
Request Example
{
  "id": "integer (int64)"
}
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

EmailType

GET /emailTypes

Exibe a listagem de todos os tipos de email

start

Deslocamento (offset) de registros para paginação

type
integer (int64)
in
query
limit

Número de registros da página (no máximo 100)

type
integer (int64)
in
query
sort

Nome do campo para ordernar a busca

type
string
in
query
order

Tipo de ordenação feita no campo, ascendente (asc) ou descendente (desc)

type
string asc, desc
in
query
200 OK

successful operation

403 Forbidden

unauthorized

Response Content-Types: application/json

GET /emailTypes/{id}

Exibe os detalhes do tipo de email

id

(no description)

type
integer (int64)
in
path
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

Response Content-Types: application/json

LostReason

POST /lostReasons

Criação de novo motivo de perda de negócio

name: Nome

pipelines: Funis em qual será exibido (/pipelines). Caso o valor seja null o motivo aparecerá em todos os funis

Request Content-Types: application/json
Request Example
{
  "name": "string",
  "pipelines": [
    {
      "id": "integer (int64)"
    }
  ]
}
200 OK

successful operation

403 Forbidden

unauthorized

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /lostReasons

Exibe a listagem de todos os motivos de perda de negócio

start

Deslocamento (offset) de registros para paginação

type
integer (int64)
in
query
limit

Número de registros da página (no máximo 100)

type
integer (int64)
in
query
sort

Nome do campo para ordernar a busca

type
string
in
query
order

Tipo de ordenação feita no campo, ascendente (asc) ou descendente (desc)

type
string asc, desc
in
query
200 OK

successful operation

403 Forbidden

unauthorized

Response Content-Types: application/json

DELETE /lostReasons/{id}

Remove o motivo de perda de negócio

id

(no description)

type
integer (int64)
in
path
204 No Content

successful operation

404 Not Found

not found

PUT /lostReasons/{id}

Atualização de motivo de perda de negócio

name: Nome

pipelines: Funis em qual será exibido (/pipelines). Caso o valor seja null o motivo aparecerá em todos os funis

id

(no description)

type
integer (int64)
in
path
Request Content-Types: application/json
Request Example
{
  "name": "string",
  "pipelines": [
    {
      "id": "integer (int64)"
    }
  ]
}
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /lostReasons/{id}

Exibe os detalhes do motivo de perda de negócio

id

(no description)

type
integer (int64)
in
path
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

Response Content-Types: application/json

Note

POST /notes

Criação de nova nota na timeline do contato, empresa e/ou negócio

description: Descrição da nota de timeline

dateCreated: Data de criação

createdBy: Usuário criador (/users)

companies: Empresas relacionadas (/companies)

contacts: Contatos relacionados (/contacts)

deals: Negócios relacionados (/deals)

Request Content-Types: application/json
Request Example
{
  "description": "string",
  "dateCreated": "integer (int64)",
  "createdBy": {
    "id": "integer (int64)"
  },
  "companies": [
    {
      "id": "integer (int64)"
    }
  ],
  "contacts": [
    {
      "id": "integer (int64)"
    }
  ],
  "deals": [
    {
      "id": "integer (int64)"
    }
  ]
}
200 OK

successful operation

403 Forbidden

unauthorized

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

PhoneType

POST /phoneTypes/companies

Criação de novo tipo de telefone

name: Nome

Request Content-Types: application/json
Request Example
{
  "name": "string"
}
200 OK

successful operation

403 Forbidden

unauthorized

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /phoneTypes/companies

Exibe a listagem de todos os tipos de telefone

start

Deslocamento (offset) de registros para paginação

type
integer (int64)
in
query
limit

Número de registros da página (no máximo 100)

type
integer (int64)
in
query
sort

Nome do campo para ordernar a busca

type
string
in
query
order

Tipo de ordenação feita no campo, ascendente (asc) ou descendente (desc)

type
string asc, desc
in
query
200 OK

successful operation

403 Forbidden

unauthorized

Response Content-Types: application/json

DELETE /phoneTypes/companies/{id}

Remove o tipo de telefone

id

(no description)

type
integer (int64)
in
path
204 No Content

successful operation

404 Not Found

not found

PUT /phoneTypes/companies/{id}

Atualização do tipo de telefone

name: Nome

id

(no description)

type
integer (int64)
in
path
Request Content-Types: application/json
Request Example
{
  "name": "string"
}
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /phoneTypes/companies/{id}

Exibe os detalhes do tipo de telefone

id

(no description)

type
integer (int64)
in
path
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

Response Content-Types: application/json

POST /phoneTypes/contacts

Criação de novo tipo de telefone

name: Nome

Request Content-Types: application/json
Request Example
{
  "name": "string"
}
200 OK

successful operation

403 Forbidden

unauthorized

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /phoneTypes/contacts

Exibe a listagem de todos os tipos de telefone

start

Deslocamento (offset) de registros para paginação

type
integer (int64)
in
query
limit

Número de registros da página (no máximo 100)

type
integer (int64)
in
query
sort

Nome do campo para ordernar a busca

type
string
in
query
order

Tipo de ordenação feita no campo, ascendente (asc) ou descendente (desc)

type
string asc, desc
in
query
200 OK

successful operation

403 Forbidden

unauthorized

Response Content-Types: application/json

DELETE /phoneTypes/contacts/{id}

Remove o tipo de telefone

id

(no description)

type
integer (int64)
in
path
204 No Content

successful operation

404 Not Found

not found

PUT /phoneTypes/contacts/{id}

Atualização do tipo de telefone

name: Nome

id

(no description)

type
integer (int64)
in
path
Request Content-Types: application/json
Request Example
{
  "name": "string"
}
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /phoneTypes/contacts/{id}

Exibe os detalhes do tipo de telefone

id

(no description)

type
integer (int64)
in
path
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

Response Content-Types: application/json

Pipeline

POST /pipelines

Criação de um novo funil

name: Nome

Request Content-Types: application/json
Request Example
{
  "name": "string"
}
200 OK

successful operation

403 Forbidden

unauthorized

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /pipelines

Exibe a listagem de todos os funis

start

Deslocamento (offset) de registros para paginação

type
integer (int64)
in
query
limit

Número de registros da página (no máximo 100)

type
integer (int64)
in
query
sort

Nome do campo para ordernar a busca

type
string
in
query
order

Tipo de ordenação feita no campo, ascendente (asc) ou descendente (desc)

type
string asc, desc
in
query
200 OK

successful operation

403 Forbidden

unauthorized

Response Content-Types: application/json

DELETE /pipelines/{id}

Remove o funil

id

(no description)

type
integer (int64)
in
path
204 No Content

successful operation

404 Not Found

not found

PUT /pipelines/{id}

Atualização do funil

name: Nome

id

(no description)

type
integer (int64)
in
path
Request Content-Types: application/json
Request Example
{
  "name": "string"
}
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /pipelines/{id}

Exibe os detalhes do funil

id

(no description)

type
integer (int64)
in
path
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

Response Content-Types: application/json

Product

POST /products

Criação de novo produto

name: Nome

sku: Sku

description: Descrição

price: Preço

active: Ativo

createdBy: Usuário criador (/users)

Request Content-Types: application/json
Request Example
{
  "name": "string",
  "sku": "string",
  "description": "string",
  "price": "integer (int64)",
  "active": "boolean",
  "createdBy": {
    "id": "integer (int64)"
  }
}
200 OK

successful operation

403 Forbidden

unauthorized

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /products

Exibe a listagem de todos os produtos

start

Deslocamento (offset) de registros para paginação

type
integer (int64)
in
query
limit

Número de registros da página (no máximo 100)

type
integer (int64)
in
query
sort

Nome do campo para ordernar a busca

type
string
in
query
order

Tipo de ordenação feita no campo, ascendente (asc) ou descendente (desc)

type
string asc, desc
in
query
200 OK

successful operation

403 Forbidden

unauthorized

Response Content-Types: application/json

PUT /products/{id}

Atualização do produto

name: Nome

sku: Sku

description: Descrição

price: Preço

active: Ativo

createdBy: Usuário criador (/users)

id

(no description)

type
integer (int64)
in
path
Request Content-Types: application/json
Request Example
{
  "name": "string",
  "sku": "string",
  "description": "string",
  "price": "integer (int64)",
  "active": "boolean",
  "createdBy": {
    "id": "integer (int64)"
  }
}
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /products/{id}

Exibe os detalhes do produto

id

(no description)

type
integer (int64)
in
path
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

Response Content-Types: application/json

Project

POST /projects

Criação de novo projeto

dateCreated: Data de criação

name: Nome

archived: Se o projeto está arquivado

previsionCloseDate: Data de entrega

createdBy: Usuário criador (/users)

responsible: Usuário responsável (/users)

step: Etapa do projeto (/steps)

contacts: Contatos relacionados (/contacts)

companies: Empresas relacionadas (/companies)

deals: Negócios relacionados (/deals)

customFieldValues: Valores dos campos personalizados

Request Content-Types: application/json
Request Example
{
  "dateCreated": "integer (int64)",
  "name": "string",
  "archived": "boolean",
  "previsionCloseDate": "integer (int64)",
  "createdBy": {
    "id": "integer (int64)"
  },
  "responsible": {
    "id": "integer (int64)"
  },
  "step": {
    "id": "integer (int64)"
  },
  "contacts": [
    {
      "id": "integer (int64)"
    }
  ],
  "companies": [
    {
      "id": "integer (int64)"
    }
  ],
  "deals": [
    {
      "id": "integer (int64)"
    }
  ],
  "customFieldValues": [
    {
      "value": "string",
      "customField": {
        "id": "integer (int64)"
      }
    }
  ]
}
200 OK

successful operation

403 Forbidden

unauthorized

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /projects

Exibe a listagem de todos os projetos

start

Deslocamento (offset) de registros para paginação

type
integer (int64)
in
query
limit

Número de registros da página (no máximo 100)

type
integer (int64)
in
query
sort

Nome do campo para ordernar a busca

type
string
in
query
order

Tipo de ordenação feita no campo, ascendente (asc) ou descendente (desc)

type
string asc, desc
in
query
200 OK

successful operation

403 Forbidden

unauthorized

Response Content-Types: application/json

DELETE /projects/{id}

Remove o projeto

id

(no description)

type
integer (int64)
in
path
204 No Content

successful operation

404 Not Found

not found

PUT /projects/{id}

Atualização do projeto

dateCreated: Data de criação

name: Nome

archived: Se o projeto está arquivado

previsionCloseDate: Data de entrega

createdBy: Usuário criador (/users)

responsible: Usuário responsável (/users)

step: Etapa do projeto (/steps)

contacts: Contatos relacionados (/contacts)

companies: Empresas relacionadas (/companies)

deals: Negócios relacionados (/deals)

customFieldValues: Valores dos campos personalizados

id

(no description)

type
integer (int64)
in
path
Request Content-Types: application/json
Request Example
{
  "dateCreated": "integer (int64)",
  "name": "string",
  "archived": "boolean",
  "previsionCloseDate": "integer (int64)",
  "createdBy": {
    "id": "integer (int64)"
  },
  "responsible": {
    "id": "integer (int64)"
  },
  "step": {
    "id": "integer (int64)"
  },
  "contacts": [
    {
      "id": "integer (int64)"
    }
  ],
  "companies": [
    {
      "id": "integer (int64)"
    }
  ],
  "deals": [
    {
      "id": "integer (int64)"
    }
  ],
  "customFieldValues": [
    {
      "value": "string",
      "customField": {
        "id": "integer (int64)"
      }
    }
  ]
}
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /projects/{id}

Exibe os detalhes do projeto

id

(no description)

type
integer (int64)
in
path
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

Response Content-Types: application/json

SocialProfileType

GET /socialProfileTypes

Exibe a listagem de todos os tipos de email

start

Deslocamento (offset) de registros para paginação

type
integer (int64)
in
query
limit

Número de registros da página (no máximo 100)

type
integer (int64)
in
query
sort

Nome do campo para ordernar a busca

type
string
in
query
order

Tipo de ordenação feita no campo, ascendente (asc) ou descendente (desc)

type
string asc, desc
in
query
200 OK

successful operation

403 Forbidden

unauthorized

Response Content-Types: application/json

GET /socialProfileTypes/{id}

Exibe os detalhes do tipo de email

id

(no description)

type
integer (int64)
in
path
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

Response Content-Types: application/json

Stage

POST /stages

Criação de nova fase de negócio

name: Nome

priority: Prioridade (determina a ordem das fases)

pipeline: Funil (/pipelines)

Request Content-Types: application/json
Request Example
{
  "name": "string",
  "priority": "integer (int32)",
  "pipeline": {
    "id": "integer (int64)"
  }
}
200 OK

successful operation

403 Forbidden

unauthorized

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /stages

Exibe a listagem de todas as fases de negócio

start

Deslocamento (offset) de registros para paginação

type
integer (int64)
in
query
limit

Número de registros da página (no máximo 100)

type
integer (int64)
in
query
sort

Nome do campo para ordernar a busca

type
string
in
query
order

Tipo de ordenação feita no campo, ascendente (asc) ou descendente (desc)

type
string asc, desc
in
query
200 OK

successful operation

403 Forbidden

unauthorized

Response Content-Types: application/json

DELETE /stages/{id}

Remove a fase de negócio

id

(no description)

type
integer (int64)
in
path
204 No Content

successful operation

404 Not Found

not found

PUT /stages/{id}

Atualização de fase de negócio

name: Nome

priority: Prioridade (determina a ordem das fases)

pipeline: Funil (/pipelines)

id

(no description)

type
integer (int64)
in
path
Request Content-Types: application/json
Request Example
{
  "name": "string",
  "priority": "integer (int32)",
  "pipeline": {
    "id": "integer (int64)"
  }
}
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /stages/{id}

Exibe os detalhes da fase de negócio

id

(no description)

type
integer (int64)
in
path
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

Response Content-Types: application/json

Step

POST /steps

Criação de nova etapa de projeto

name: Nome

priority: Prioridade (determina a ordem das etapas)

board: Painel (/boards)

Request Content-Types: application/json
Request Example
{
  "name": "string",
  "priority": "integer (int32)",
  "board": {
    "id": "integer (int64)"
  }
}
200 OK

successful operation

403 Forbidden

unauthorized

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /steps

Exibe a listagem de todas as etapas de projeto

start

Deslocamento (offset) de registros para paginação

type
integer (int64)
in
query
limit

Número de registros da página (no máximo 100)

type
integer (int64)
in
query
sort

Nome do campo para ordernar a busca

type
string
in
query
order

Tipo de ordenação feita no campo, ascendente (asc) ou descendente (desc)

type
string asc, desc
in
query
200 OK

successful operation

403 Forbidden

unauthorized

Response Content-Types: application/json

DELETE /steps/{id}

Remove a etapa de projeto

id

(no description)

type
integer (int64)
in
path
204 No Content

successful operation

404 Not Found

not found

PUT /steps/{id}

Atualização de etapa de projeto

name: Nome

priority: Prioridade (determina a ordem das etapas)

board: Painel (/boards)

id

(no description)

type
integer (int64)
in
path
Request Content-Types: application/json
Request Example
{
  "name": "string",
  "priority": "integer (int32)",
  "board": {
    "id": "integer (int64)"
  }
}
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /steps/{id}

Exibe os detalhes da etapa de projeto

id

(no description)

type
integer (int64)
in
path
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

Response Content-Types: application/json

Team

POST /teams

Criação de uma nova equipe

name: Nome

parent: Equipe pai (/teams)

Request Content-Types: application/json
Request Example
{
  "name": "string",
  "parent": {
    "id": "integer (int64)"
  }
}
200 OK

successful operation

403 Forbidden

unauthorized

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /teams

Exibe a listagem de todas as equipes

start

Deslocamento (offset) de registros para paginação

type
integer (int64)
in
query
limit

Número de registros da página (no máximo 100)

type
integer (int64)
in
query
sort

Nome do campo para ordernar a busca

type
string
in
query
order

Tipo de ordenação feita no campo, ascendente (asc) ou descendente (desc)

type
string asc, desc
in
query
200 OK

successful operation

403 Forbidden

unauthorized

Response Content-Types: application/json

DELETE /teams/{id}

id

(no description)

type
integer (int64)
in
path
204 No Content

successful operation

404 Not Found

not found

PUT /teams/{id}

Atualização da equipe

name: Nome

parent: Equipe pai (/teams)

id

(no description)

type
integer (int64)
in
path
Request Content-Types: application/json
Request Example
{
  "name": "string",
  "parent": {
    "id": "integer (int64)"
  }
}
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /teams/{id}

Exibe os detalhes da equipe

id

(no description)

type
integer (int64)
in
path
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

Response Content-Types: application/json

User

POST /users

Criação de novo usuário

name: Nome

username: Email de acesso

birth: Data de nascimento

timezone: Fuso horário do usuário

team: Equipe (/teams)

jobTitle: Cargo do usuário

levelView: Permissão de visualização

levelEdit: Permissão de edição

levelDelete: Permissão de deleção

levelExport: Permissão de exportação

levelConfig: Permissão de configuração

levelBulk: Permissão de ações em massa

phones: Telefones do usuário

defaultPipeline: Funil padrão do usuário

defaultBoard: Board padrão do usuário

defaultDashboard: Dashboard padrão do usuário

Request Content-Types: application/json
Request Example
{
  "name": "string",
  "username": "string",
  "birth": "integer (int64)",
  "timezone": {
    "id": "integer (int64)"
  },
  "team": {
    "id": "integer (int64)"
  },
  "jobTitle": "string",
  "levelView": "boolean",
  "levelEdit": "boolean",
  "levelDelete": "boolean",
  "levelExport": "boolean",
  "levelConfig": "boolean",
  "levelBulk": "boolean",
  "phones": [
    {
      "id": "integer (int64)",
      "number": "string",
      "type": {
        "id": "integer (int64)"
      }
    }
  ],
  "defaultPipeline": "integer (int64)",
  "defaultBoard": "integer (int64)",
  "defaultDashboard": "integer (int64)"
}
200 OK

successful operation

403 Forbidden

unauthorized

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /users

Exibe a listagem de todos os usuários

start

Deslocamento (offset) de registros para paginação

type
integer (int64)
in
query
limit

Número de registros da página (no máximo 100)

type
integer (int64)
in
query
sort

Nome do campo para ordernar a busca

type
string
in
query
order

Tipo de ordenação feita no campo, ascendente (asc) ou descendente (desc)

type
string asc, desc
in
query
200 OK

successful operation

403 Forbidden

unauthorized

Response Content-Types: application/json

PUT /users/{id}

Atualização do usuário

name: Nome

username: Email de acesso

birth: Data de nascimento

timezone: Fuso horário do usuário

team: Equipe (/teams)

jobTitle: Cargo do usuário

levelView: Permissão de visualização

levelEdit: Permissão de edição

levelDelete: Permissão de deleção

levelExport: Permissão de exportação

levelConfig: Permissão de configuração

levelBulk: Permissão de ações em massa

phones: Telefones do usuário

defaultPipeline: Funil padrão do usuário

defaultBoard: Board padrão do usuário

defaultDashboard: Dashboard padrão do usuário

id

(no description)

type
integer (int64)
in
path
Request Content-Types: application/json
Request Example
{
  "name": "string",
  "username": "string",
  "birth": "integer (int64)",
  "timezone": {
    "id": "integer (int64)"
  },
  "team": {
    "id": "integer (int64)"
  },
  "jobTitle": "string",
  "levelView": "boolean",
  "levelEdit": "boolean",
  "levelDelete": "boolean",
  "levelExport": "boolean",
  "levelConfig": "boolean",
  "levelBulk": "boolean",
  "phones": [
    {
      "id": "integer (int64)",
      "number": "string",
      "type": {
        "id": "integer (int64)"
      }
    }
  ],
  "defaultPipeline": "integer (int64)",
  "defaultBoard": "integer (int64)",
  "defaultDashboard": "integer (int64)"
}
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

422 Unprocessable Entity

unprocessable entity

Response Content-Types: application/json

GET /users/{id}

Exibe os detalhes do usuário

id

(no description)

type
integer (int64)
in
path
200 OK

successful operation

403 Forbidden

unauthorized

404 Not Found

not found

Response Content-Types: application/json

Schema Definitions

Id: object

id: integer (int64)
Example
{
  "id": "integer (int64)"
}

CustomFieldValue: object

value: string
customField: Id
Example
{
  "value": "string",
  "customField": {
    "id": "integer (int64)"
  }
}

Project: object

dateCreated: integer (int64)
name: string
archived: boolean
previsionCloseDate: integer (int64)
createdBy: Id
responsible: Id
step: Id
contacts: Id
companies: Id
deals: Id
customFieldValues: CustomFieldValue
Example
{
  "dateCreated": "integer (int64)",
  "name": "string",
  "archived": "boolean",
  "previsionCloseDate": "integer (int64)",
  "createdBy": {
    "id": "integer (int64)"
  },
  "responsible": {
    "id": "integer (int64)"
  },
  "step": {
    "id": "integer (int64)"
  },
  "contacts": [
    {
      "id": "integer (int64)"
    }
  ],
  "companies": [
    {
      "id": "integer (int64)"
    }
  ],
  "deals": [
    {
      "id": "integer (int64)"
    }
  ],
  "customFieldValues": [
    {
      "value": "string",
      "customField": {
        "id": "integer (int64)"
      }
    }
  ]
}

Pipeline: object

name: string
Example
{
  "name": "string"
}

ActivityType: object

name: string
Example
{
  "name": "string"
}

LostReason: object

name: string
pipelines: Id
Example
{
  "name": "string",
  "pipelines": [
    {
      "id": "integer (int64)"
    }
  ]
}

PhoneType: object

name: string
Example
{
  "name": "string"
}

Board: object

name: string
Example
{
  "name": "string"
}

Product: object

name: string
sku: string
description: string
price: integer (int64)
active: boolean
createdBy: Id
Example
{
  "name": "string",
  "sku": "string",
  "description": "string",
  "price": "integer (int64)",
  "active": "boolean",
  "createdBy": {
    "id": "integer (int64)"
  }
}

Stage: object

name: string
priority: integer (int32)
pipeline: Id
Example
{
  "name": "string",
  "priority": "integer (int32)",
  "pipeline": {
    "id": "integer (int64)"
  }
}

Phone: object

id: integer (int64)
number: string
type: Id
Example
{
  "id": "integer (int64)",
  "number": "string",
  "type": {
    "id": "integer (int64)"
  }
}

User: object

name: string
username: string
birth: integer (int64)
timezone: Id
team: Id
jobTitle: string
levelView: boolean
levelEdit: boolean
levelDelete: boolean
levelExport: boolean
levelConfig: boolean
levelBulk: boolean
phones: Phone
defaultPipeline: integer (int64)
defaultBoard: integer (int64)
defaultDashboard: integer (int64)
Example
{
  "name": "string",
  "username": "string",
  "birth": "integer (int64)",
  "timezone": {
    "id": "integer (int64)"
  },
  "team": {
    "id": "integer (int64)"
  },
  "jobTitle": "string",
  "levelView": "boolean",
  "levelEdit": "boolean",
  "levelDelete": "boolean",
  "levelExport": "boolean",
  "levelConfig": "boolean",
  "levelBulk": "boolean",
  "phones": [
    {
      "id": "integer (int64)",
      "number": "string",
      "type": {
        "id": "integer (int64)"
      }
    }
  ],
  "defaultPipeline": "integer (int64)",
  "defaultBoard": "integer (int64)",
  "defaultDashboard": "integer (int64)"
}

Activity: object

dateCreated: integer (int64)
doneDate: integer (int64)
dueDate: integer (int64)
duration: integer (int32)
totalDays: integer (int32)
notes: string
title: string
createdBy: Id
responsible: Id
type: Id
contacts: Id
companies: Id
deals: Id
projects: Id
customFieldValues: CustomFieldValue
Example
{
  "dateCreated": "integer (int64)",
  "doneDate": "integer (int64)",
  "dueDate": "integer (int64)",
  "duration": "integer (int32)",
  "totalDays": "integer (int32)",
  "notes": "string",
  "title": "string",
  "createdBy": {
    "id": "integer (int64)"
  },
  "responsible": {
    "id": "integer (int64)"
  },
  "type": {
    "id": "integer (int64)"
  },
  "contacts": [
    {
      "id": "integer (int64)"
    }
  ],
  "companies": [
    {
      "id": "integer (int64)"
    }
  ],
  "deals": [
    {
      "id": "integer (int64)"
    }
  ],
  "projects": [
    {
      "id": "integer (int64)"
    }
  ],
  "customFieldValues": [
    {
      "value": "string",
      "customField": {
        "id": "integer (int64)"
      }
    }
  ]
}

Attachment: object

url: string
contact: Id
company: Id
deal: Id
project: Id
Example
{
  "url": "string",
  "contact": {
    "id": "integer (int64)"
  },
  "company": {
    "id": "integer (int64)"
  },
  "deal": {
    "id": "integer (int64)"
  },
  "project": {
    "id": "integer (int64)"
  }
}

Note: object

description: string
dateCreated: integer (int64)
createdBy: Id
companies: Id
contacts: Id
deals: Id
Example
{
  "description": "string",
  "dateCreated": "integer (int64)",
  "createdBy": {
    "id": "integer (int64)"
  },
  "companies": [
    {
      "id": "integer (int64)"
    }
  ],
  "contacts": [
    {
      "id": "integer (int64)"
    }
  ],
  "deals": [
    {
      "id": "integer (int64)"
    }
  ]
}

Step: object

name: string
priority: integer (int32)
board: Id
Example
{
  "name": "string",
  "priority": "integer (int32)",
  "board": {
    "id": "integer (int64)"
  }
}

Won: object

closeDate: integer (int64)
Example
{
  "closeDate": "integer (int64)"
}

Lost: object

closeDate: integer (int64)
lostReason: Id
Example
{
  "closeDate": "integer (int64)",
  "lostReason": {
    "id": "integer (int64)"
  }
}

ProductDeal: object

id: integer (int64)
quantity: integer (int32)
price: integer (int64)
product: Id
Example
{
  "id": "integer (int64)",
  "quantity": "integer (int32)",
  "price": "integer (int64)",
  "product": {
    "id": "integer (int64)"
  }
}

Deal: object

dateCreated: integer (int64)
name: string
price: integer (int64)
previsionCloseDate: integer (int64)
createdBy: Id
responsible: Id
stage: Id
status: string OPEN, WON, LOST
contacts: Id
companies: Id
won: Won
lost: Lost
customFieldValues: CustomFieldValue
products: ProductDeal
Example
{
  "dateCreated": "integer (int64)",
  "name": "string",
  "price": "integer (int64)",
  "previsionCloseDate": "integer (int64)",
  "createdBy": {
    "id": "integer (int64)"
  },
  "responsible": {
    "id": "integer (int64)"
  },
  "stage": {
    "id": "integer (int64)"
  },
  "status": "string",
  "contacts": [
    {
      "id": "integer (int64)"
    }
  ],
  "companies": [
    {
      "id": "integer (int64)"
    }
  ],
  "won": {
    "closeDate": "integer (int64)"
  },
  "lost": {
    "closeDate": "integer (int64)",
    "lostReason": {
      "id": "integer (int64)"
    }
  },
  "customFieldValues": [
    {
      "value": "string",
      "customField": {
        "id": "integer (int64)"
      }
    }
  ],
  "products": [
    {
      "id": "integer (int64)",
      "quantity": "integer (int32)",
      "price": "integer (int64)",
      "product": {
        "id": "integer (int64)"
      }
    }
  ]
}

LinkContactToDeal: object

id: integer (int64)
Example
{
  "id": "integer (int64)"
}

CustomFieldOption: object

id: integer (int64)
label: string
Example
{
  "id": "integer (int64)",
  "label": "string"
}

CustomFieldCategory: object

name: string
Example
{
  "name": "string"
}

CustomField: object

name: string
type: string ADDRESS, DATE, DATE_TIME, MULTIPLE_OPTION, NUMBER, EMAIL, PHONE, SINGLE_OPTION, TEXT, MULTILINE, URL
options: CustomFieldOption
priority: integer (int32)
pipelines: Id
boards: Id
category: CustomFieldCategory
Example
{
  "name": "string",
  "type": "string",
  "options": [
    {
      "id": "integer (int64)",
      "label": "string"
    }
  ],
  "priority": "integer (int32)",
  "pipelines": [
    {
      "id": "integer (int64)"
    }
  ],
  "boards": [
    {
      "id": "integer (int64)"
    }
  ],
  "category": {
    "name": "string"
  }
}

Email: object

id: integer (int64)
address: string
type: Id
Example
{
  "id": "integer (int64)",
  "address": "string",
  "type": {
    "id": "integer (int64)"
  }
}

SocialProfile: object

id: integer (int64)
url: string
type: Id
Example
{
  "id": "integer (int64)",
  "url": "string",
  "type": {
    "id": "integer (int64)"
  }
}

Employment: object

id: integer (int64)
jobTitle: string
contact: Id
company: Id
Example
{
  "id": "integer (int64)",
  "jobTitle": "string",
  "contact": {
    "id": "integer (int64)"
  },
  "company": {
    "id": "integer (int64)"
  }
}

Company: object

name: string
domain: string
notes: string
picture: string
dateCreated: integer (int64)
createdBy: Id
responsible: Id
emails: Email
phones: Phone
socialProfiles: SocialProfile
employees: Employment
customFieldValues: CustomFieldValue
Example
{
  "name": "string",
  "domain": "string",
  "notes": "string",
  "picture": "string",
  "dateCreated": "integer (int64)",
  "createdBy": {
    "id": "integer (int64)"
  },
  "responsible": {
    "id": "integer (int64)"
  },
  "emails": [
    {
      "id": "integer (int64)",
      "address": "string",
      "type": {
        "id": "integer (int64)"
      }
    }
  ],
  "phones": [
    {
      "id": "integer (int64)",
      "number": "string",
      "type": {
        "id": "integer (int64)"
      }
    }
  ],
  "socialProfiles": [
    {
      "id": "integer (int64)",
      "url": "string",
      "type": {
        "id": "integer (int64)"
      }
    }
  ],
  "employees": [
    {
      "id": "integer (int64)",
      "jobTitle": "string",
      "contact": {
        "id": "integer (int64)"
      },
      "company": {
        "id": "integer (int64)"
      }
    }
  ],
  "customFieldValues": [
    {
      "value": "string",
      "customField": {
        "id": "integer (int64)"
      }
    }
  ]
}

Contact: object

name: string
notes: string
picture: string
dateCreated: integer (int64)
createdBy: Id
responsible: Id
emails: Email
phones: Phone
socialProfiles: SocialProfile
employers: Employment
customFieldValues: CustomFieldValue
Example
{
  "name": "string",
  "notes": "string",
  "picture": "string",
  "dateCreated": "integer (int64)",
  "createdBy": {
    "id": "integer (int64)"
  },
  "responsible": {
    "id": "integer (int64)"
  },
  "emails": [
    {
      "id": "integer (int64)",
      "address": "string",
      "type": {
        "id": "integer (int64)"
      }
    }
  ],
  "phones": [
    {
      "id": "integer (int64)",
      "number": "string",
      "type": {
        "id": "integer (int64)"
      }
    }
  ],
  "socialProfiles": [
    {
      "id": "integer (int64)",
      "url": "string",
      "type": {
        "id": "integer (int64)"
      }
    }
  ],
  "employers": [
    {
      "id": "integer (int64)",
      "jobTitle": "string",
      "contact": {
        "id": "integer (int64)"
      },
      "company": {
        "id": "integer (int64)"
      }
    }
  ],
  "customFieldValues": [
    {
      "value": "string",
      "customField": {
        "id": "integer (int64)"
      }
    }
  ]
}

Team: object

name: string
parent: Id
Example
{
  "name": "string",
  "parent": {
    "id": "integer (int64)"
  }
}