Skip to main content
GET
List interview module members

Authorizations

Authorization
string
header
required

API tokens are passed as Bearer tokens.

Path Parameters

moduleId
string
required

an interview module ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.

Pattern: ^(?:mod_)?(?:[0-9a-fA-F]{32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Example:

"mod_a1b2c3d4e5f64789a1b2c3d4e5f64789"

Query Parameters

cursor
string

Opaque pagination cursor from the previous page's pagination.next_cursor, bound to the same query filters.

limit
integer
default:25

Page size. Must be between 1 and 100; defaults to 25.

Required range: 1 <= x <= 100
ids
string[]

Comma-separated list of IDs; maximum 100 values.

Minimum array length: 1

an user ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.

Pattern: ^(?:usr_)?(?:[0-9a-fA-F]{32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
statuses
enum<string>[]

Matches members with any listed training status; combines with ids using AND.

Minimum array length: 1
Available options:
TRAINED,
SHADOW,
REVERSE_SHADOW

Response

Success

data
object[]
required
pagination
object
required