POST v{version}/Contacts/GetAllContactsInList/{company_id}

Request Information

URI Parameters

Name	Description	Type	Additional information
company_id		integer	Required
version		string	None.

Body Parameters

ContactListPostModel

Name	Type	Additional information
ListId	integer	Required
Name	string	String length: inclusive between 3 and 100
OrderIndex	decimal number	None.
ColorId	integer	None.
SearchText	string	None.
Type	ContactListTypeEnum	None.
Title	string	None.
Address	string	None.
IsArchived	boolean	Required
CreatedByUserIds	Collection of integer	None.
OwnerIds	Collection of integer	None.
OrProjectIds	Collection of integer	None.
NotProjectIds	Collection of integer	None.
AllProjectIds	Collection of integer	None.
OrProjectIdsOnCompany	Collection of integer	None.
NotProjectIdsOnCompany	Collection of integer	None.
AllProjectIdsOnCompany	Collection of integer	None.
OrProjectIdsOnPerson	Collection of integer	None.
NotProjectIdsOnPerson	Collection of integer	None.
AllProjectIdsOnPerson	Collection of integer	None.
OrTagIds	Collection of integer	None.
NotTagIds	Collection of integer	None.
AllTagIds	Collection of integer	None.
OrTagIdsOnCompany	Collection of integer	None.
NotTagIdsOnCompany	Collection of integer	None.
AllTagIdsOnCompany	Collection of integer	None.
OrTagIdsOnPerson	Collection of integer	None.
NotTagIdsOnPerson	Collection of integer	None.
AllTagIdsOnPerson	Collection of integer	None.
CreationDate	TaskSearchDateModel	None.
CustomFields	Collection of ContactListCustomFieldPostModel	None.

Request Formats

application/json, text/json

Sample:

{
  "ListId": 1,
  "Name": "sample string 2",
  "OrderIndex": 3.0,
  "ColorId": 4,
  "SearchText": "sample string 5",
  "Type": 0,
  "Title": "sample string 6",
  "Address": "sample string 7",
  "IsArchived": true,
  "CreatedByUserIds": [
    1,
    2
  ],
  "OwnerIds": [
    1,
    2
  ],
  "OrProjectIds": [
    1,
    2
  ],
  "NotProjectIds": [
    1,
    2
  ],
  "AllProjectIds": [
    1,
    2
  ],
  "OrProjectIdsOnCompany": [
    1,
    2
  ],
  "NotProjectIdsOnCompany": [
    1,
    2
  ],
  "AllProjectIdsOnCompany": [
    1,
    2
  ],
  "OrProjectIdsOnPerson": [
    1,
    2
  ],
  "NotProjectIdsOnPerson": [
    1,
    2
  ],
  "AllProjectIdsOnPerson": [
    1,
    2
  ],
  "OrTagIds": [
    1,
    2
  ],
  "NotTagIds": [
    1,
    2
  ],
  "AllTagIds": [
    1,
    2
  ],
  "OrTagIdsOnCompany": [
    1,
    2
  ],
  "NotTagIdsOnCompany": [
    1,
    2
  ],
  "AllTagIdsOnCompany": [
    1,
    2
  ],
  "OrTagIdsOnPerson": [
    1,
    2
  ],
  "NotTagIdsOnPerson": [
    1,
    2
  ],
  "AllTagIdsOnPerson": [
    1,
    2
  ],
  "CreationDate": {
    "Type": "sample string 1",
    "DurationType": "sample string 2",
    "DurationValue": 1,
    "StartDate": "2024-11-20T16:30:32.19395+00:00",
    "EndDate": "2024-11-20T16:30:32.19395+00:00"
  },
  "CustomFields": [
    {
      "CustomFieldId": 1,
      "CustomFieldType": "sample string 2",
      "SearchType": "sample string 3",
      "TextValue": "sample string 4",
      "NumberValue": 1.0,
      "Enums": [
        1,
        2
      ],
      "DatetimeValue": "2024-11-20T16:30:32.19395+00:00"
    },
    {
      "CustomFieldId": 1,
      "CustomFieldType": "sample string 2",
      "SearchType": "sample string 3",
      "TextValue": "sample string 4",
      "NumberValue": 1.0,
      "Enums": [
        1,
        2
      ],
      "DatetimeValue": "2024-11-20T16:30:32.19395+00:00"
    }
  ]
}

application/xml, text/xml

Sample:

<ContactListPostModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartTask.Data.Models.CRM">
  <Address>sample string 7</Address>
  <AllProjectIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </AllProjectIds>
  <AllProjectIdsOnCompany xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </AllProjectIdsOnCompany>
  <AllProjectIdsOnPerson xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </AllProjectIdsOnPerson>
  <AllTagIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </AllTagIds>
  <AllTagIdsOnCompany xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </AllTagIdsOnCompany>
  <AllTagIdsOnPerson xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </AllTagIdsOnPerson>
  <ColorId>4</ColorId>
  <CreatedByUserIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </CreatedByUserIds>
  <CreationDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/SmartTask.Data.Models.task">
    <d2p1:DurationType>sample string 2</d2p1:DurationType>
    <d2p1:DurationValue>1</d2p1:DurationValue>
    <d2p1:EndDate>2024-11-20T16:30:32.19395+00:00</d2p1:EndDate>
    <d2p1:StartDate>2024-11-20T16:30:32.19395+00:00</d2p1:StartDate>
    <d2p1:Type>sample string 1</d2p1:Type>
  </CreationDate>
  <CustomFields>
    <ContactListCustomFieldPostModel>
      <CustomFieldId>1</CustomFieldId>
      <CustomFieldType>sample string 2</CustomFieldType>
      <DatetimeValue>2024-11-20T16:30:32.19395+00:00</DatetimeValue>
      <Enums xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
      </Enums>
      <NumberValue>1</NumberValue>
      <SearchType>sample string 3</SearchType>
      <TextValue>sample string 4</TextValue>
    </ContactListCustomFieldPostModel>
    <ContactListCustomFieldPostModel>
      <CustomFieldId>1</CustomFieldId>
      <CustomFieldType>sample string 2</CustomFieldType>
      <DatetimeValue>2024-11-20T16:30:32.19395+00:00</DatetimeValue>
      <Enums xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
      </Enums>
      <NumberValue>1</NumberValue>
      <SearchType>sample string 3</SearchType>
      <TextValue>sample string 4</TextValue>
    </ContactListCustomFieldPostModel>
  </CustomFields>
  <IsArchived>true</IsArchived>
  <ListId>1</ListId>
  <Name>sample string 2</Name>
  <NotProjectIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </NotProjectIds>
  <NotProjectIdsOnCompany xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </NotProjectIdsOnCompany>
  <NotProjectIdsOnPerson xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </NotProjectIdsOnPerson>
  <NotTagIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </NotTagIds>
  <NotTagIdsOnCompany xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </NotTagIdsOnCompany>
  <NotTagIdsOnPerson xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </NotTagIdsOnPerson>
  <OrProjectIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </OrProjectIds>
  <OrProjectIdsOnCompany xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </OrProjectIdsOnCompany>
  <OrProjectIdsOnPerson xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </OrProjectIdsOnPerson>
  <OrTagIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </OrTagIds>
  <OrTagIdsOnCompany xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </OrTagIdsOnCompany>
  <OrTagIdsOnPerson xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </OrTagIdsOnPerson>
  <OrderIndex>3</OrderIndex>
  <OwnerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </OwnerIds>
  <SearchText>sample string 5</SearchText>
  <Title>sample string 6</Title>
  <Type>Person</Type>
</ContactListPostModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.