Lightfield Notes API
The Notes API from Lightfield — 2 operation(s) for notes.
OpenAPI Specification
openapi: 3.1.1
info:
title: API Reference Accounts Notes API
version: 0.0.0
tags:
- name: Notes
paths:
/v1/notes:
post:
operationId: note.create
summary: Create a note
description: 'Creates a new note record.
The note author is automatically set to the API key owner.
Supports idempotency via the `Idempotency-Key` header.
**[Required scope](/using-the-api/scopes/):** `notes:create`
**[Rate limit category](/using-the-api/rate-limits/):** Write'
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'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
fields:
type: object
properties:
$title:
type: string
description: Title of the note.
$content:
anyOf:
- type: string
- type: 'null'
description: Content of the note as markdown formatted text.
required:
- $title
additionalProperties: false
description: Field values for the new note. `$title` is required; `$content` is optional. See **[Fields and relationships](/using-the-api/fields-and-relationships/)** for value type details.
relationships:
type: object
properties:
$account:
anyOf:
- type: string
- type: array
items:
type: string
description: ID(s) of accounts to associate with this note.
$opportunity:
anyOf:
- type: string
- type: array
items:
type: string
description: ID(s) of opportunities to associate with this note.
additionalProperties: false
description: Relationships to set on the new note. System relationships use a `$` prefix (e.g. `$account`, `$opportunity`). Each value is a single entity ID or an array of IDs. The note author is automatically set to the API key owner.
required:
- fields
additionalProperties: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/NoteCreateResponse'
'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:
- Notes
get:
operationId: note.list
summary: List notes
description: 'Returns a paginated list of notes. 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/):** `notes: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: 25
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/NoteListResponse'
'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:
- Notes
/v1/notes/{id}:
post:
operationId: note.update
summary: Update a note
description: 'Updates an existing note by ID. Only included fields and relationships are modified.
Both `$account` and `$opportunity` relationships can be modified via `add` or `remove` operations.
Supports idempotency via the `Idempotency-Key` header.
**[Required scope](/using-the-api/scopes/):** `notes:update`
**[Rate limit category](/using-the-api/rate-limits/):** Write'
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 note to update.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
fields:
type: object
properties:
$title:
anyOf:
- type: string
- type: 'null'
description: Title of the note.
$content:
anyOf:
- type: string
- type: 'null'
description: Content of the note as markdown formatted text.
additionalProperties: false
description: Field values to update — only provided fields are modified; omitted fields are left unchanged. See **[Fields and relationships](/using-the-api/fields-and-relationships/)** for value type details.
relationships:
type: object
properties:
$account:
anyOf:
- type: object
properties:
add:
anyOf:
- type: string
- type: array
items:
type: string
description: Entity ID(s) to add to the relationship.
required:
- add
additionalProperties: false
- type: object
properties:
remove:
anyOf:
- type: string
- type: array
items:
type: string
description: Entity ID(s) to remove from the relationship.
required:
- remove
additionalProperties: false
description: Operation to modify associated accounts.
$opportunity:
anyOf:
- type: object
properties:
add:
anyOf:
- type: string
- type: array
items:
type: string
description: Entity ID(s) to add to the relationship.
required:
- add
additionalProperties: false
- type: object
properties:
remove:
anyOf:
- type: string
- type: array
items:
type: string
description: Entity ID(s) to remove from the relationship.
required:
- remove
additionalProperties: false
description: Operation to modify associated opportunities.
additionalProperties: false
description: Relationship operations to apply. System relationships use a `$` prefix (e.g. `$account`, `$opportunity`). Each value is an operation object with `add` or `remove`.
additionalProperties: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/NoteUpdateResponse'
'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:
- Notes
get:
operationId: note.retrieve
summary: Retrieve a note
description: 'Retrieves a single note by its ID.
**[Required scope](/using-the-api/scopes/):** `notes: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 note to retrieve.
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/NoteRetrieveResponse'
'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:
- Notes
components:
schemas:
NoteCreateResponse:
type: object
properties:
id:
type: string
description: Unique identifier for the entity.
createdAt:
type: string
description: ISO 8601 timestamp of when the entity was created.
updatedAt:
anyOf:
- type: string
- type: 'null'
description: ISO 8601 timestamp of when the entity was last updated, or null.
httpLink:
anyOf:
- type: string
- type: 'null'
description: URL to view the entity in the Lightfield web app, or null.
externalId:
anyOf:
- type: string
- type: 'null'
description: External identifier for the entity, or null if unset.
fields:
type: object
propertyNames:
type: string
additionalProperties:
type: object
properties:
valueType:
enum:
- ADDRESS
- CHECKBOX
- CURRENCY
- DATETIME
- EMAIL
- FULL_NAME
- MARKDOWN
- MULTI_SELECT
- NUMBER
- SINGLE_SELECT
- SOCIAL_HANDLE
- TELEPHONE
- TEXT
- URL
- HTML
description: The data type of the field.
value:
anyOf:
- type: string
- type: integer
minimum: -9007199254740991
maximum: 9007199254740991
- type: number
- type: boolean
- type: 'null'
- type: array
items:
type: string
- $ref: '#/components/schemas/Address'
- $ref: '#/components/schemas/FullName'
description: The field value, or null if unset.
required:
- valueType
- value
description: Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug.
relationships:
type: object
propertyNames:
type: string
additionalProperties:
type: object
properties:
cardinality:
type: string
description: Whether the relationship is `has_one` or `has_many`.
objectType:
type: string
description: The type of the related object (e.g. `account`, `contact`).
values:
type: array
items:
type: string
description: IDs of the related entities.
required:
- cardinality
- objectType
- values
description: Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`).
required:
- id
- createdAt
- updatedAt
- httpLink
- fields
- relationships
additionalProperties: false
InternalServerError:
type: object
properties:
type:
const: internal_server_error
message:
type: string
default: Internal Server Error
required:
- type
- message
NoteUpdateResponse:
type: object
properties:
id:
type: string
description: Unique identifier for the entity.
createdAt:
type: string
description: ISO 8601 timestamp of when the entity was created.
updatedAt:
anyOf:
- type: string
- type: 'null'
description: ISO 8601 timestamp of when the entity was last updated, or null.
httpLink:
anyOf:
- type: string
- type: 'null'
description: URL to view the entity in the Lightfield web app, or null.
externalId:
anyOf:
- type: string
- type: 'null'
description: External identifier for the entity, or null if unset.
fields:
type: object
propertyNames:
type: string
additionalProperties:
type: object
properties:
valueType:
enum:
- ADDRESS
- CHECKBOX
- CURRENCY
- DATETIME
- EMAIL
- FULL_NAME
- MARKDOWN
- MULTI_SELECT
- NUMBER
- SINGLE_SELECT
- SOCIAL_HANDLE
- TELEPHONE
- TEXT
- URL
- HTML
description: The data type of the field.
value:
anyOf:
- type: string
- type: integer
minimum: -9007199254740991
maximum: 9007199254740991
- type: number
- type: boolean
- type: 'null'
- type: array
items:
type: string
- $ref: '#/components/schemas/Address'
- $ref: '#/components/schemas/FullName'
description: The field value, or null if unset.
required:
- valueType
- value
description: Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug.
relationships:
type: object
propertyNames:
type: string
additionalProperties:
type: object
properties:
cardinality:
type: string
description: Whether the relationship is `has_one` or `has_many`.
objectType:
type: string
description: The type of the related object (e.g. `account`, `contact`).
values:
type: array
items:
type: string
description: IDs of the related entities.
required:
- cardinality
- objectType
- values
description: Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`).
required:
- id
- createdAt
- updatedAt
- httpLink
- fields
- relationships
additionalProperties: false
GatewayTimeoutError:
type: object
properties:
type:
const: gateway_timeout
message:
type: string
default: Gateway Timeout
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
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
ConflictError:
type: object
properties:
type:
const: conflict
message:
type: string
default: Conflict
required:
- type
- message
ForbiddenError:
type: object
properties:
type:
const: forbidden
message:
type: string
default: Forbidden
required:
- type
- message
UnauthorizedError:
type: object
properties:
type:
const: unauthorized
message:
type: string
default: Unauthorized
required:
- type
- message
NoteListResponse:
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 entity.
createdAt:
type: string
description: ISO 8601 timestamp of when the entity was created.
updatedAt:
anyOf:
- type: string
- type: 'null'
description: ISO 8601 timestamp of when the entity was last updated, or null.
httpLink:
anyOf:
- type: string
- type: 'null'
description: URL to view the entity in the Lightfield web app, or null.
externalId:
anyOf:
- type: string
- type: 'null'
description: External identifier for the entity, or null if unset.
fields:
type: object
propertyNames:
type: string
additionalProperties:
type: object
properties:
valueType:
enum:
- ADDRESS
- CHECKBOX
- CURRENCY
- DATETIME
- EMAIL
- FULL_NAME
- MARKDOWN
- MULTI_SELECT
- NUMBER
- SINGLE_SELECT
- SOCIAL_HANDLE
- TELEPHONE
- TEXT
- URL
- HTML
description: The data type of the field.
value:
anyOf:
- type: string
- type: integer
minimum: -9007199254740991
maximum: 9007199254740991
- type: number
- type: boolean
- type: 'null'
- type: array
items:
type: string
- $ref: '#/components/schemas/Address'
- $ref: '#/components/schemas/FullName'
description: The field value, or null if unset.
required:
- valueType
- value
description: Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug.
relationships:
type: object
propertyNames:
type: string
additionalProperties:
type: object
properties:
cardinality:
type: string
description: Whether the relationship is `has_one` or `has_many`.
objectType:
type: string
description: The type of the related object (e.g. `account`, `contact`).
values:
type: array
items:
type: string
description: IDs of the related entities.
required:
- cardinality
- objectType
- values
description: Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`).
required:
- id
- createdAt
- updatedAt
- httpLink
- fields
- relationships
additionalProperties: false
description: Array of entity objects for the current page.
totalCount:
type: integer
minimum: 0
maximum: 9007199254740991
description: Total number of entities matching the query.
required:
- object
- data
- totalCount
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
NoteRetrieveResponse:
type: object
properties:
id:
type: string
description: Unique identifier for the entity.
createdAt:
type: string
description: ISO 8601 timestamp of when the entity was created.
updatedAt:
anyOf:
- type: string
- type: 'null'
description: ISO 8601 timestamp of when the entity was last updated, or null.
httpLink:
anyOf:
- type: string
- type: 'null'
description: URL to view the entity in the Lightfield web app, or null.
externalId:
anyOf:
- type: string
- type: 'null'
description: External identifier for the entity, or null if unset.
fields:
type: object
propertyNames:
type: string
# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lightfield/refs/heads/main/openapi/lightfield-notes-api-openapi.yml