Skip to main content
GET
Get lot group

Authorizations

X-API-Key
string
header
required

Path Parameters

group_id
string<shortuuid>
required

ID of the lot group.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Query Parameters

organization_id
string<shortuuid>

Organization that owns the addressed row. Optional: the row is found among every organization the caller can see. Naming one narrows the lookup to it.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Response

OK

A lot group as read from the API.

id
string<shortuuid>
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
name
string
required

The group's label (max 120 characters), unique within its brand.

brand_id
string<shortuuid>
required

UUID of the brand that owns the group.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
organization_id
string<shortuuid>
required

UUID of the organization that owns the group.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
member_count
integer
required

How many members the group has right now.

created
string<date-time>
required

ISO-8601 creation timestamp.

modified
string<date-time>
required

ISO-8601 last-modified timestamp.