Get Contact list for a Department

This operation retrieves all the contacts of the specified department

SecuritybearerAuth
Request
path Parameters
departmentId
required
string

Identifier of the department whose contact list needs to be retrieved.

query Parameters
skip
integer

The number of records to skip for pagination. Default is 0.

Example: skip=0
limit
integer

The maximum number of records to return. Default is 20.

Example: limit=20
sendKeyContacts
boolean

If true, retrieves only key contacts associated with departments

Example: sendKeyContacts=false
removePrivate
boolean

If true, removes private contacts from the response

Example: removePrivate=false
Responses
200

The Contact list has been retrived successfully.

400

Invalid request.

401

The request could not be authorized.

404

The requested resource was not found.

500

The request could not be completed due to an internal error.

get/api/v1/departments/{departmentId}/contacts
Request samples
Response samples
application/json
{
  • "pageInfo": {
    },
  • "contacts": [
    ]
}