Join us now
← Back to API Reference overview

Members

Endpoints for managing members in Linkbreakers. These endpoints allow you to invite, retrieve, update, and delete members.

Shortcut: ⌘K

#The Member object

Member represents a user in the system

accessRevokedAt

string (date-time)

accessToken

string

createdAt

string (date-time)

displayLanguage

string

email

string

firstName

string

id

string

lastKnownCountry

string

lastKnownIp

string

lastKnownLanguage

string

lastKnownTimezone

string

lastName

string

lastSigninAt

string (date-time)

role

string (enum)
Allowed values
ROLE_UNSPECIFIED
ROLE_VIEWER
ROLE_ADMIN
ROLE_TECH

updatedAt

string (date-time)

workspaceId

string
GET/v1/memberRequires auth

#Get the current member

#Parameters

This endpoint does not accept any parameters.

#Response

200

Everything worked as expected.

accessRevokedAt

string (date-time)

accessToken

string

createdAt

string (date-time)

displayLanguage

string

email

string

firstName

string

id

string

lastKnownCountry

string

lastKnownIp

string

lastKnownLanguage

string

lastKnownTimezone

string

lastName

string

lastSigninAt

string (date-time)

role

string (enum)
Allowed values
ROLE_UNSPECIFIED
ROLE_VIEWER
ROLE_ADMIN
ROLE_TECH

updatedAt

string (date-time)

workspaceId

string

#Error response

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

GET/v1/membersRequires auth

#List members

#Parameters

This endpoint does not accept any parameters.

#Response

200

Everything worked as expected.

members

array<object>

#Error response

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

GET/v1/members/{id}Requires auth

#Get a member by ID

#Parameters

path parameters

id

stringRequiredpath

#Response

200

Everything worked as expected.

accessRevokedAt

string (date-time)

accessToken

string

createdAt

string (date-time)

displayLanguage

string

email

string

firstName

string

id

string

lastKnownCountry

string

lastKnownIp

string

lastKnownLanguage

string

lastKnownTimezone

string

lastName

string

lastSigninAt

string (date-time)

role

string (enum)
Allowed values
ROLE_UNSPECIFIED
ROLE_VIEWER
ROLE_ADMIN
ROLE_TECH

updatedAt

string (date-time)

workspaceId

string

#Error response

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

POST/v1/members/{id}/allowRequires auth

#Allow access for a member

#Parameters

path parameters

id

stringRequiredpath

#Request body

No structured schema available for this section.

#Response

200

Everything worked as expected.

accessRevokedAt

string (date-time)

accessToken

string

createdAt

string (date-time)

displayLanguage

string

email

string

firstName

string

id

string

lastKnownCountry

string

lastKnownIp

string

lastKnownLanguage

string

lastKnownTimezone

string

lastName

string

lastSigninAt

string (date-time)

role

string (enum)
Allowed values
ROLE_UNSPECIFIED
ROLE_VIEWER
ROLE_ADMIN
ROLE_TECH

updatedAt

string (date-time)

workspaceId

string

#Error response

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

POST/v1/members/{id}/revokeRequires auth

#Revoke access for a member

#Parameters

path parameters

id

stringRequiredpath

#Request body

No structured schema available for this section.

#Response

200

Everything worked as expected.

accessRevokedAt

string (date-time)

accessToken

string

createdAt

string (date-time)

displayLanguage

string

email

string

firstName

string

id

string

lastKnownCountry

string

lastKnownIp

string

lastKnownLanguage

string

lastKnownTimezone

string

lastName

string

lastSigninAt

string (date-time)

role

string (enum)
Allowed values
ROLE_UNSPECIFIED
ROLE_VIEWER
ROLE_ADMIN
ROLE_TECH

updatedAt

string (date-time)

workspaceId

string

#Error response

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

POST/v1/members/{id}/signoutRequires auth

#Force a member to sign out

#Parameters

path parameters

id

stringRequiredpath

#Request body

No structured schema available for this section.

#Response

200

Everything worked as expected.

accessRevokedAt

string (date-time)

accessToken

string

createdAt

string (date-time)

displayLanguage

string

email

string

firstName

string

id

string

lastKnownCountry

string

lastKnownIp

string

lastKnownLanguage

string

lastKnownTimezone

string

lastName

string

lastSigninAt

string (date-time)

role

string (enum)
Allowed values
ROLE_UNSPECIFIED
ROLE_VIEWER
ROLE_ADMIN
ROLE_TECH

updatedAt

string (date-time)

workspaceId

string

#Error response

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

POST/v1/members/inviteRequires auth

#Invite a new member

#Parameters

This endpoint does not accept any parameters.

#Request body

email

string

firstName

string

lastName

string

#Response

200

Everything worked as expected.

accessRevokedAt

string (date-time)

accessToken

string

createdAt

string (date-time)

displayLanguage

string

email

string

firstName

string

id

string

lastKnownCountry

string

lastKnownIp

string

lastKnownLanguage

string

lastKnownTimezone

string

lastName

string

lastSigninAt

string (date-time)

role

string (enum)
Allowed values
ROLE_UNSPECIFIED
ROLE_VIEWER
ROLE_ADMIN
ROLE_TECH

updatedAt

string (date-time)

workspaceId

string

#Error response

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

PUT/v1/memberRequires auth

#Update the current member

#Parameters

This endpoint does not accept any parameters.

#Request body

email

string

firstName

string

lastName

string

password

string

#Response

200

Everything worked as expected.

accessRevokedAt

string (date-time)

accessToken

string

createdAt

string (date-time)

displayLanguage

string

email

string

firstName

string

id

string

lastKnownCountry

string

lastKnownIp

string

lastKnownLanguage

string

lastKnownTimezone

string

lastName

string

lastSigninAt

string (date-time)

role

string (enum)
Allowed values
ROLE_UNSPECIFIED
ROLE_VIEWER
ROLE_ADMIN
ROLE_TECH

updatedAt

string (date-time)

workspaceId

string

#Error response

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

PUT/v1/members/{id}Requires auth

#Update a member

#Parameters

path parameters

id

stringRequiredpath

#Request body

displayLanguage

string

email

string

firstName

string

lastName

string

role

string (enum)
Allowed values
ROLE_UNSPECIFIED
ROLE_VIEWER
ROLE_ADMIN
ROLE_TECH

#Response

200

Everything worked as expected.

accessRevokedAt

string (date-time)

accessToken

string

createdAt

string (date-time)

displayLanguage

string

email

string

firstName

string

id

string

lastKnownCountry

string

lastKnownIp

string

lastKnownLanguage

string

lastKnownTimezone

string

lastName

string

lastSigninAt

string (date-time)

role

string (enum)
Allowed values
ROLE_UNSPECIFIED
ROLE_VIEWER
ROLE_ADMIN
ROLE_TECH

updatedAt

string (date-time)

workspaceId

string

#Error response

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

DELETE/v1/members/{id}Requires auth

#Delete a member

#Parameters

path parameters

id

stringRequiredpath

#Response

200

Everything worked as expected.

No structured schema available for this section.

#Error response

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.