Search promotion plans

get

https://{tenant}.onechurchsoftware.com/api/groups/promotions

Retrieve a list of group promotion plans matching the given filters. Requires the Automation module.

Required permission: Full Write Promotions

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Filter by plan name.

description

string

Filter by plan description.

executed.start

date-time

Return plans executed on or after this date.

executed.end

date-time

Return plans executed on or before this date.

string

Filter by the name of the user who created the plan.

created.start

date-time

Return plans created on or after this date.

created.end

date-time

Return plans created on or before this date.

skip

int32

≥ 0

The number of records to skip before returning results, used for paging.

limit

int32

≥ 0

The maximum number of records to return per page. Defaults to 50.

sort.property

string

The field to sort the results by. The default field depends on the endpoint.

sort.dir

string

enum

The sort direction: "asc" or "desc".

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

200OK