Lightfield Members API
The Members API from Lightfield — 2 operation(s) for members.
OpenAPI Specification
openapi: 3.1.1
info:
title: API Reference Accounts Members API
version: 0.0.0
tags:
- name: Members
paths:
/v1/members/{id}:
get:
operationId: member.retrieve
summary: Retrieve a member
description: 'Retrieves a single member by their ID.
**[Required scope](/using-the-api/scopes/):** `members:read`
**[Rate limit category](/using-the-api/rate-limits/):** Read'
security:
- bearerAuth: []
parameters:
- name: Lightfield-Version
in: header
required: true
description: Required API version header. Requests may error without it.
schema:
type: string
enum:
- '2026-03-01'
default: '2026-03-01'
example: '2026-03-01'
- name: id
in: path
required: true
schema:
type: string
description: Unique identifier of the member to retrieve.
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MemberRetrieveResponse'
'400':
description: '400'
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestError'
'401':
description: '401'
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
'403':
description: '403'
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenError'
'404':
description: '404'
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundError'
'409':
description: '409'
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictError'
'415':
description: '415'
content:
application/json:
schema:
$ref: '#/components/schemas/UnsupportedMediaTypeError'
'422':
description: '422'
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableContentError'
'429':
description: '429'
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsError'
'500':
description: '500'
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerError'
'503':
description: '503'
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableError'
'504':
description: '504'
content:
application/json:
schema:
$ref: '#/components/schemas/GatewayTimeoutError'
tags:
- Members
/v1/members:
get:
operationId: member.list
summary: List members
description: 'Returns a paginated list of members in your workspace. Use `offset` and `limit` to paginate through results. See <u>[List endpoints](/using-the-api/list-endpoints/)</u> for more information about pagination.
**[Required scope](/using-the-api/scopes/):** `members:read`
**[Rate limit category](/using-the-api/rate-limits/):** Search'
security:
- bearerAuth: []
parameters:
- name: Lightfield-Version
in: header
required: true
description: Required API version header. Requests may error without it.
schema:
type: string
enum:
- '2026-03-01'
default: '2026-03-01'
example: '2026-03-01'
- name: offset
in: query
schema:
type: integer
minimum: 0
maximum: 9007199254740991
description: Number of records to skip for pagination. Defaults to 0.
allowEmptyValue: true
allowReserved: true
- name: limit
in: query
schema:
type: integer
minimum: 1
maximum: 9007199254740991
description: Maximum number of records to return. Defaults to 25, maximum 25.
allowEmptyValue: true
allowReserved: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MemberListResponse'
'400':
description: '400'
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestError'
'401':
description: '401'
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
'403':
description: '403'
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenError'
'404':
description: '404'
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundError'
'409':
description: '409'
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictError'
'415':
description: '415'
content:
application/json:
schema:
$ref: '#/components/schemas/UnsupportedMediaTypeError'
'422':
description: '422'
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableContentError'
'429':
description: '429'
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsError'
'500':
description: '500'
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerError'
'503':
description: '503'
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableError'
'504':
description: '504'
content:
application/json:
schema:
$ref: '#/components/schemas/GatewayTimeoutError'
tags:
- Members
components:
schemas:
MemberListResponse:
type: object
properties:
object:
type: string
description: The object type, always `"list"`.
data:
type: array
items:
type: object
properties:
id:
type: string
description: Unique identifier for the member.
createdAt:
type: string
description: ISO 8601 timestamp of when the member was created.
updatedAt:
anyOf:
- type: string
- type: 'null'
description: ISO 8601 timestamp of when the member was last updated, or null.
httpLink:
anyOf:
- type: string
- type: 'null'
description: URL to view the member in the Lightfield web app, or null.
fields:
type: object
properties:
$email:
type: object
properties:
value:
type: string
description: The field value.
valueType:
enum:
- EMAIL
description: The data type of the field value.
required:
- value
- valueType
additionalProperties: false
description: The member's email address.
$name:
type: object
properties:
value:
$ref: '#/components/schemas/FullName'
valueType:
enum:
- FULL_NAME
description: The data type of the field value.
required:
- value
- valueType
additionalProperties: false
description: The member's full name.
$profileImage:
type: object
properties:
value:
anyOf:
- type: string
- type: 'null'
description: The field value, or null if unset.
valueType:
enum:
- URL
description: The data type of the field value.
required:
- value
- valueType
additionalProperties: false
description: URL of the member's profile image, or null if unset.
$role:
type: object
properties:
value:
type: string
description: The field value.
valueType:
enum:
- TEXT
description: The data type of the field value.
required:
- value
- valueType
additionalProperties: false
description: The member's workspace role.
required:
- $email
- $name
- $profileImage
- $role
additionalProperties: false
description: Map of field names to their typed values.
relationships:
type: object
additionalProperties: false
description: Members do not expose writable or readable relationships in this API.
required:
- id
- createdAt
- updatedAt
- httpLink
- fields
- relationships
description: Array of member objects for the current page.
totalCount:
type: integer
minimum: 0
maximum: 9007199254740991
description: Total number of members in the workspace.
required:
- object
- data
- totalCount
InternalServerError:
type: object
properties:
type:
const: internal_server_error
message:
type: string
default: Internal Server Error
required:
- type
- message
GatewayTimeoutError:
type: object
properties:
type:
const: gateway_timeout
message:
type: string
default: Gateway Timeout
required:
- type
- message
TooManyRequestsError:
type: object
properties:
type:
const: too_many_requests
message:
type: string
default: Too Many Requests
required:
- type
- message
UnsupportedMediaTypeError:
type: object
properties:
type:
const: unsupported_media_type
message:
type: string
default: Unsupported Media Type
required:
- type
- message
ForbiddenError:
type: object
properties:
type:
const: forbidden
message:
type: string
default: Forbidden
required:
- type
- message
MemberRetrieveResponse:
type: object
properties:
id:
type: string
description: Unique identifier for the member.
createdAt:
type: string
description: ISO 8601 timestamp of when the member was created.
updatedAt:
anyOf:
- type: string
- type: 'null'
description: ISO 8601 timestamp of when the member was last updated, or null.
httpLink:
anyOf:
- type: string
- type: 'null'
description: URL to view the member in the Lightfield web app, or null.
fields:
type: object
properties:
$email:
type: object
properties:
value:
type: string
description: The field value.
valueType:
enum:
- EMAIL
description: The data type of the field value.
required:
- value
- valueType
additionalProperties: false
description: The member's email address.
$name:
type: object
properties:
value:
$ref: '#/components/schemas/FullName'
valueType:
enum:
- FULL_NAME
description: The data type of the field value.
required:
- value
- valueType
additionalProperties: false
description: The member's full name.
$profileImage:
type: object
properties:
value:
anyOf:
- type: string
- type: 'null'
description: The field value, or null if unset.
valueType:
enum:
- URL
description: The data type of the field value.
required:
- value
- valueType
additionalProperties: false
description: URL of the member's profile image, or null if unset.
$role:
type: object
properties:
value:
type: string
description: The field value.
valueType:
enum:
- TEXT
description: The data type of the field value.
required:
- value
- valueType
additionalProperties: false
description: The member's workspace role.
required:
- $email
- $name
- $profileImage
- $role
additionalProperties: false
description: Map of field names to their typed values.
relationships:
type: object
additionalProperties: false
description: Members do not expose writable or readable relationships in this API.
required:
- id
- createdAt
- updatedAt
- httpLink
- fields
- relationships
ConflictError:
type: object
properties:
type:
const: conflict
message:
type: string
default: Conflict
required:
- type
- message
FullName:
type: object
properties:
firstName:
anyOf:
- type: string
- type: 'null'
description: The contact's first name.
lastName:
anyOf:
- type: string
- type: 'null'
description: The contact's last name.
additionalProperties: false
title: FullName
UnauthorizedError:
type: object
properties:
type:
const: unauthorized
message:
type: string
default: Unauthorized
required:
- type
- message
BadRequestError:
type: object
properties:
type:
const: bad_request
message:
type: string
default: Bad Request
code:
type: string
param:
type: string
required:
- type
- message
- code
ServiceUnavailableError:
type: object
properties:
type:
const: service_unavailable
message:
type: string
default: Service Unavailable
required:
- type
- message
NotFoundError:
type: object
properties:
type:
const: not_found
message:
type: string
default: Not Found
required:
- type
- message
UnprocessableContentError:
type: object
properties:
type:
const: unprocessable_content
message:
type: string
default: Unprocessable Content
required:
- type
- message
securitySchemes:
bearerAuth:
type: http
scheme: bearer