Help Center

Contacts

GET /contacts

This method returns a list of contacts available to the current user and grouped by organization.

GET https://api.pyrus.com/v4/contacts?include_inactive=true

Response body

{
  "organizations": [
    {
      "organization_id": 2181,
      "name": "My Organization",
      "persons": [
        {
          "id": 1731,
          "first_name": "Bob",
          "last_name": "Smith",
          "mobile_phone": "19991234567",
          "email": "Bob.Smith@gmail.com",
          "type": "user",
          "department_id": 13836,
          "department_name": "Marketing"
        },
        {
          "id": 1733,
          "first_name": "John",
          "last_name": "Snow",
          "email": "John.Snow@gmail.com",
          "type": "user"
        },
        {
          "id": 1725,
          "first_name": "Jane",
          "last_name": "Doe",
          "email": "Jane.Doe@gmail.com",
          "type": "user"
        }
      ],
      "roles": [
        {
          "id": 1743,
          "name": "SomeRole",
          "member_ids": [
            1725,
            1733
          ],
          "type": "role"
        }
      ],
      "department_catalog_id": 1234
    }
  ]
}

curl

curl -X GET \
  https://api.pyrus.com/v4/contacts?include_inactive=true \
  -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
  -H 'Content-Type: application/json'

Parameters

include_inactiveIncludes former and inactive employees in response to request.

Was this article helpful?