Listar empresas

get/organizations

Request

Base URL
https://crm.rdstation.com/api/v1
URL
https://crm.rdstation.com/api/v1/organizations
Auth
API key in query parameter token

Query parameters

pagestring

Número atual da página

limitstring

Limite de empresas que virão por listagem. Valor padrão é 20. Valor máximo é 200

orderstring

Campo a ser ordenado. Valor padrão é "name"

directionstring

Ordenação da lista. "asc" ou "desc", padrão é "asc"

organization_segmentstring

ID do segmento. Busca todas as empresas que têm esse segmento

user_idstring

ID do usuário. Busca as empresas do usuário anterior no parâmetro

qstring

String com o nome da empresa. Busca as empresas com a string anterior no parâmetro

Response

Success

has_moreboolean

totalnumber

Example response

{
  "organizations": [
    {
      "_id": "ID",
      "contacts": [
        {
          "emails": [
            {
              "email": "EMAIL"
            }
          ],
          "facebook": "facebook name of the contact",
          "linkedin": "linkedin user name of the contact",
          "name": "NAME",
          "phones": [
            {
              "phone": "phone of the contact"
            }
          ],
          "title": "job title value"
        }
      ],
      "created_at": "2022-04-26T16:40:47.449-03:00",
      "id": "ID",
      "name": "NAME",
      "opened_count": 1,
      "updated_at": "2022-04-26T16:40:47.449-03:00",
      "url": "website of the contact",
      "user": {
        "_id": "ID",
        "email": "EMAIL",
        "id": "ID",
        "name": "NAME",
        "nickname": "RP"
      }
    }
  ],
  "total": 2
}

Changes

No recorded changes to this operation across all 1 revision of this API.