Sign in
directory

Get Directory Member History

Get version history for a directory member (contact). Version 1 is always the oldest; order_by_direction only controls response order.

get/api/v1/directory_members/{member_id}/history

Path parameters

member_idinteger required

Query parameters

pageinteger

Page number (0-based)

Page number (0-based)

limitinteger

Items per page

Items per page

order_by_direction'asc' | 'desc'

The direction in which to order list results, either ascending or descending.

Sort by oldest first (asc) or newest first (desc). Version 1 is always the oldest.

response_format'normalized' | 'raw'

Response shape selector for directory member APIs.

Directory response format: normalized (default) strips @hours and formats times; raw returns stored @hours values.

Response

Successful Response

pageinteger required

The page number of the results (0-based)

page_sizeinteger required

The number of items returned per page

total_pagesinteger nullable

The total number of pages of results given the indicated page size

total_countinteger nullable

The total number of items returned from the query

Example response

{
  "items": [
    {
      "directory_member_id": 1,
      "version": 1,
      "timestamp": "2024-01-01T12:00:00Z",
      "name": "Jane Doe",
      "type": "Department",
      "extensions": [],
      "contact_tags": {
        "tag1": [
          "value1"
        ],
        "tag2": [
          "value2"
        ]
      },
      "user_email": "user@email.com",
      "comments": "Updated phone number",
      "operation": "update"
    }
  ],
  "page_size": 25,
  "total_pages": 4,
  "total_count": 100
}

Changes

Changed in 1 of the 99 revisions of this API.1

  • 9fc02f8705a71See the full diff
    • ○

      added the optional property items/items/extensions/items/numbers/anyOf[subschema #1]/items/sip_transfer_mode to the response with the 200 status

      response-optional-property-added

Of the 99 revisions, 1 has no diff computed.