Members API Reference

#The Member object

Describes a teammate invited into a workspace, including their role, login metadata, and last-known activity so Linkbreakers can enforce access policies and audit collaboration.

accessRevokedAt

string (date-time)

When the member's access was revoked (null means active)

accessToken

string

Access token issued during sign-in; returned to clients but not persisted on the member record

createdAt

string (date-time)

Timestamp when the member was created

displayLanguage

string

Preferred language for emails and product copy (BCP-47)

string

Email address used as the member's login identifier

firstName

string

Member's given name used in UI surfaces and emails

string

Unique identifier for the member record (UUID)

lastKnownCountry

string

Country inferred from geolocation during the most recent sign-in (ISO 3166-1 alpha-2)

lastKnownIp

string

IP address seen on the most recent sign-in

lastKnownLanguage

string

Browser language header captured during the most recent sign-in

lastKnownTimezone

string

Timezone reported during the most recent sign-in (IANA TZ database)

lastName

string

Member's family name used in UI surfaces and emails

lastSigninAt

string (date-time)

Last time the member successfully authenticated

role

string (enum)

Role enumerates the built-in permission tiers that control what teammates can manage inside a workspace.

Allowed values

ROLE_UNSPECIFIED

Role not specified (defaults to viewer permissions)

ROLE_VIEWER

ROLE_ADMIN

ROLE_TECH

updatedAt

string (date-time)

Timestamp when member metadata was last updated

workspaceId

string

Workspace the member belongs to (UUID)

Example object

{
  "accessRevokedAt": "2025-10-29T08:03:25.653Z",
  "accessToken": "lbw_1w8jp9longjwtvalue",
  "createdAt": "2025-10-29T08:03:25.653Z",
  "displayLanguage": "en-US",
  "email": "sam.member@example.com",
  "firstName": "Sam",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "lastKnownCountry": "US",
  "lastKnownIp": "203.0.113.42",
  "lastKnownLanguage": "en-US,en;q=0.9",
  "lastKnownTimezone": "Europe/London",
  "lastName": "Rivera",
  "lastSigninAt": "2025-10-29T08:03:25.653Z",
  "role": "ROLE_ADMIN",
  "updatedAt": "2025-10-29T08:03:25.653Z",
  "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
}

GET/v1/memberRequires auth

#Get the current member

Return the member information associated with the authenticated caller.

#Parameters

This endpoint does not accept any parameters.

#Response

200

Everything worked as expected.

accessRevokedAt

string (date-time)

When the member's access was revoked (null means active)

accessToken

string

Access token issued during sign-in; returned to clients but not persisted on the member record

createdAt

string (date-time)

Timestamp when the member was created

displayLanguage

string

Preferred language for emails and product copy (BCP-47)

string

Email address used as the member's login identifier

firstName

string

Member's given name used in UI surfaces and emails

string

Unique identifier for the member record (UUID)

lastKnownCountry

string

Country inferred from geolocation during the most recent sign-in (ISO 3166-1 alpha-2)

lastKnownIp

string

IP address seen on the most recent sign-in

lastKnownLanguage

string

Browser language header captured during the most recent sign-in

lastKnownTimezone

string

Timezone reported during the most recent sign-in (IANA TZ database)

lastName

string

Member's family name used in UI surfaces and emails

lastSigninAt

string (date-time)

Last time the member successfully authenticated

role

string (enum)

Role enumerates the built-in permission tiers that control what teammates can manage inside a workspace.

Allowed values

ROLE_UNSPECIFIED

Role not specified (defaults to viewer permissions)

ROLE_VIEWER

ROLE_ADMIN

ROLE_TECH

updatedAt

string (date-time)

Timestamp when member metadata was last updated

workspaceId

string

Workspace the member belongs to (UUID)

#Error response

400-599

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

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/member" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "accessRevokedAt": "2025-10-29T08:03:25.652Z",
  "accessToken": "lbw_1w8jp9longjwtvalue",
  "createdAt": "2025-10-29T08:03:25.652Z",
  "displayLanguage": "en-US",
  "email": "sam.member@example.com",
  "firstName": "Sam",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "lastKnownCountry": "US",
  "lastKnownIp": "203.0.113.42",
  "lastKnownLanguage": "en-US,en;q=0.9",
  "lastKnownTimezone": "Europe/London",
  "lastName": "Rivera",
  "lastSigninAt": "2025-10-29T08:03:25.652Z",
  "role": "ROLE_ADMIN",
  "updatedAt": "2025-10-29T08:03:25.652Z",
  "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
}

Base URL: https://api.linkbreakers.com

GET/v1/membersRequires auth

#List members

Retrieve a paginated list of members in the current workspace.

#Parameters

This endpoint does not accept any parameters.

#Response

200

Everything worked as expected.

members

array<object>

Members included in the current page

#Error response

400-599

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

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/members" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "members": [
    {
      "accessRevokedAt": "2025-10-29T08:03:25.653Z",
      "accessToken": "lbw_1w8jp9longjwtvalue",
      "createdAt": "2025-10-29T08:03:25.653Z",
      "displayLanguage": "en-US",
      "email": "sam.member@example.com",
      "firstName": "Sam",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "lastKnownCountry": "US",
      "lastKnownIp": "203.0.113.42",
      "lastKnownLanguage": "en-US,en;q=0.9",
      "lastKnownTimezone": "Europe/London",
      "lastName": "Rivera",
      "lastSigninAt": "2025-10-29T08:03:25.653Z",
      "role": "ROLE_ADMIN",
      "updatedAt": "2025-10-29T08:03:25.653Z",
      "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
    }
  ]
}

Base URL: https://api.linkbreakers.com

GET/v1/members/{id}Requires auth

#Get a member by ID

Fetch a single workspace member by the provided identifier.

#Parameters

path parameters

stringRequiredpath

Member identifier (UUID) to retrieve

#Response

200

Everything worked as expected.

accessRevokedAt

string (date-time)

When the member's access was revoked (null means active)

accessToken

string

Access token issued during sign-in; returned to clients but not persisted on the member record

createdAt

string (date-time)

Timestamp when the member was created

displayLanguage

string

Preferred language for emails and product copy (BCP-47)

string

Email address used as the member's login identifier

firstName

string

Member's given name used in UI surfaces and emails

string

Unique identifier for the member record (UUID)

lastKnownCountry

string

Country inferred from geolocation during the most recent sign-in (ISO 3166-1 alpha-2)

lastKnownIp

string

IP address seen on the most recent sign-in

lastKnownLanguage

string

Browser language header captured during the most recent sign-in

lastKnownTimezone

string

Timezone reported during the most recent sign-in (IANA TZ database)

lastName

string

Member's family name used in UI surfaces and emails

lastSigninAt

string (date-time)

Last time the member successfully authenticated

role

string (enum)

Role enumerates the built-in permission tiers that control what teammates can manage inside a workspace.

Allowed values

ROLE_UNSPECIFIED

Role not specified (defaults to viewer permissions)

ROLE_VIEWER

ROLE_ADMIN

ROLE_TECH

updatedAt

string (date-time)

Timestamp when member metadata was last updated

workspaceId

string

Workspace the member belongs to (UUID)

#Error response

400-599

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

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/members/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "accessRevokedAt": "2025-10-29T08:03:25.653Z",
  "accessToken": "lbw_1w8jp9longjwtvalue",
  "createdAt": "2025-10-29T08:03:25.653Z",
  "displayLanguage": "en-US",
  "email": "sam.member@example.com",
  "firstName": "Sam",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "lastKnownCountry": "US",
  "lastKnownIp": "203.0.113.42",
  "lastKnownLanguage": "en-US,en;q=0.9",
  "lastKnownTimezone": "Europe/London",
  "lastName": "Rivera",
  "lastSigninAt": "2025-10-29T08:03:25.653Z",
  "role": "ROLE_ADMIN",
  "updatedAt": "2025-10-29T08:03:25.653Z",
  "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
}

Base URL: https://api.linkbreakers.com

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

#Allow access for a member

Restore workspace access for a previously suspended member.

#Parameters

path parameters

stringRequiredpath

Member identifier (UUID) whose access should be restored

#Request body

No structured schema available for this section.

#Response

200

Everything worked as expected.

accessRevokedAt

string (date-time)

When the member's access was revoked (null means active)

accessToken

string

Access token issued during sign-in; returned to clients but not persisted on the member record

createdAt

string (date-time)

Timestamp when the member was created

displayLanguage

string

Preferred language for emails and product copy (BCP-47)

string

Email address used as the member's login identifier

firstName

string

Member's given name used in UI surfaces and emails

string

Unique identifier for the member record (UUID)

lastKnownCountry

string

Country inferred from geolocation during the most recent sign-in (ISO 3166-1 alpha-2)

lastKnownIp

string

IP address seen on the most recent sign-in

lastKnownLanguage

string

Browser language header captured during the most recent sign-in

lastKnownTimezone

string

Timezone reported during the most recent sign-in (IANA TZ database)

lastName

string

Member's family name used in UI surfaces and emails

lastSigninAt

string (date-time)

Last time the member successfully authenticated

role

string (enum)

Role enumerates the built-in permission tiers that control what teammates can manage inside a workspace.

Allowed values

ROLE_UNSPECIFIED

Role not specified (defaults to viewer permissions)

ROLE_VIEWER

ROLE_ADMIN

ROLE_TECH

updatedAt

string (date-time)

Timestamp when member metadata was last updated

workspaceId

string

Workspace the member belongs to (UUID)

#Error response

400-599

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

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X POST "https://api.linkbreakers.com/v1/members/{id}/allow" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{}'

Sample payload (application/json)

{}

Typical response

{
  "accessRevokedAt": "2025-10-29T08:03:25.653Z",
  "accessToken": "lbw_1w8jp9longjwtvalue",
  "createdAt": "2025-10-29T08:03:25.653Z",
  "displayLanguage": "en-US",
  "email": "sam.member@example.com",
  "firstName": "Sam",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "lastKnownCountry": "US",
  "lastKnownIp": "203.0.113.42",
  "lastKnownLanguage": "en-US,en;q=0.9",
  "lastKnownTimezone": "Europe/London",
  "lastName": "Rivera",
  "lastSigninAt": "2025-10-29T08:03:25.653Z",
  "role": "ROLE_ADMIN",
  "updatedAt": "2025-10-29T08:03:25.653Z",
  "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
}

Base URL: https://api.linkbreakers.com

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

#Revoke access for a member

Suspend a member's access without removing their account.

#Parameters

path parameters

stringRequiredpath

Member identifier (UUID) whose access should be suspended

#Request body

No structured schema available for this section.

#Response

200

Everything worked as expected.

accessRevokedAt

string (date-time)

When the member's access was revoked (null means active)

accessToken

string

Access token issued during sign-in; returned to clients but not persisted on the member record

createdAt

string (date-time)

Timestamp when the member was created

displayLanguage

string

Preferred language for emails and product copy (BCP-47)

string

Email address used as the member's login identifier

firstName

string

Member's given name used in UI surfaces and emails

string

Unique identifier for the member record (UUID)

lastKnownCountry

string

Country inferred from geolocation during the most recent sign-in (ISO 3166-1 alpha-2)

lastKnownIp

string

IP address seen on the most recent sign-in

lastKnownLanguage

string

Browser language header captured during the most recent sign-in

lastKnownTimezone

string

Timezone reported during the most recent sign-in (IANA TZ database)

lastName

string

Member's family name used in UI surfaces and emails

lastSigninAt

string (date-time)

Last time the member successfully authenticated

role

string (enum)

Role enumerates the built-in permission tiers that control what teammates can manage inside a workspace.

Allowed values

ROLE_UNSPECIFIED

Role not specified (defaults to viewer permissions)

ROLE_VIEWER

ROLE_ADMIN

ROLE_TECH

updatedAt

string (date-time)

Timestamp when member metadata was last updated

workspaceId

string

Workspace the member belongs to (UUID)

#Error response

400-599

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

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X POST "https://api.linkbreakers.com/v1/members/{id}/revoke" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{}'

Sample payload (application/json)

{}

Typical response

{
  "accessRevokedAt": "2025-10-29T08:03:25.653Z",
  "accessToken": "lbw_1w8jp9longjwtvalue",
  "createdAt": "2025-10-29T08:03:25.653Z",
  "displayLanguage": "en-US",
  "email": "sam.member@example.com",
  "firstName": "Sam",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "lastKnownCountry": "US",
  "lastKnownIp": "203.0.113.42",
  "lastKnownLanguage": "en-US,en;q=0.9",
  "lastKnownTimezone": "Europe/London",
  "lastName": "Rivera",
  "lastSigninAt": "2025-10-29T08:03:25.653Z",
  "role": "ROLE_ADMIN",
  "updatedAt": "2025-10-29T08:03:25.653Z",
  "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
}

Base URL: https://api.linkbreakers.com

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

#Force a member to sign out

Terminate all active sessions for the specified member.

#Parameters

path parameters

stringRequiredpath

Member identifier (UUID) to sign out of all sessions

#Request body

No structured schema available for this section.

#Response

200

Everything worked as expected.

accessRevokedAt

string (date-time)

When the member's access was revoked (null means active)

accessToken

string

Access token issued during sign-in; returned to clients but not persisted on the member record

createdAt

string (date-time)

Timestamp when the member was created

displayLanguage

string

Preferred language for emails and product copy (BCP-47)

string

Email address used as the member's login identifier

firstName

string

Member's given name used in UI surfaces and emails

string

Unique identifier for the member record (UUID)

lastKnownCountry

string

Country inferred from geolocation during the most recent sign-in (ISO 3166-1 alpha-2)

lastKnownIp

string

IP address seen on the most recent sign-in

lastKnownLanguage

string

Browser language header captured during the most recent sign-in

lastKnownTimezone

string

Timezone reported during the most recent sign-in (IANA TZ database)

lastName

string

Member's family name used in UI surfaces and emails

lastSigninAt

string (date-time)

Last time the member successfully authenticated

role

string (enum)

Role enumerates the built-in permission tiers that control what teammates can manage inside a workspace.

Allowed values

ROLE_UNSPECIFIED

Role not specified (defaults to viewer permissions)

ROLE_VIEWER

ROLE_ADMIN

ROLE_TECH

updatedAt

string (date-time)

Timestamp when member metadata was last updated

workspaceId

string

Workspace the member belongs to (UUID)

#Error response

400-599

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

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X POST "https://api.linkbreakers.com/v1/members/{id}/signout" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{}'

Sample payload (application/json)

{}

Typical response

{
  "accessRevokedAt": "2025-10-29T08:03:25.653Z",
  "accessToken": "lbw_1w8jp9longjwtvalue",
  "createdAt": "2025-10-29T08:03:25.653Z",
  "displayLanguage": "en-US",
  "email": "sam.member@example.com",
  "firstName": "Sam",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "lastKnownCountry": "US",
  "lastKnownIp": "203.0.113.42",
  "lastKnownLanguage": "en-US,en;q=0.9",
  "lastKnownTimezone": "Europe/London",
  "lastName": "Rivera",
  "lastSigninAt": "2025-10-29T08:03:25.653Z",
  "role": "ROLE_ADMIN",
  "updatedAt": "2025-10-29T08:03:25.653Z",
  "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
}

Base URL: https://api.linkbreakers.com

POST/v1/members/inviteRequires auth

#Invite a new member

Create a pending member and dispatch an invitation email.

#Parameters

This endpoint does not accept any parameters.

#Request body

string

Email address of the invitee

firstName

string

First name used in invitation email and dashboard

lastName

string

Last name used in invitation email and dashboard

#Response

200

Everything worked as expected.

accessRevokedAt

string (date-time)

When the member's access was revoked (null means active)

accessToken

string

Access token issued during sign-in; returned to clients but not persisted on the member record

createdAt

string (date-time)

Timestamp when the member was created

displayLanguage

string

Preferred language for emails and product copy (BCP-47)

string

Email address used as the member's login identifier

firstName

string

Member's given name used in UI surfaces and emails

string

Unique identifier for the member record (UUID)

lastKnownCountry

string

Country inferred from geolocation during the most recent sign-in (ISO 3166-1 alpha-2)

lastKnownIp

string

IP address seen on the most recent sign-in

lastKnownLanguage

string

Browser language header captured during the most recent sign-in

lastKnownTimezone

string

Timezone reported during the most recent sign-in (IANA TZ database)

lastName

string

Member's family name used in UI surfaces and emails

lastSigninAt

string (date-time)

Last time the member successfully authenticated

role

string (enum)

Role enumerates the built-in permission tiers that control what teammates can manage inside a workspace.

Allowed values

ROLE_UNSPECIFIED

Role not specified (defaults to viewer permissions)

ROLE_VIEWER

ROLE_ADMIN

ROLE_TECH

updatedAt

string (date-time)

Timestamp when member metadata was last updated

workspaceId

string

Workspace the member belongs to (UUID)

#Error response

400-599

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

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X POST "https://api.linkbreakers.com/v1/members/invite" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"email":"string","firstName":"string","lastName":"string"}'

Sample payload (application/json)

{
  "email": "string",
  "firstName": "string",
  "lastName": "string"
}

Typical response

{
  "accessRevokedAt": "2025-10-29T08:03:25.653Z",
  "accessToken": "lbw_1w8jp9longjwtvalue",
  "createdAt": "2025-10-29T08:03:25.653Z",
  "displayLanguage": "en-US",
  "email": "sam.member@example.com",
  "firstName": "Sam",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "lastKnownCountry": "US",
  "lastKnownIp": "203.0.113.42",
  "lastKnownLanguage": "en-US,en;q=0.9",
  "lastKnownTimezone": "Europe/London",
  "lastName": "Rivera",
  "lastSigninAt": "2025-10-29T08:03:25.653Z",
  "role": "ROLE_ADMIN",
  "updatedAt": "2025-10-29T08:03:25.653Z",
  "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
}

Base URL: https://api.linkbreakers.com

PUT/v1/memberRequires auth

#Update the current member

Let the signed-in member update their own profile or credentials.

#Parameters

This endpoint does not accept any parameters.

#Request body

string

New email address for the signed-in member

firstName

string

First name to display in the product

lastName

string

Last name to display in the product

password

string

Optional password update for the signed-in member

#Response

200

Everything worked as expected.

accessRevokedAt

string (date-time)

When the member's access was revoked (null means active)

accessToken

string

Access token issued during sign-in; returned to clients but not persisted on the member record

createdAt

string (date-time)

Timestamp when the member was created

displayLanguage

string

Preferred language for emails and product copy (BCP-47)

string

Email address used as the member's login identifier

firstName

string

Member's given name used in UI surfaces and emails

string

Unique identifier for the member record (UUID)

lastKnownCountry

string

Country inferred from geolocation during the most recent sign-in (ISO 3166-1 alpha-2)

lastKnownIp

string

IP address seen on the most recent sign-in

lastKnownLanguage

string

Browser language header captured during the most recent sign-in

lastKnownTimezone

string

Timezone reported during the most recent sign-in (IANA TZ database)

lastName

string

Member's family name used in UI surfaces and emails

lastSigninAt

string (date-time)

Last time the member successfully authenticated

role

string (enum)

Role enumerates the built-in permission tiers that control what teammates can manage inside a workspace.

Allowed values

ROLE_UNSPECIFIED

Role not specified (defaults to viewer permissions)

ROLE_VIEWER

ROLE_ADMIN

ROLE_TECH

updatedAt

string (date-time)

Timestamp when member metadata was last updated

workspaceId

string

Workspace the member belongs to (UUID)

#Error response

400-599

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

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X PUT "https://api.linkbreakers.com/v1/member" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"email":"string","firstName":"string","lastName":"string","password":"string"}'

Sample payload (application/json)

{
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "password": "string"
}

Typical response

{
  "accessRevokedAt": "2025-10-29T08:03:25.652Z",
  "accessToken": "lbw_1w8jp9longjwtvalue",
  "createdAt": "2025-10-29T08:03:25.652Z",
  "displayLanguage": "en-US",
  "email": "sam.member@example.com",
  "firstName": "Sam",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "lastKnownCountry": "US",
  "lastKnownIp": "203.0.113.42",
  "lastKnownLanguage": "en-US,en;q=0.9",
  "lastKnownTimezone": "Europe/London",
  "lastName": "Rivera",
  "lastSigninAt": "2025-10-29T08:03:25.652Z",
  "role": "ROLE_ADMIN",
  "updatedAt": "2025-10-29T08:03:25.652Z",
  "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
}

Base URL: https://api.linkbreakers.com

PUT/v1/members/{id}Requires auth

#Update a member

Modify profile details or role assignments for an existing member.

#Parameters

path parameters

stringRequiredpath

Member identifier (UUID) to update

#Request body

displayLanguage

string

Preferred language for product copy and emails

string

Email address used for login and notifications

firstName

string

First name to display in the product

lastName

string

Last name to display in the product

role

string (enum)

Role enumerates the built-in permission tiers that control what teammates can manage inside a workspace.

Allowed values

ROLE_UNSPECIFIED

Role not specified (defaults to viewer permissions)

ROLE_VIEWER

ROLE_ADMIN

ROLE_TECH

#Response

200

Everything worked as expected.

accessRevokedAt

string (date-time)

When the member's access was revoked (null means active)

accessToken

string

Access token issued during sign-in; returned to clients but not persisted on the member record

createdAt

string (date-time)

Timestamp when the member was created

displayLanguage

string

Preferred language for emails and product copy (BCP-47)

string

Email address used as the member's login identifier

firstName

string

Member's given name used in UI surfaces and emails

string

Unique identifier for the member record (UUID)

lastKnownCountry

string

Country inferred from geolocation during the most recent sign-in (ISO 3166-1 alpha-2)

lastKnownIp

string

IP address seen on the most recent sign-in

lastKnownLanguage

string

Browser language header captured during the most recent sign-in

lastKnownTimezone

string

Timezone reported during the most recent sign-in (IANA TZ database)

lastName

string

Member's family name used in UI surfaces and emails

lastSigninAt

string (date-time)

Last time the member successfully authenticated

role

string (enum)

Role enumerates the built-in permission tiers that control what teammates can manage inside a workspace.

Allowed values

ROLE_UNSPECIFIED

Role not specified (defaults to viewer permissions)

ROLE_VIEWER

ROLE_ADMIN

ROLE_TECH

updatedAt

string (date-time)

Timestamp when member metadata was last updated

workspaceId

string

Workspace the member belongs to (UUID)

#Error response

400-599

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

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X PUT "https://api.linkbreakers.com/v1/members/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"displayLanguage":"string","email":"string","firstName":"string","lastName":"string","role":"ROLE_TECH"}'

Sample payload (application/json)

{
  "displayLanguage": "string",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "role": "ROLE_TECH"
}

Typical response

{
  "accessRevokedAt": "2025-10-29T08:03:25.653Z",
  "accessToken": "lbw_1w8jp9longjwtvalue",
  "createdAt": "2025-10-29T08:03:25.653Z",
  "displayLanguage": "en-US",
  "email": "sam.member@example.com",
  "firstName": "Sam",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "lastKnownCountry": "US",
  "lastKnownIp": "203.0.113.42",
  "lastKnownLanguage": "en-US,en;q=0.9",
  "lastKnownTimezone": "Europe/London",
  "lastName": "Rivera",
  "lastSigninAt": "2025-10-29T08:03:25.653Z",
  "role": "ROLE_ADMIN",
  "updatedAt": "2025-10-29T08:03:25.653Z",
  "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
}

Base URL: https://api.linkbreakers.com

DELETE/v1/members/{id}Requires auth

#Delete a member

Permanently remove a member from the workspace roster.

#Parameters

path parameters

stringRequiredpath

Member identifier (UUID) to delete

#Response

200

Everything worked as expected.

No structured schema available for this section.

#Error response

400-599

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

error

objectRequired

Wrapped error response.