GET
/
groups
/
{id}
curl --request GET \
  --url https://api.kohortpay.com/groups/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "ord_1234567890",
  "shareId": "KHT-XXXXXXXX",
  "livemode": true,
  "organizationId": "org_1234567890",
  "customerId": "cus_1234567890",
  "creatorEmail": "[email protected]",
  "status": "COMPLETED",
  "metadata": {
    "basket_id": "1JYLo8KerLxWZaQtys6ZQ1xS"
  },
  "expiresAt": "2021-07-22T00:00:00.000Z",
  "midExpireAt": "2021-07-22T00:00:00.000Z",
  "jMinus2ExpireAt": "2021-07-22T00:00:00.000Z",
  "jPlus3StartAt": "2021-07-22T00:00:00.000Z",
  "reminderEmailSent": "NOT_SENT",
  "createdAt": "2021-07-22T00:00:00.000Z",
  "createdBy": "usr_1234567890",
  "updatedAt": "2021-07-22T00:00:00.000Z",
  "updatedBy": "usr_1234567890",
  "canceledAt": "2021-07-22T00:00:00.000Z",
  "completedAt": "2021-07-22T00:00:00.000Z"
}

Authorizations

​
Authorization
string
header
required

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.

Example:

10

​
skip
number

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

Example:

0

​
orderBy
string

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

Example:

"createdAt:desc"

​
search
string

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

Example:

"[email protected]"

​
any

Response

200 - application/json

Group successfully retrieved.

The response is of type object.