---
title: "Config - Contacts"
description: ""
url: "https://docs.itrsgroup.com/docs/opsview/6.11.7/rest-api/config/api-config-contacts/index.html"
---
Object type: contact

Request URL: `/rest/config/contact`

Methods:

- `GET` — List users.
- `POST` — Create users.
- `PUT` — Update users.
- `DELETE` — Unimplemented.

## Listing Contacts

### Example GET and response

```
$ opsview_rest --token-file /path/to/opsview_restapi_token --pretty GET 'config/contact?s.name=admin'
{
  list => [
    {
      description                => "System Administrator",
      enable_tips                => 0,
      fullname                   => "Administrator",
      homepage_id                => 2,
      id                         => 1,
      language                   => "",
      mylinks                    => [ ],
      name                       => "admin",
      notificationprofiles       => [ ],
      realm                      => "local",
      ref                        => "/rest/config/contact/1",
      role                       => { name => "Administrator", ref => "/rest/config/role/10" },
      sharednotificationprofiles => [ ],
      uncommitted                => 0,
      variables                  => [
                                      { name => "RSS_COLLAPSED", value => 1 },
                                      { name => "RSS_MAXIMUM_AGE", value => 1440 },
                                      { name => "RSS_MAXIMUM_ITEMS", value => 30 },
                                    ],
    },
  ],
  summary => { allrows => 4, page => 1, rows => 1, totalpages => 1, totalrows => 1 },
}
```

## Creating Contacts

### Example POST

```
$ opsview_rest --token-file /path/to/opsview_restapi_token --content-file=newcontact.json POST 'config/contact
```

Contents of file `newcontact.json`:

```
{
  "language": "",
  "homepage_id": null,
  "name": "newuser",
  "variables": [],
  "description": "",
  "sharednotificationprofiles": [],
  "notificationprofiles": [],
  "mylinks": [],
  "fullname": "New User",
  "realm": "local",
  "role": {
    "ref": "/rest/config/role/10",
    "name": "Administrator"
  },
  "enable_tips": "1",
  "uncommitted": "0"
}
```

## Updating Contacts

### Example PUT

```
$ opsview_rest --token-file /path/to/opsview_restapi_token PUT 'config/contact '{"name":"newuser", "fullname":"John Smith"}'
```


**Note**


For more information on how to generate and use the token file, see [opsview_rest](https://docs.itrsgroup.com/docs/opsview/6.11.7/rest-api/rest-api-background/api-common-examples/index.html#opsview_rest) documentation.




