Get a group
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Unique group ID
Query Parameters
Fields to expand related entities. For example, ["organization"].
Maximum number of items to retrieve. Default is 25.
Number of items to skip before starting to collect the result set.
Field to order the results by, followed by ":asc" or ":desc". For example, "createdAt:desc".
Search term to filter the results. Supports multiple terms with "~" for partial matches.
Response
The id of the group.
The shared identifier of the group. If null, it will create a group. If not null, it will join the group.
Wether the order is in live mode or test mode.
The id of the organization.
The id of the customer.
The email of the creator of the group.
The status of the group.
OPEN, COMPLETED, CANCELED, EXPIRED Additional metadata for the order.
The reminder email sent status of the group.
NOT_SENT, MIDWAY_SENT, DAY3_SENT, DAY2_BEFORE_END_SENT The id of the user who created the customer.
The id of the user who last updated the customer.