Get Groups

get

https://edgeapi.marchex.io/marketingedge/v5/api/Groups

Gets a listing of groups based on the search request.

Query Params

searchBy

string

Filter billing groups returned by the API.
Supported options: name, status.
Searching is done using StartsWith the specified criteria.

criteria

string

The criteria to search by.

sortBy

string

The field to sort the results by.
Supported options : name, status, created, updated

pageSize

int32

Determines how many results will be returned in a page. If this value isn't passed, the pageSize will default to the maximum size for that collection.

pageNumber

int32

Used to page through the results from your request. If this value is not provided, it will default to page 1.

sortDir

string

The direction to display the results.

Supported Options: asc, desc

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200Success

400Bad request. Please check your payload.

401Unauthorized. Please check your token or request.

404The item you are requesting was not found.

500Server Error