1. v3
  2. ContactFolders
  3. GET - 3/contactfolders

Definition

GET - 3/ContactFolders?top={top}&skip={skip}&select={select}&filter={filter}&orderby={orderby}

Retrieve all contacts folders which match the passed criteria

Required roles: Contacts (read)

Request information

top

Select only the first N contacts folders of the complete list. read more


Type string
Additional info
Optional, Default value is 25
skip

Skip the first N contacts folders of the list. read more


Type string
Additional info
Optional
select

Define the properties which you want in the result. If empty all properties are returned except the ones which don't contain data. read more


Type string
Additional info
Optional
filter

Select only the contacts folders that satisfy the predicate expression. read more


Type string
Additional info
Optional
orderby

Define the properties which are used to order the list of contacts folders. read more


Type string
Additional info
Optional

Response information

Payload containing a list of contact folders


Meta

The metadata such as paging parameters, status code, timestamp,... which are related to this request.


Type MetaData
Data

The actual data returned by the request.


Type Collection of ContactFolder
Links

HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic.


Type Hateoas

Sample: 
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2024-12-12T23:03:59.8332613Z",
    "IsFiltered": true
  },
  "Data": [
    {
      "Id": 1,
      "Description": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
      "FolderCount": 2,
      "GroupCount": 3,
      "ContactCount": 4,
      "Name": "Lorem Ipsum",
      "ParentFolderId": 1
    },
    {
      "Id": 1,
      "Description": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
      "FolderCount": 2,
      "GroupCount": 3,
      "ContactCount": 4,
      "Name": "Lorem Ipsum",
      "ParentFolderId": 1
    }
  ]
}
Sample: 
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data>
    <ContactFolder z:Id="i2">
      <Name>Lorem Ipsum</Name>
      <ParentFolderId>1</ParentFolderId>
      <ContactCount>4</ContactCount>
      <Description>Lorem Ipsum is simply dummy text of the printing and typesetting industry.</Description>
      <FolderCount>2</FolderCount>
      <GroupCount>3</GroupCount>
      <Id>1</Id>
    </ContactFolder>
    <ContactFolder z:Ref="i2" />
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2024-12-12T23:03:59.8332613+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>