GET api/Group?pageNumber={pageNumber}&pageSize={pageSize}

Retrieves the groups associated with your provider account.

Request Information

Parameters

NameDescriptionAdditional information
pageNumber
The page number to get

Define this parameter in the request URI.

pageSize
The page size to get

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "is_last": true,
  "groups": [
    {
      "agent_ids": [
        1,
        2,
        3
      ],
      "date_created": "2019-08-19T08:19:07.8234032-04:00",
      "description": "sample string 1",
      "name": "sample string 2",
      "is_default": true,
      "provider_id": 4,
      "escalate_in_minutes": 5,
      "is_by_business_hours": true,
      "round_robin_enabled": true,
      "agent_ids_to_escalate_to": [
        1,
        2,
        3
      ],
      "id": 1
    },
    {
      "agent_ids": [
        1,
        2,
        3
      ],
      "date_created": "2019-08-19T08:19:07.8234032-04:00",
      "description": "sample string 1",
      "name": "sample string 2",
      "is_default": true,
      "provider_id": 4,
      "escalate_in_minutes": 5,
      "is_by_business_hours": true,
      "round_robin_enabled": true,
      "agent_ids_to_escalate_to": [
        1,
        2,
        3
      ],
      "id": 1
    },
    {
      "agent_ids": [
        1,
        2,
        3
      ],
      "date_created": "2019-08-19T08:19:07.8234032-04:00",
      "description": "sample string 1",
      "name": "sample string 2",
      "is_default": true,
      "provider_id": 4,
      "escalate_in_minutes": 5,
      "is_by_business_hours": true,
      "round_robin_enabled": true,
      "agent_ids_to_escalate_to": [
        1,
        2,
        3
      ],
      "id": 1
    }
  ]
}

application/xml, text/xml

Sample:
<groups_page xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ticket.Api.Org">
  <groups>
    <group>
      <id xmlns="http://schemas.datacontract.org/2004/07/Ticket.Api">1</id>
      <agent_ids xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
        <d4p1:long>3</d4p1:long>
      </agent_ids>
      <agent_ids_to_escalate_to xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
        <d4p1:long>3</d4p1:long>
      </agent_ids_to_escalate_to>
      <date_created>2019-08-19T08:19:07.8234032-04:00</date_created>
      <description>sample string 1</description>
      <escalate_in_minutes>5</escalate_in_minutes>
      <is_by_business_hours>true</is_by_business_hours>
      <is_default>true</is_default>
      <name>sample string 2</name>
      <provider_id>4</provider_id>
      <round_robin_enabled>true</round_robin_enabled>
    </group>
    <group>
      <id xmlns="http://schemas.datacontract.org/2004/07/Ticket.Api">1</id>
      <agent_ids xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
        <d4p1:long>3</d4p1:long>
      </agent_ids>
      <agent_ids_to_escalate_to xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
        <d4p1:long>3</d4p1:long>
      </agent_ids_to_escalate_to>
      <date_created>2019-08-19T08:19:07.8234032-04:00</date_created>
      <description>sample string 1</description>
      <escalate_in_minutes>5</escalate_in_minutes>
      <is_by_business_hours>true</is_by_business_hours>
      <is_default>true</is_default>
      <name>sample string 2</name>
      <provider_id>4</provider_id>
      <round_robin_enabled>true</round_robin_enabled>
    </group>
    <group>
      <id xmlns="http://schemas.datacontract.org/2004/07/Ticket.Api">1</id>
      <agent_ids xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
        <d4p1:long>3</d4p1:long>
      </agent_ids>
      <agent_ids_to_escalate_to xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
        <d4p1:long>3</d4p1:long>
      </agent_ids_to_escalate_to>
      <date_created>2019-08-19T08:19:07.8234032-04:00</date_created>
      <description>sample string 1</description>
      <escalate_in_minutes>5</escalate_in_minutes>
      <is_by_business_hours>true</is_by_business_hours>
      <is_default>true</is_default>
      <name>sample string 2</name>
      <provider_id>4</provider_id>
      <round_robin_enabled>true</round_robin_enabled>
    </group>
  </groups>
  <is_last>true</is_last>
</groups_page>