Sign in
Phonebook

List

Retrieve a paginated list of Phonebook records. Supports filtering, sorting, and search.

get/api/cp/phonebook

Query parameters

typestring

Filter by Type

categorystring

Filter by Category

Response

Successful response

idinteger

Id

company_idinteger

Company Id

usernamestring

Username

organizationstring

Organization

name_givenstring

Name Given

name_familystring

Name Family

typestring

Type

categorystring

Category

Example response

[
  {
    "id": 12345,
    "company_id": 1,
    "username": "john_doe",
    "organization": "example_organization",
    "name_given": "example_name_given",
    "name_family": "example_name_family",
    "type": "example_type",
    "category": "example_category"
  }
]

Changes

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