Skip to content
API Reference
/
Notes
/
Create a note

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server

https://docs.bndry.net/_mock/apis/openapi/

https://bndry.app/api/

Documents

Service for managing documents.

Operations

Form Definitions

Service for managing form definitions.

Operations

Forms

Operations

Workspaces

Service for managing workspaces and their associated forms and documents.

Operations

Automations

Service for managing and executing automations.

Operations

Notes

Operations

List notes

Request

Lists notes for entities and workspaces.

Security
oauth2_client_credentials or oauth2_authorization_code
Path
entitystringrequired

The entity id.

Query
parentstring(parent)required

Required. The parent resource name. Format: entities/{entity} or workspaces/{workspace}

pageSizeinteger(int32)(page_size)

Optional. The maximum number of notes to return. The service may return fewer than this value. If unspecified, at most 50 notes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageTokenstring(page_token)

Optional. A page token, received from a previous call. Provide this to retrieve the subsequent page.

skipinteger(int32)(skip)

Optional. The number of resources to skip over before returning resources. Default is 0. See: https://google.aip.dev/158#skipping-results

curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}/notes?parent=string&pageSize=0&pageToken=string&skip=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
notesArray of objects(notes)

The list of notes.

nextPageTokenstring(next_page_token)

A token to retrieve the next page of results, or empty if there are no more results in the list.

totalSizeinteger(int32)(total_size)

The total number of notes matching the request.

Response
application/json
{
  "notes": [
    { … }
  ],
  "nextPageToken": "string",
  "totalSize": 0
}

Create a note

Request

Creates notes for entities and workspaces.

Security
oauth2_client_credentials or oauth2_authorization_code
Path
entitystringrequired

The entity id.

Bodyapplication/json

Required. The note to create.

namestring(name)

(IDENTIFIER) The resource name of the note. Format: entities/{entity}/notes/{note} or workspaces/{workspace}/notes/{note}

contentstring(content)required

The content of the note.

curl -i -X POST \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}/notes' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "content": "string",
    "createTime": "1s",
    "updateTime": "1s"
  }'

Responses

Success

Bodyapplication/json
namestring(name)

(IDENTIFIER) The resource name of the note. Format: entities/{entity}/notes/{note} or workspaces/{workspace}/notes/{note}

contentstring(content)required

The content of the note.

authorIdstring(author_id)read-only

The ID of the user who authored the note.

authorstring(author)read-only

The display name of the author.

createTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The time when the note was created.

updateTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The time when the note was last updated.

isEditedboolean(is_edited)read-only

Output only. Whether the note has been modified since creation.

Response
application/json
{
  "name": "string",
  "content": "string",
  "authorId": "string",
  "author": "string",
  "createTime": "1s",
  "updateTime": "1s",
  "isEdited": true
}

List notes

Request

Lists notes for entities and workspaces.

Security
oauth2_client_credentials or oauth2_authorization_code
Path
workspacestringrequired

The workspace id.

Query
parentstring(parent)required

Required. The parent resource name. Format: entities/{entity} or workspaces/{workspace}

pageSizeinteger(int32)(page_size)

Optional. The maximum number of notes to return. The service may return fewer than this value. If unspecified, at most 50 notes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageTokenstring(page_token)

Optional. A page token, received from a previous call. Provide this to retrieve the subsequent page.

skipinteger(int32)(skip)

Optional. The number of resources to skip over before returning resources. Default is 0. See: https://google.aip.dev/158#skipping-results

curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/workspaces/{workspace}/notes?parent=string&pageSize=0&pageToken=string&skip=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
notesArray of objects(notes)

The list of notes.

nextPageTokenstring(next_page_token)

A token to retrieve the next page of results, or empty if there are no more results in the list.

totalSizeinteger(int32)(total_size)

The total number of notes matching the request.

Response
application/json
{
  "notes": [
    { … }
  ],
  "nextPageToken": "string",
  "totalSize": 0
}

Create a note

Request

Creates notes for entities and workspaces.

Security
oauth2_client_credentials or oauth2_authorization_code
Path
workspacestringrequired

The workspace id.

Bodyapplication/json

Required. The note to create.

namestring(name)

(IDENTIFIER) The resource name of the note. Format: entities/{entity}/notes/{note} or workspaces/{workspace}/notes/{note}

contentstring(content)required

The content of the note.

curl -i -X POST \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/workspaces/{workspace}/notes' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "content": "string",
    "createTime": "1s",
    "updateTime": "1s"
  }'

Responses

Success

Bodyapplication/json
namestring(name)

(IDENTIFIER) The resource name of the note. Format: entities/{entity}/notes/{note} or workspaces/{workspace}/notes/{note}

contentstring(content)required

The content of the note.

authorIdstring(author_id)read-only

The ID of the user who authored the note.

authorstring(author)read-only

The display name of the author.

createTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The time when the note was created.

updateTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The time when the note was last updated.

isEditedboolean(is_edited)read-only

Output only. Whether the note has been modified since creation.

Response
application/json
{
  "name": "string",
  "content": "string",
  "authorId": "string",
  "author": "string",
  "createTime": "1s",
  "updateTime": "1s",
  "isEdited": true
}

Retrieve a note

Request

Retrieves a note.

Security
oauth2_client_credentials or oauth2_authorization_code
Path
entitystringrequired

The entity id.

notestringrequired

The note id.

Query
namestring(name)required

Required. The resource name of the note to retrieve. Format: notes/{note}

curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}/notes/{note}?name=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
namestring(name)

(IDENTIFIER) The resource name of the note. Format: entities/{entity}/notes/{note} or workspaces/{workspace}/notes/{note}

contentstring(content)required

The content of the note.

authorIdstring(author_id)read-only

The ID of the user who authored the note.

authorstring(author)read-only

The display name of the author.

createTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The time when the note was created.

updateTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The time when the note was last updated.

isEditedboolean(is_edited)read-only

Output only. Whether the note has been modified since creation.

Response
application/json
{
  "name": "string",
  "content": "string",
  "authorId": "string",
  "author": "string",
  "createTime": "1s",
  "updateTime": "1s",
  "isEdited": true
}

Delete a note

Request

Deletes a note (only by the author).

Security
oauth2_client_credentials or oauth2_authorization_code
Path
entitystringrequired

The entity id.

notestringrequired

The note id.

Query
namestring(name)required

Required. The resource name of the note to delete. Format: notes/{note}

curl -i -X DELETE \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}/notes/{note}?name=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
namestring(name)

(IDENTIFIER) The resource name of the note. Format: entities/{entity}/notes/{note} or workspaces/{workspace}/notes/{note}

contentstring(content)required

The content of the note.

authorIdstring(author_id)read-only

The ID of the user who authored the note.

authorstring(author)read-only

The display name of the author.

createTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The time when the note was created.

updateTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The time when the note was last updated.

isEditedboolean(is_edited)read-only

Output only. Whether the note has been modified since creation.

Response
application/json
{
  "name": "string",
  "content": "string",
  "authorId": "string",
  "author": "string",
  "createTime": "1s",
  "updateTime": "1s",
  "isEdited": true
}

Update a note

Request

Updates a note (only by the author).

Security
oauth2_client_credentials or oauth2_authorization_code
Path
entitystringrequired

The entity id.

notestringrequired

The note id.

Bodyapplication/json

Required. The note to update. The note's name field is used to identify the note to update. Format: notes/{note}

namestring(name)

(IDENTIFIER) The resource name of the note. Format: entities/{entity}/notes/{note} or workspaces/{workspace}/notes/{note}

contentstring(content)required

The content of the note.

curl -i -X PATCH \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}/notes/{note}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "content": "string",
    "createTime": "1s",
    "updateTime": "1s"
  }'

Responses

Success

Bodyapplication/json
namestring(name)

(IDENTIFIER) The resource name of the note. Format: entities/{entity}/notes/{note} or workspaces/{workspace}/notes/{note}

contentstring(content)required

The content of the note.

authorIdstring(author_id)read-only

The ID of the user who authored the note.

authorstring(author)read-only

The display name of the author.

createTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The time when the note was created.

updateTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The time when the note was last updated.

isEditedboolean(is_edited)read-only

Output only. Whether the note has been modified since creation.

Response
application/json
{
  "name": "string",
  "content": "string",
  "authorId": "string",
  "author": "string",
  "createTime": "1s",
  "updateTime": "1s",
  "isEdited": true
}

Retrieve a note

Request

Retrieves a note.

Security
oauth2_client_credentials or oauth2_authorization_code
Path
workspacestringrequired

The workspace id.

notestringrequired

The note id.

Query
namestring(name)required

Required. The resource name of the note to retrieve. Format: notes/{note}

curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/workspaces/{workspace}/notes/{note}?name=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
namestring(name)

(IDENTIFIER) The resource name of the note. Format: entities/{entity}/notes/{note} or workspaces/{workspace}/notes/{note}

contentstring(content)required

The content of the note.

authorIdstring(author_id)read-only

The ID of the user who authored the note.

authorstring(author)read-only

The display name of the author.

createTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The time when the note was created.

updateTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The time when the note was last updated.

isEditedboolean(is_edited)read-only

Output only. Whether the note has been modified since creation.

Response
application/json
{
  "name": "string",
  "content": "string",
  "authorId": "string",
  "author": "string",
  "createTime": "1s",
  "updateTime": "1s",
  "isEdited": true
}

Delete a note

Request

Deletes a note (only by the author).

Security
oauth2_client_credentials or oauth2_authorization_code
Path
workspacestringrequired

The workspace id.

notestringrequired

The note id.

Query
namestring(name)required

Required. The resource name of the note to delete. Format: notes/{note}

curl -i -X DELETE \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/workspaces/{workspace}/notes/{note}?name=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
namestring(name)

(IDENTIFIER) The resource name of the note. Format: entities/{entity}/notes/{note} or workspaces/{workspace}/notes/{note}

contentstring(content)required

The content of the note.

authorIdstring(author_id)read-only

The ID of the user who authored the note.

authorstring(author)read-only

The display name of the author.

createTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The time when the note was created.

updateTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The time when the note was last updated.

isEditedboolean(is_edited)read-only

Output only. Whether the note has been modified since creation.

Response
application/json
{
  "name": "string",
  "content": "string",
  "authorId": "string",
  "author": "string",
  "createTime": "1s",
  "updateTime": "1s",
  "isEdited": true
}

Update a note

Request

Updates a note (only by the author).

Security
oauth2_client_credentials or oauth2_authorization_code
Path
workspacestringrequired

The workspace id.

notestringrequired

The note id.

Bodyapplication/json

Required. The note to update. The note's name field is used to identify the note to update. Format: notes/{note}

namestring(name)

(IDENTIFIER) The resource name of the note. Format: entities/{entity}/notes/{note} or workspaces/{workspace}/notes/{note}

contentstring(content)required

The content of the note.

curl -i -X PATCH \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/workspaces/{workspace}/notes/{note}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "content": "string",
    "createTime": "1s",
    "updateTime": "1s"
  }'

Responses

Success

Bodyapplication/json
namestring(name)

(IDENTIFIER) The resource name of the note. Format: entities/{entity}/notes/{note} or workspaces/{workspace}/notes/{note}

contentstring(content)required

The content of the note.

authorIdstring(author_id)read-only

The ID of the user who authored the note.

authorstring(author)read-only

The display name of the author.

createTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The time when the note was created.

updateTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The time when the note was last updated.

isEditedboolean(is_edited)read-only

Output only. Whether the note has been modified since creation.

Response
application/json
{
  "name": "string",
  "content": "string",
  "authorId": "string",
  "author": "string",
  "createTime": "1s",
  "updateTime": "1s",
  "isEdited": true
}

Tenants

Service for managing tenants.

Operations

Entities

Operations

Individual Entity Onboarding

Service for managing individual entity onboarding jobs.

Operations

Truuth

TruuthService provides an API for the BNDRY SPA to initiate a new verification session with Truuth

Operations