Skip to main content
GET
List members

Authorizations

Authorization
string
header
required

Organization API key using Authorization: Bearer sk_....

Query Parameters

filter
object

Filter fields encoded with qs bracket notation.

skip
number
default:0

Pagination offset.

Required range: x >= 0
Example:

0

take
number
default:20

Pagination limit.

Required range: 1 <= x <= 100
Example:

20

Response

Members list

id
string
required

Unique identifier of the member.

Example:

"mem_1234567890abcdefghij"

createdAt
string<date-time>
required

When the member joined the organization.

updatedAt
string<date-time>
required

When the member was last updated.

organizationId
string
required

Organization the member belongs to.

userId
string
required

User behind this membership.

name
string
required

Name of the member.

Example:

"Ana López"

email
string
required

Email address the member signs in with.

Example:

"ana@example.com"

role
enum<string>
required

Role of the member in the organization.

Available options:
ADMIN,
USER,
SUPPORT,
OWNER,
SALES,
FINANCE,
VIEWER,
BERLITZ_QUALITY,
BERLITZ_ADVISOR,
BERLITZ_ADMIN_ADVISOR,
BERLITZ_SCHOOL_ADMIN,
BERLITZ_SCHOOL_ANALYST,
BERLITZ_RECEPTION,
BERLITZ_SERVICE_LEADER,
BERLITZ_COORDINATOR,
BERLITZ_SM2B_DIRECTOR,
BERLITZ_SM2B_SUPERVISOR
status
enum<string>
required

Membership status.

Available options:
ACTIVE,
INACTIVE,
PENDING