Skip to content
String Theory

Gets groups associated with a set of knots

POST
/v2/knots/groups

Request Body required

Section titled “Request Body required ”

Get groups for knots

object
sources
required
object
knotIds
Array<string>
threadIds
Array<string>
groupUnions
Array
Any of:
object
id
required
string
/group_[a-zA-Z0-9]{26}/
groupIntersections
Array<Array>
filters
object
availability
One of:
string
Allowed values: available withdrawn cancelled pending_deposit pending_withdrawal pending_transfer pending_return staged_transfer any
holdStatus
string
Allowed values: any held free
current
string
Allowed values: current old any
owner
object
type
required
string
id
required
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Groups from knots in the specified sources

object
commonGroups
required
Array<object>
object
type
required
string
token
required
string
id
required
string
/group_[a-zA-Z0-9]{26}/
ownerType
required
string
ownerId
required
string
sparseGroups
required
Array<object>
object
type
required
string
token
required
string
id
required
string
/group_[a-zA-Z0-9]{26}/
ownerType
required
string
ownerId
required
string