Jump to

• Request
• Response

Get Contact Groups

get

/contactGroups

Request

Query Parameters

• expand: string
  Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
• fields: string
  Comma-delimited string of field names that you wanted returned in a GET request.
• limit: integer(int32)
  Positive integer value that specifies the maximum number of items returned by the server.
• offset: integer(int32)
  Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
• orderBy: string
  Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
• q: string
  Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
• totalResults: boolean
  Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=collection

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• items(required): array items
• links: array links

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/contactGroups"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object contactGroups

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/contactGroups"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    }
}

Nested Schema : contactGroups

Type: object

Show Source

• alternateName: string
  No description.
• attribute1: string
  No description.
• attribute10: string
  No description.
• attribute11: string
  No description.
• attribute12: string
  No description.
• attribute13: string
  No description.
• attribute14: string
  No description.
• attribute15: string
  No description.
• attribute16: string
  No description.
• attribute17: string
  No description.
• attribute18: string
  No description.
• attribute19: string
  No description.
• attribute2: string
  No description.
• attribute20: string
  No description.
• attribute3: string
  No description.
• attribute4: string
  No description.
• attribute5: string
  No description.
• attribute6: string
  No description.
• attribute7: string
  No description.
• attribute8: string
  No description.
• attribute9: string
  No description.
• attributeDate1: attributeDate1
  No description.
• attributeDate10: attributeDate10
  No description.
• attributeDate11: attributeDate11
  No description.
• attributeDate12: attributeDate12
  No description.
• attributeDate13: attributeDate13
  No description.
• attributeDate14: attributeDate14
  No description.
• attributeDate15: attributeDate15
  No description.
• attributeDate16: attributeDate16
  No description.
• attributeDate17: attributeDate17
  No description.
• attributeDate18: attributeDate18
  No description.
• attributeDate19: attributeDate19
  No description.
• attributeDate2: attributeDate2
  No description.
• attributeDate20: attributeDate20
  No description.
• attributeDate3: attributeDate3
  No description.
• attributeDate4: attributeDate4
  No description.
• attributeDate5: attributeDate5
  No description.
• attributeDate6: attributeDate6
  No description.
• attributeDate7: attributeDate7
  No description.
• attributeDate8: attributeDate8
  No description.
• attributeDate9: attributeDate9
  No description.
• attributeNumber1: number (double)
  No description.
• attributeNumber10: number (double)
  No description.
• attributeNumber11: number (double)
  No description.
• attributeNumber12: number (double)
  No description.
• attributeNumber13: number (double)
  No description.
• attributeNumber14: number (double)
  No description.
• attributeNumber15: number (double)
  No description.
• attributeNumber16: number (double)
  No description.
• attributeNumber17: number (double)
  No description.
• attributeNumber18: number (double)
  No description.
• attributeNumber19: number (double)
  No description.
• attributeNumber2: number (double)
  No description.
• attributeNumber20: number (double)
  No description.
• attributeNumber3: number (double)
  No description.
• attributeNumber4: number (double)
  No description.
• attributeNumber5: number (double)
  No description.
• attributeNumber6: number (double)
  No description.
• attributeNumber7: number (double)
  No description.
• attributeNumber8: number (double)
  No description.
• attributeNumber9: number (double)
  No description.
• cellPhone: string
  No description.
• companyName: string
  No description.
• consolidatedNotifyOnly: boolean
  No description.
• consolidationProfileGid: string
  No description.
• contactGid: string
  No description.
• contactType: string
  No description.
• contactXid: string
  No description.
• description: string
  No description.
• domainName: string
  No description.
• ecmUser: string
  No description.
• emailAddress: string
  No description.
• externalSystemGid: string
  No description.
• fax: string
  No description.
• firstName: string
  No description.
• fromAddrContactGid: string
  No description.
• glUserGid: string
  No description.
• groups: groups
• groupSavedQueryGid: string
  No description.
• indicator: string
  No description.
• insertDate: insertDate
  Read Only: true

  insert date
• ippPrinterGid: string
  No description.
• isBroadcast: boolean
  No description.
• isEmailVirusProtected: boolean
  No description.
• isFromAddress: boolean
  No description.
• isNotificationOn: boolean
  No description.
• isPrimaryContact: boolean
  No description.
• jobTitle: string
  No description.
• languageSpoken: string
  No description.
• lastName: string
  No description.
• links: array links
  Read Only: true
• locationGid: string
  No description.
• messageProfileGid: string
  No description.
• middleName: string
  No description.
• nameAddressUpdateDate: nameAddressUpdateDate
  No description.
• notes: string
  No description.
• phone1: string
  No description.
• phone2: string
  No description.
• preferences: preferences
• recipientDomainName: string
  No description.
• routeThroughLocation: boolean
  No description.
• sendAsMessage: boolean
  No description.
• telex: string
  No description.
• timeZoneGid: string
  No description.
• updateDate: updateDate
  Read Only: true

  update date
• userDefined1IconGid: string
  No description.
• userDefined2IconGid: string
  No description.
• userDefined3IconGid: string
  No description.
• userDefined4IconGid: string
  No description.
• userDefined5IconGid: string
  No description.

{
    "properties":{
        "contactGid":{
            "description":"No description.",
            "type":"string"
        },
        "contactXid":{
            "description":"No description.",
            "type":"string"
        },
        "firstName":{
            "description":"No description.",
            "type":"string"
        },
        "lastName":{
            "description":"No description.",
            "type":"string"
        },
        "jobTitle":{
            "description":"No description.",
            "type":"string"
        },
        "emailAddress":{
            "description":"No description.",
            "type":"string"
        },
        "phone1":{
            "description":"No description.",
            "type":"string"
        },
        "phone2":{
            "description":"No description.",
            "type":"string"
        },
        "fax":{
            "description":"No description.",
            "type":"string"
        },
        "languageSpoken":{
            "description":"No description.",
            "type":"string"
        },
        "isPrimaryContact":{
            "description":"No description.",
            "type":"boolean"
        },
        "telex":{
            "description":"No description.",
            "type":"string"
        },
        "externalSystemGid":{
            "description":"No description.",
            "type":"string"
        },
        "notes":{
            "description":"No description.",
            "type":"string"
        },
        "glUserGid":{
            "description":"No description.",
            "type":"string"
        },
        "recipientDomainName":{
            "description":"No description.",
            "type":"string"
        },
        "routeThroughLocation":{
            "description":"No description.",
            "type":"boolean"
        },
        "contactType":{
            "description":"No description.",
            "type":"string"
        },
        "isBroadcast":{
            "description":"No description.",
            "type":"boolean"
        },
        "groupSavedQueryGid":{
            "description":"No description.",
            "type":"string"
        },
        "locationGid":{
            "description":"No description.",
            "type":"string"
        },
        "isEmailVirusProtected":{
            "description":"No description.",
            "type":"boolean"
        },
        "consolidationProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "consolidatedNotifyOnly":{
            "description":"No description.",
            "type":"boolean"
        },
        "isNotificationOn":{
            "description":"No description.",
            "type":"boolean"
        },
        "timeZoneGid":{
            "description":"No description.",
            "type":"string"
        },
        "fromAddrContactGid":{
            "description":"No description.",
            "type":"string"
        },
        "isFromAddress":{
            "description":"No description.",
            "type":"boolean"
        },
        "middleName":{
            "description":"No description.",
            "type":"string"
        },
        "cellPhone":{
            "description":"No description.",
            "type":"string"
        },
        "sendAsMessage":{
            "description":"No description.",
            "type":"boolean"
        },
        "messageProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "alternateName":{
            "description":"No description.",
            "type":"string"
        },
        "companyName":{
            "description":"No description.",
            "type":"string"
        },
        "description":{
            "description":"No description.",
            "type":"string"
        },
        "ippPrinterGid":{
            "description":"No description.",
            "type":"string"
        },
        "ecmUser":{
            "description":"No description.",
            "type":"string"
        },
        "attribute1":{
            "description":"No description.",
            "type":"string"
        },
        "attribute2":{
            "description":"No description.",
            "type":"string"
        },
        "attribute3":{
            "description":"No description.",
            "type":"string"
        },
        "attribute4":{
            "description":"No description.",
            "type":"string"
        },
        "attribute5":{
            "description":"No description.",
            "type":"string"
        },
        "attribute6":{
            "description":"No description.",
            "type":"string"
        },
        "attribute7":{
            "description":"No description.",
            "type":"string"
        },
        "attribute8":{
            "description":"No description.",
            "type":"string"
        },
        "attribute9":{
            "description":"No description.",
            "type":"string"
        },
        "attribute10":{
            "description":"No description.",
            "type":"string"
        },
        "attribute11":{
            "description":"No description.",
            "type":"string"
        },
        "attribute12":{
            "description":"No description.",
            "type":"string"
        },
        "attribute13":{
            "description":"No description.",
            "type":"string"
        },
        "attribute14":{
            "description":"No description.",
            "type":"string"
        },
        "attribute15":{
            "description":"No description.",
            "type":"string"
        },
        "attribute16":{
            "description":"No description.",
            "type":"string"
        },
        "attribute17":{
            "description":"No description.",
            "type":"string"
        },
        "attribute18":{
            "description":"No description.",
            "type":"string"
        },
        "attribute19":{
            "description":"No description.",
            "type":"string"
        },
        "attribute20":{
            "description":"No description.",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "nameAddressUpdateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "indicator":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined1IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "attributeDate11":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeNumber11":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "preferences":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/contactGroups.preferences"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "groups":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/contactGroups.groups"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : groups

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/contactGroups.groups"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : nameAddressUpdateDate

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : preferences

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/contactGroups.preferences"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object contactGroups.groups

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/contactGroups.groups"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : contactGroups.groups

Type: object

Show Source

• contactGid: string
  No description.
• domainName: string
  No description.
• links: array links
  Read Only: true

{
    "properties":{
        "contactGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object contactGroups.preferences

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/contactGroups.preferences"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : contactGroups.preferences

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• preferenceGid: string
  No description.
• value: string
  No description.

{
    "properties":{
        "preferenceGid":{
            "description":"No description.",
            "type":"string"
        },
        "value":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Back to Top