PUT api/v2/contactpersons/list

ListContactPerson

Request Information

URI Parameters

None.

Body Parameters

The query

ListContactPersonQuery
NameDescriptionTypeAdditional information
OrganizationId

universally unique identifier

Required

LastUpdateDateAfter

date

None.

IsDeleted

IsDeletedFilterKind

None.

Select

ListContactPersonQuerySelect

Required

Sort

Collection of ListContactPersonQuerySort

Required

Default value:

PageNumber

integer (32 bits)

Required

Default value: 1

PageSize

integer (32 bits)

Required

Default value: 100

Request Formats

application/json

Sample:
{
  "OrganizationId": "00000000-0000-0000-0000-000000000000",
  "LastUpdateDateAfter": "2025-04-16T15:42:31.506+00:00",
  "IsDeleted": "NotDeleted",
  "Select": {
    "FirstName": true,
    "MiddleName": true,
    "LastName": true,
    "Department": true,
    "JobTitleDescription": true,
    "Email": true,
    "MobilePhoneNumber": true,
    "LastUpdateDate": true,
    "IsDeleted": true
  },
  "Sort": [
    "FirstName",
    "FirstName"
  ],
  "PageNumber": 1,
  "PageSize": 1
}

Response Information

Resource Description

ListContactPersonQueryResult

ListContactPersonQueryResult
NameDescriptionTypeAdditional information
Persons

Collection of ListContactPersonQueryResultPerson

Required

Count

integer (32 bits)

Range: inclusive between 0 and 2147483647

Response Formats

application/json

Sample:
{
  "Persons": [
    {
      "ContactPersonId": "00000000-0000-0000-0000-000000000000",
      "FirstName": "sample string 1",
      "MiddleName": "sample string 2",
      "LastName": "sample string 3",
      "Department": "sample string 4",
      "JobTitleDescription": "sample string 5",
      "Email": "sample string 6",
      "MobilePhoneNumber": "sample string 7",
      "LastUpdateDate": "2025-04-16T15:42:31.506+00:00",
      "IsDeleted": true
    },
    {
      "ContactPersonId": "00000000-0000-0000-0000-000000000000",
      "FirstName": "sample string 1",
      "MiddleName": "sample string 2",
      "LastName": "sample string 3",
      "Department": "sample string 4",
      "JobTitleDescription": "sample string 5",
      "Email": "sample string 6",
      "MobilePhoneNumber": "sample string 7",
      "LastUpdateDate": "2025-04-16T15:42:31.506+00:00",
      "IsDeleted": true
    }
  ],
  "Count": 1
}