GET
/
groups
/
{id}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Unique group ID

Query Parameters

expand
string[]

Fields to expand related entities. For example, ["organization"].

take
number

Maximum number of items to retrieve. Default is 25.

skip
number

Number of items to skip before starting to collect the result set.

orderBy
string

Field to order the results by, followed by ":asc" or ":desc". For example, "createdAt:desc".

search
string

Search term to filter the results. Supports multiple terms with "~" for partial matches.

Response

200 - application/json
id
string
required

The id of the group.

shareId
string | null
required

The shared identifier of the group. If null, it will create a group. If not null, it will join the group.

livemode
boolean
required

Wether the order is in live mode or test mode.

organizationId
string
required

The id of the organization.

customerId
string
required

The id of the customer.

creatorEmail
string
required

The email of the creator of the group.

status
enum<string>
required

The status of the group.

Available options:
OPEN,
COMPLETED,
CANCELED,
EXPIRED
metadata
object
required

Additional metadata for the order.

expiresAt
string
required
midExpireAt
string
required
jMinus2ExpireAt
string
required
jPlus3StartAt
string
required
reminderEmailSent
enum<string>
required

The reminder email sent status of the group.

Available options:
NOT_SENT,
MIDWAY_SENT,
DAY3_SENT,
DAY2_BEFORE_END_SENT
createdAt
string
required
createdBy
string | null
required

The id of the user who created the customer.

updatedAt
string
required
updatedBy
string | null
required

The id of the user who last updated the customer.

canceledAt
string
required
completedAt
string
required
Create a groupUpdate a group