GET api/RD?RDToken={RDToken}&page={page}&limit={limit}&order={order}&direction={direction}&email={email}&q={q}&phone={phone}&title={title}

Lista de Contato

Request Information

URI Parameters

NameDescriptionTypeAdditional information
RDToken

Token do RD.

 string

Required
page

Número atual da página.

 string

None.
limit

Limite de contatos que serão listados. Valor padrão é 20. Valor máximo é 200.

 string

None.
order

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

 string

None.
direction

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

 string

None.
email

Filtra os resultados pelo e-mail informado.

 string

None.
q

Nome do contato a ser buscado.

 string

None.
phone

Filtra os resultados pelo telefone informado.

 string

None.
title

Título do contato a ser buscado.

 string

None.

Body Parameters

None.

Response Information

Resource Description

Lista de contatos.

BaseResponseOfApiResponseGetResponse
NameDescriptionTypeAdditional information
Data

ApiResponseGetResponse

None.
Errors

BaseResponseError

None.

Response Formats

application/json, text/json

Sample: 
{
  "Data": {
    "total": 1,
    "has_more": true,
    "contacts": [
      {
        "id": "sample string 1",
        "_id": "sample string 2",
        "name": "sample string 3",
        "title": "sample string 4",
        "notes": "sample string 5",
        "emails": [
          {
            "_id": "sample string 1",
            "created_at": "sample string 2",
            "email": "sample string 3",
            "updated_at": "sample string 4"
          },
          {
            "_id": "sample string 1",
            "created_at": "sample string 2",
            "email": "sample string 3",
            "updated_at": "sample string 4"
          }
        ],
        "birthday": {
          "_id": "sample string 1",
          "created_at": "sample string 2",
          "day": 3,
          "month": 4,
          "updated_at": "sample string 5",
          "year": 6
        },
        "facebook": "sample string 6",
        "linkedin": "sample string 7",
        "skype": "sample string 8",
        "organization_id": "sample string 9",
        "contact_custom_fields": [
          {
            "custom_field_id": "sample string 1",
            "value": "sample string 2"
          },
          {
            "custom_field_id": "sample string 1",
            "value": "sample string 2"
          }
        ],
        "created_at": "sample string 10",
        "updated_at": "sample string 11",
        "phones": [
          {
            "phone": "sample string 1",
            "type": "sample string 2"
          },
          {
            "phone": "sample string 1",
            "type": "sample string 2"
          }
        ],
        "legal_bases": [
          {
            "category": "sample string 1",
            "status": "sample string 2",
            "type": "sample string 3"
          },
          {
            "category": "sample string 1",
            "status": "sample string 2",
            "type": "sample string 3"
          }
        ],
        "deals": [
          {
            "_id": "sample string 1",
            "closed_at": "sample string 2",
            "deal_lost_reason_id": "sample string 3",
            "id": "sample string 4",
            "name": "sample string 5",
            "prediction_date": "sample string 6",
            "win": "sample string 7"
          },
          {
            "_id": "sample string 1",
            "closed_at": "sample string 2",
            "deal_lost_reason_id": "sample string 3",
            "id": "sample string 4",
            "name": "sample string 5",
            "prediction_date": "sample string 6",
            "win": "sample string 7"
          }
        ]
      },
      {
        "id": "sample string 1",
        "_id": "sample string 2",
        "name": "sample string 3",
        "title": "sample string 4",
        "notes": "sample string 5",
        "emails": [
          {
            "_id": "sample string 1",
            "created_at": "sample string 2",
            "email": "sample string 3",
            "updated_at": "sample string 4"
          },
          {
            "_id": "sample string 1",
            "created_at": "sample string 2",
            "email": "sample string 3",
            "updated_at": "sample string 4"
          }
        ],
        "birthday": {
          "_id": "sample string 1",
          "created_at": "sample string 2",
          "day": 3,
          "month": 4,
          "updated_at": "sample string 5",
          "year": 6
        },
        "facebook": "sample string 6",
        "linkedin": "sample string 7",
        "skype": "sample string 8",
        "organization_id": "sample string 9",
        "contact_custom_fields": [
          {
            "custom_field_id": "sample string 1",
            "value": "sample string 2"
          },
          {
            "custom_field_id": "sample string 1",
            "value": "sample string 2"
          }
        ],
        "created_at": "sample string 10",
        "updated_at": "sample string 11",
        "phones": [
          {
            "phone": "sample string 1",
            "type": "sample string 2"
          },
          {
            "phone": "sample string 1",
            "type": "sample string 2"
          }
        ],
        "legal_bases": [
          {
            "category": "sample string 1",
            "status": "sample string 2",
            "type": "sample string 3"
          },
          {
            "category": "sample string 1",
            "status": "sample string 2",
            "type": "sample string 3"
          }
        ],
        "deals": [
          {
            "_id": "sample string 1",
            "closed_at": "sample string 2",
            "deal_lost_reason_id": "sample string 3",
            "id": "sample string 4",
            "name": "sample string 5",
            "prediction_date": "sample string 6",
            "win": "sample string 7"
          },
          {
            "_id": "sample string 1",
            "closed_at": "sample string 2",
            "deal_lost_reason_id": "sample string 3",
            "id": "sample string 4",
            "name": "sample string 5",
            "prediction_date": "sample string 6",
            "win": "sample string 7"
          }
        ]
      }
    ]
  },
  "Errors": {
    "errors": null,
    "contact_c_f": null
  }
}

application/xml, text/xml

Sample: 
<BaseResponseOfApiResponseGetResponse7IrgLMpr xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/webService2.Models.RD.BaseResponse">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/webService2.Models.RD">
    <d2p1:contacts>
      <d2p1:GetContactResponse>
        <d2p1:_id>sample string 2</d2p1:_id>
        <d2p1:birthday>
          <d2p1:_id>sample string 1</d2p1:_id>
          <d2p1:created_at>sample string 2</d2p1:created_at>
          <d2p1:day>3</d2p1:day>
          <d2p1:month>4</d2p1:month>
          <d2p1:updated_at>sample string 5</d2p1:updated_at>
          <d2p1:year>6</d2p1:year>
        </d2p1:birthday>
        <d2p1:contact_custom_fields>
          <d2p1:ContactCustomFieldGetResponse>
            <d2p1:custom_field_id>sample string 1</d2p1:custom_field_id>
            <d2p1:value>sample string 2</d2p1:value>
          </d2p1:ContactCustomFieldGetResponse>
          <d2p1:ContactCustomFieldGetResponse>
            <d2p1:custom_field_id>sample string 1</d2p1:custom_field_id>
            <d2p1:value>sample string 2</d2p1:value>
          </d2p1:ContactCustomFieldGetResponse>
        </d2p1:contact_custom_fields>
        <d2p1:created_at>sample string 10</d2p1:created_at>
        <d2p1:deals>
          <d2p1:DealGetResponse>
            <d2p1:_id>sample string 1</d2p1:_id>
            <d2p1:closed_at>sample string 2</d2p1:closed_at>
            <d2p1:deal_lost_reason_id>sample string 3</d2p1:deal_lost_reason_id>
            <d2p1:id>sample string 4</d2p1:id>
            <d2p1:name>sample string 5</d2p1:name>
            <d2p1:prediction_date>sample string 6</d2p1:prediction_date>
            <d2p1:win>sample string 7</d2p1:win>
          </d2p1:DealGetResponse>
          <d2p1:DealGetResponse>
            <d2p1:_id>sample string 1</d2p1:_id>
            <d2p1:closed_at>sample string 2</d2p1:closed_at>
            <d2p1:deal_lost_reason_id>sample string 3</d2p1:deal_lost_reason_id>
            <d2p1:id>sample string 4</d2p1:id>
            <d2p1:name>sample string 5</d2p1:name>
            <d2p1:prediction_date>sample string 6</d2p1:prediction_date>
            <d2p1:win>sample string 7</d2p1:win>
          </d2p1:DealGetResponse>
        </d2p1:deals>
        <d2p1:emails>
          <d2p1:EmailGetResponse>
            <d2p1:_id>sample string 1</d2p1:_id>
            <d2p1:created_at>sample string 2</d2p1:created_at>
            <d2p1:email>sample string 3</d2p1:email>
            <d2p1:updated_at>sample string 4</d2p1:updated_at>
          </d2p1:EmailGetResponse>
          <d2p1:EmailGetResponse>
            <d2p1:_id>sample string 1</d2p1:_id>
            <d2p1:created_at>sample string 2</d2p1:created_at>
            <d2p1:email>sample string 3</d2p1:email>
            <d2p1:updated_at>sample string 4</d2p1:updated_at>
          </d2p1:EmailGetResponse>
        </d2p1:emails>
        <d2p1:facebook>sample string 6</d2p1:facebook>
        <d2p1:id>sample string 1</d2p1:id>
        <d2p1:legal_bases>
          <d2p1:LegalBaseGetResponse>
            <d2p1:category>sample string 1</d2p1:category>
            <d2p1:status>sample string 2</d2p1:status>
            <d2p1:type>sample string 3</d2p1:type>
          </d2p1:LegalBaseGetResponse>
          <d2p1:LegalBaseGetResponse>
            <d2p1:category>sample string 1</d2p1:category>
            <d2p1:status>sample string 2</d2p1:status>
            <d2p1:type>sample string 3</d2p1:type>
          </d2p1:LegalBaseGetResponse>
        </d2p1:legal_bases>
        <d2p1:linkedin>sample string 7</d2p1:linkedin>
        <d2p1:name>sample string 3</d2p1:name>
        <d2p1:notes>sample string 5</d2p1:notes>
        <d2p1:organization_id>sample string 9</d2p1:organization_id>
        <d2p1:phones>
          <d2p1:Phone>
            <d2p1:phone>sample string 1</d2p1:phone>
            <d2p1:type>sample string 2</d2p1:type>
          </d2p1:Phone>
          <d2p1:Phone>
            <d2p1:phone>sample string 1</d2p1:phone>
            <d2p1:type>sample string 2</d2p1:type>
          </d2p1:Phone>
        </d2p1:phones>
        <d2p1:skype>sample string 8</d2p1:skype>
        <d2p1:title>sample string 4</d2p1:title>
        <d2p1:updated_at>sample string 11</d2p1:updated_at>
      </d2p1:GetContactResponse>
      <d2p1:GetContactResponse>
        <d2p1:_id>sample string 2</d2p1:_id>
        <d2p1:birthday>
          <d2p1:_id>sample string 1</d2p1:_id>
          <d2p1:created_at>sample string 2</d2p1:created_at>
          <d2p1:day>3</d2p1:day>
          <d2p1:month>4</d2p1:month>
          <d2p1:updated_at>sample string 5</d2p1:updated_at>
          <d2p1:year>6</d2p1:year>
        </d2p1:birthday>
        <d2p1:contact_custom_fields>
          <d2p1:ContactCustomFieldGetResponse>
            <d2p1:custom_field_id>sample string 1</d2p1:custom_field_id>
            <d2p1:value>sample string 2</d2p1:value>
          </d2p1:ContactCustomFieldGetResponse>
          <d2p1:ContactCustomFieldGetResponse>
            <d2p1:custom_field_id>sample string 1</d2p1:custom_field_id>
            <d2p1:value>sample string 2</d2p1:value>
          </d2p1:ContactCustomFieldGetResponse>
        </d2p1:contact_custom_fields>
        <d2p1:created_at>sample string 10</d2p1:created_at>
        <d2p1:deals>
          <d2p1:DealGetResponse>
            <d2p1:_id>sample string 1</d2p1:_id>
            <d2p1:closed_at>sample string 2</d2p1:closed_at>
            <d2p1:deal_lost_reason_id>sample string 3</d2p1:deal_lost_reason_id>
            <d2p1:id>sample string 4</d2p1:id>
            <d2p1:name>sample string 5</d2p1:name>
            <d2p1:prediction_date>sample string 6</d2p1:prediction_date>
            <d2p1:win>sample string 7</d2p1:win>
          </d2p1:DealGetResponse>
          <d2p1:DealGetResponse>
            <d2p1:_id>sample string 1</d2p1:_id>
            <d2p1:closed_at>sample string 2</d2p1:closed_at>
            <d2p1:deal_lost_reason_id>sample string 3</d2p1:deal_lost_reason_id>
            <d2p1:id>sample string 4</d2p1:id>
            <d2p1:name>sample string 5</d2p1:name>
            <d2p1:prediction_date>sample string 6</d2p1:prediction_date>
            <d2p1:win>sample string 7</d2p1:win>
          </d2p1:DealGetResponse>
        </d2p1:deals>
        <d2p1:emails>
          <d2p1:EmailGetResponse>
            <d2p1:_id>sample string 1</d2p1:_id>
            <d2p1:created_at>sample string 2</d2p1:created_at>
            <d2p1:email>sample string 3</d2p1:email>
            <d2p1:updated_at>sample string 4</d2p1:updated_at>
          </d2p1:EmailGetResponse>
          <d2p1:EmailGetResponse>
            <d2p1:_id>sample string 1</d2p1:_id>
            <d2p1:created_at>sample string 2</d2p1:created_at>
            <d2p1:email>sample string 3</d2p1:email>
            <d2p1:updated_at>sample string 4</d2p1:updated_at>
          </d2p1:EmailGetResponse>
        </d2p1:emails>
        <d2p1:facebook>sample string 6</d2p1:facebook>
        <d2p1:id>sample string 1</d2p1:id>
        <d2p1:legal_bases>
          <d2p1:LegalBaseGetResponse>
            <d2p1:category>sample string 1</d2p1:category>
            <d2p1:status>sample string 2</d2p1:status>
            <d2p1:type>sample string 3</d2p1:type>
          </d2p1:LegalBaseGetResponse>
          <d2p1:LegalBaseGetResponse>
            <d2p1:category>sample string 1</d2p1:category>
            <d2p1:status>sample string 2</d2p1:status>
            <d2p1:type>sample string 3</d2p1:type>
          </d2p1:LegalBaseGetResponse>
        </d2p1:legal_bases>
        <d2p1:linkedin>sample string 7</d2p1:linkedin>
        <d2p1:name>sample string 3</d2p1:name>
        <d2p1:notes>sample string 5</d2p1:notes>
        <d2p1:organization_id>sample string 9</d2p1:organization_id>
        <d2p1:phones>
          <d2p1:Phone>
            <d2p1:phone>sample string 1</d2p1:phone>
            <d2p1:type>sample string 2</d2p1:type>
          </d2p1:Phone>
          <d2p1:Phone>
            <d2p1:phone>sample string 1</d2p1:phone>
            <d2p1:type>sample string 2</d2p1:type>
          </d2p1:Phone>
        </d2p1:phones>
        <d2p1:skype>sample string 8</d2p1:skype>
        <d2p1:title>sample string 4</d2p1:title>
        <d2p1:updated_at>sample string 11</d2p1:updated_at>
      </d2p1:GetContactResponse>
    </d2p1:contacts>
    <d2p1:has_more>true</d2p1:has_more>
    <d2p1:total>1</d2p1:total>
  </Data>
  <Errors xmlns:d2p1="http://schemas.datacontract.org/2004/07/webService2.Models.RD">
    <d2p1:contact_c_f xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <d2p1:errors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  </Errors>
</BaseResponseOfApiResponseGetResponse7IrgLMpr>