v1

latestOpenAPI 3.0.02026-07-135965404.0 KB

Email Lists

Get individual email group

Retrieve all the details of a specific email list including it's name, when it was created and all the email addresses that belong to the group.

get/email-lists/{id}

Path parameters

idinteger required

ID of the email list to return.

Query parameters

includestring

Related record types to include in the response. Valid option is ownerUser

Headers

ev-api-keystring required

API Key required to make the API call.

ev-access-tokenstring required

Access token required to make the API call.

Response

Successful Operation

responseStatusinteger

Http Status code

Example response

{
  "responseStatus": 200,
  "included": [
    {
      "id": 655621,
      "type": "user",
      "attributes": {
        "status": 1,
        "expiration": "2020-06-30T13:33:30-07:00",
        "created": "2018-07-27T15:43:55-07:00",
        "modified": "2018-07-29T15:43:55-07:00",
        "accessTimestamp": "2011-03-21T00:18:56-07:00",
        "accountName": "exampleaccount",
        "username": "exampleuser",
        "nickname": "exampleuser",
        "email": "example@exavault.mail",
        "homePath": "/",
        "role": "user",
        "timeZone": "America/Chicago"
      },
      "relationships": {
        "homeResource": {
          "data": {
            "type": "resource"
          }
        },
        "ownerAccount": {
          "data": {
            "type": "account"
          }
        }
      }
    }
  ]
}