EAeasybroker
Contacts

List all contacts

Changed on

Returns a list of contacts from your organization.

get/contacts

Request

  • Base URL
    https://api.easybroker.com/v1
  • URL
    https://api.easybroker.com/v1/contacts
  • Auth
    API key in header X-Authorization

Query parameters

pageinteger

Content's page

limitinteger

Max results per page (Maximum: 50)

updated_afterstring date-time

Retrieve contacts updated after the given time.

updated_beforestring date-time

Retrieve contacts updated before the given time.

created_afterstring date-time

Retrieve contacts created after the given time.

created_beforestring date-time

Retrieve contacts created before the given time.

last_activity_afterstring date-time

Retrieve contacts whose last activity was after the given time.

last_activity_beforestring date-time

Retrieve contacts whose last activity was before the given time. Contacts without activity are excluded.

{
  "updated_after": "2020-03-01T23:26:53.402Z",
  "updated_before": "2025-03-01T23:26:53.402Z",
  "created_after": "2020-03-01T23:26:53.402Z",
  "created_before": "2025-03-01T23:26:53.402Z",
  "last_activity_after": "2020-03-01T23:26:53.402Z",
  "last_activity_before": "2025-03-01T23:26:53.402Z"
}
search[statuses][]string[]

This parameter allows you to filter contacts with the selected statuses. You must provide one of your account's status names exactly as they are shown on EasyBroker.

search[probabilities][]string[]

This parameter allows you to filter contacts with the selected probabilities

search[tag]string

This parameter allows you to filter listings from one specific tag.

search[email]string

This parameter allows you to filter contacts based on the assigned agent's email.

search[offices][]string[]

This parameter allows you to filter contacts by office names.

[
  "Sucursal B"
]
search[sources][]string[]

Retrieve contact listing from multiple sources.

[
  "mywebsite.com"
]

Response

Successful contact list request

Example response

{
  "pagination": {
    "limit": 20,
    "page": 1,
    "total": 1
  },
  "content": [
    {
      "id": 123,
      "full_name": "John Smith",
      "phone": "5559090909",
      "email": "mail@example.com",
      "agent": "Jane Johnson",
      "source": "mydomain.com",
      "status": "Contacted",
      "last_activity_at": "2020-03-01T23:26:53.402Z",
      "created_at": "2020-03-01T23:26:53.402Z",
      "updated_at": "2020-03-01T23:26:53.402Z"
    }
  ]
}

Changes

  • c4cce9eaa862Revision changes
    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status