Definition

GET - 3/ContactFolders/{Id}

Retrieve a contact folder by id.

Required roles: Contacts (read)

Request information

NameDescriptionTypeAdditional information
Id

The id of the contacts folder which you would like to retrieve.

integer

Required

Response information

Payload containing the requested contact folder.


NameDescriptionTypeAdditional information
Meta

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

MetaData

Data

The actual data returned by the request.

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.

Hateoas

Sample:
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2019-01-17T16:14:08.5535703Z",
    "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
  }
}
Sample:
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data 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>
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2019-01-17T16:14:08.5535703+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>