Jump to

• Request
• Response
• Examples

Retrieve a list of email groups

get

/api/bulk/2.0/emailGroups

Retrieves a list of email groups.

Request

Supported Media Types

• application/json
• text/csv

Query Parameters

• limit: integer
• links: string
• offset: integer
• orderBy: string
• q: string
• totalResults: boolean

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : EmailGroupSearchResponse

Type: object

Title: EmailGroupSearchResponse

Show Source

• count: integer
  Title: count
• hasMore: boolean
  Title: hasMore
• items: array items
  Title: items
• limit: integer
  Title: limit
• offset: integer
  Title: offset
• totalResults: integer(int64)
  Title: totalResults

{
    "title":"EmailGroupSearchResponse",
    "description":"",
    "properties":{
        "count":{
            "title":"count",
            "description":"",
            "type":"integer"
        },
        "hasMore":{
            "title":"hasMore",
            "description":"",
            "type":"boolean"
        },
        "items":{
            "title":"items",
            "description":"",
            "type":"array",
            "items":{
                "$ref":"#/definitions/EmailGroup"
            }
        },
        "limit":{
            "title":"limit",
            "description":"",
            "type":"integer"
        },
        "offset":{
            "title":"offset",
            "description":"",
            "type":"integer"
        },
        "totalResults":{
            "format":"int64",
            "title":"totalResults",
            "description":"",
            "type":"integer"
        }
    }
}

Nested Schema : items

Type: array

Title: items

Show Source

• Array of: object EmailGroup
  Title: EmailGroup

{
    "title":"items",
    "description":"",
    "type":"array",
    "items":{
        "$ref":"#/definitions/EmailGroup"
    }
}

Nested Schema : EmailGroup

Type: object

Title: EmailGroup

Show Source

• createdAt: string(date-time)
  Title: createdAt
• createdBy: string
  Title: createdBy
• name: string
  Title: name
• statement: string
  Title: statement
• updatedAt: string(date-time)
  Title: updatedAt
• updatedBy: string
  Title: updatedBy
• uri: string
  Title: uri

{
    "title":"EmailGroup",
    "description":"",
    "properties":{
        "createdAt":{
            "format":"date-time",
            "title":"createdAt",
            "description":"",
            "type":"string"
        },
        "createdBy":{
            "title":"createdBy",
            "description":"",
            "type":"string"
        },
        "name":{
            "title":"name",
            "description":"",
            "type":"string"
        },
        "statement":{
            "title":"statement",
            "description":"",
            "type":"string"
        },
        "updatedAt":{
            "format":"date-time",
            "title":"updatedAt",
            "description":"",
            "type":"string"
        },
        "updatedBy":{
            "title":"updatedBy",
            "description":"",
            "type":"string"
        },
        "uri":{
            "title":"uri",
            "description":"",
            "type":"string"
        }
    }
}

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

409 Response

There was a conflict. See Status Codes for information about other possible HTTP status codes.

410 Response

The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes.

412 Response

The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes.

413 Response

Storage space exceeded. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes.

503 Response

There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes.

Back to Top

Examples

Retrieve the first 2 email groups:

GET /emailGroups?limit=2
			

Response:

{
    "items":[
        {
            "name":"BP - Templates",
            "statement":"{{EmailGroup[6]}}",
            "id":"/emailGroups/6",
            "updatedBy":"Deploy.User",
            "updatedAt":"2011-05-27T16:29:37.6270000Z"
        },
        {
            "name":"Test dsfgh5sy54667567",
            "statement":"{{EmailGroup[18]}}",
            "id":"/emailGroups/18",
            "createdBy":"API.User",
            "createdAt":"2015-05-21T20:32:18.0730000Z",
            "updatedBy":"API.User",
            "updatedAt":"2015-05-21T20:32:18.0730000Z"
        }
    ],
    "totalResults":16,
    "limit":2,
    "offset":0,
    "count":2,
    "hasMore":true
}
			

Back to Top