v1

latestOpenAPI 3.0.22026-07-24800528.1 KB
Groups

List all groups

Returns a list of your groups. The groups are returned sorted by creation date, with the most recent groups appearing first.

get/v2/groups

Query parameters

min_createdinteger

Applies a minimum epoch timestamp (ms) filter to the response created_at.

max_createdinteger

Applies a maximum epoch timestamp (ms) filter to the response created_at.

min_updatedinteger

Applies a minimum epoch timestamp (ms) filter to the response updated_at.

max_updatedinteger

Applies a maximum epoch timestamp (ms) filter to the response updated_at.

limitinteger

A limit on the number of items to be returned. Limits can range between 1 and 250, and the default is 10.

starting_afterstring

A cursor for use in pagination, starting_after takes in an item key and the subsequent call will return the following items in the list. This is mutually exclusive with ending_before.

ending_beforestring

A cursor for use in pagination, ending_before takes in an item key and the subsequent call will return the prior items in the list. This is mutually exclusive with starting_after.

Response

Returns a list of your groups. The groups are returned sorted by creation date, with the most recent groups appearing first.

messagestring required
statusinteger required

Example response

{
  "data": {
    "items": [
      {
        "created_at": 1574181282399,
        "key": "co_a80cb515fe",
        "updated_at": 1574181282399,
        "name": "Resellers",
        "slug": "resellers"
      }
    ]
  }
}