Join fellow LogicMonitor users at the Elevate Community Conference and get hands-on with our latest product innovations.

Register Now

Resources

Explore our blogs, guides, case studies, eBooks, and more actionable insights to enhance your IT monitoring and observability.

View Resources

About us

Get to know LogicMonitor and our team.

About us

Documentation

Read through our documentation, check out our latest release notes, or submit a ticket to our world-class customer service team.

View Resources

Getting Recipient Group Details

Last updated on 07 October, 2024

You can use LogicMonitor REST API v3 to get recipient group details. You must authenticate yourself before making the API request.

Getting List of Recipient Groups

URI: GET /setting/recipientgroups

ParameterTypeDescription
fieldsStringThe response is filtered to include only the specified fields for each object. You can provide a list of properties separated by a comma.
Example – /setting/recipientgroups?fields=id,name
sizeIntegerThe number of result to display. A maximum of 1000 results can be requested in a GET request. By default, a list of 50 recipient groups is returned if a value is not provided for this parameter.
Example – /setting/recipientgroups?size=5
offsetIntegerThe number of result to offset the displayed results.
Example – /setting/recipientgroups?offset=2
filterStringThe response is filtered according to the operator and specified value that is, filter=property:value
  • Use an asterisk (*) to match more than one character
  • Use a dot (.) to filter values within an object (example, custom properties)
  • Use a comma (,) to separate multiple filters

Operators include:
  • Greater than or equals: >:
  • Less than or equals: <:
  • Greater than: >
  • Less than: <
  • Equals: :
  • Does not equal: !:
  • Includes: ~
  • Does not include: !~

Example – /setting/recipientgroups?filter=name!~LMQA*

Getting Details of Specific Recipient Group

URI: GET /setting/recipientgroups/{id}

ParameterTypeDescription
idInteger(Mandatory) The Id of the recipient group whose details you want to get.
In This Article

Get Started with LogicMonitor