European Client Register API (1.0.0)

Download OpenAPI specification:Download

Open Register: info@openregister.dev URL: https://openregister.dev License: EUPL-1.2

API for managing clients, tasks, messages, notes, products, services, and orders based on European standards

clients

Client information based on EU Core Vocabularies, Schema.org Person/Organization and vCard

tasks

Tasks based on iCalendar VTODO and Schema.org PlanAction

messages

Client communication messages based on RFC 5322, JMAP, and Schema.org Message

notes

Notes about clients based on Schema.org Comment and UBL Note

products

Products based on UBL Item and Schema.org Product

services

Services based on CPSV and Schema.org Service

orders

Orders based on UBL Order and Schema.org Order

orderItems

Order items based on UBL OrderLine and Schema.org OrderItem

Client

Retrieve a list of Client

Authorizations:

oauth2

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"@type": "Person",
"name": "John Smith",
"givenName": "John",
"familyName": "Smith",
"additionalName": "Robert",
"honorificPrefix": "Dr.",
"honorificSuffix": "Jr.",
"jobTitle": "Director",
"worksFor": "Acme, Inc.",
"department": "Marketing",
"image": "https://example.com/photos/john-smith.jpg",
"telephone": [{"value": "+1-555-123-4567",
"type": "work"
}
],
"email": [{"value": "john.smith@example.com",
"type": "work"
}
],
"address": [{"streetAddress": "123 Main St",
"addressLocality": "Anytown",
"addressRegion": "CA",
"postalCode": "12345",
"addressCountry": "US",
"type": "work"
}
],
"url": [{"value": "https://example.com",
"type": "work"
}
],
"birthDate": "1980-01-15",
"note": "Prefers to be contacted by email.",
"dateCreated": "2019-08-24T14:15:22Z",
"dateModified": "2019-08-24T14:15:22Z"
}
]

Create a new Client

Authorizations:

oauth2

Request Body schema: application/json
required

id required	string <uuid> Unique identifier for the client
@type required	string Enum: "Person" "Organization" Schema.org type of the client
name required	string Full name of the client (Schema.org name, vCard FN)
givenName	string First name (Schema.org givenName, part of vCard N)
familyName	string Last name (Schema.org familyName, part of vCard N)
additionalName	string Middle name (Schema.org additionalName, part of vCard N)
honorificPrefix	string Title prefix (Schema.org honorificPrefix, part of vCard N)
honorificSuffix	string Title suffix (Schema.org honorificSuffix, part of vCard N)
jobTitle	string Job title (Schema.org jobTitle, vCard TITLE)
worksFor	string Organization the person works for (Schema.org worksFor, vCard ORG)
department	string Department within organization (part of vCard ORG)
image	string <uri> URL to client photo/avatar (Schema.org image, vCard PHOTO)
	Array of objects Phone numbers (Schema.org telephone, vCard TEL)
	Array of objects Email addresses (Schema.org email, vCard EMAIL)
	Array of objects Addresses (Schema.org address, vCard ADR)
	Array of objects Websites (Schema.org url, vCard URL)
birthDate	string <date> Date of birth (Schema.org birthDate, vCard BDAY)
note	string General notes about the client (Schema.org description, vCard NOTE)
dateCreated	string <date-time> When the client record was created (Schema.org dateCreated)
dateModified	string <date-time> When the client record was last updated (Schema.org dateModified)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"@type": "Person",
"name": "John Smith",
"givenName": "John",
"familyName": "Smith",
"additionalName": "Robert",
"honorificPrefix": "Dr.",
"honorificSuffix": "Jr.",
"jobTitle": "Director",
"worksFor": "Acme, Inc.",
"department": "Marketing",
"image": "https://example.com/photos/john-smith.jpg",
"telephone": [{"value": "+1-555-123-4567",
"type": "work"
}
],
"email": [{"value": "john.smith@example.com",
"type": "work"
}
],
"address": [{"streetAddress": "123 Main St",
"addressLocality": "Anytown",
"addressRegion": "CA",
"postalCode": "12345",
"addressCountry": "US",
"type": "work"
}
],
"url": [{"value": "https://example.com",
"type": "work"
}
],
"birthDate": "1980-01-15",
"note": "Prefers to be contacted by email.",
"dateCreated": "2019-08-24T14:15:22Z",
"dateModified": "2019-08-24T14:15:22Z"
}

Retrieve a Client by ID

Authorizations:

oauth2

path Parameters

id

required

string <uuid>

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"@type": "Person",
"name": "John Smith",
"givenName": "John",
"familyName": "Smith",
"additionalName": "Robert",
"honorificPrefix": "Dr.",
"honorificSuffix": "Jr.",
"jobTitle": "Director",
"worksFor": "Acme, Inc.",
"department": "Marketing",
"image": "https://example.com/photos/john-smith.jpg",
"telephone": [{"value": "+1-555-123-4567",
"type": "work"
}
],
"email": [{"value": "john.smith@example.com",
"type": "work"
}
],
"address": [{"streetAddress": "123 Main St",
"addressLocality": "Anytown",
"addressRegion": "CA",
"postalCode": "12345",
"addressCountry": "US",
"type": "work"
}
],
"url": [{"value": "https://example.com",
"type": "work"
}
],
"birthDate": "1980-01-15",
"note": "Prefers to be contacted by email.",
"dateCreated": "2019-08-24T14:15:22Z",
"dateModified": "2019-08-24T14:15:22Z"
}

Update a Client by ID

Authorizations:

oauth2

path Parameters

id

required

string <uuid>

Request Body schema: application/json
required

id required	string <uuid> Unique identifier for the client
@type required	string Enum: "Person" "Organization" Schema.org type of the client
name required	string Full name of the client (Schema.org name, vCard FN)
givenName	string First name (Schema.org givenName, part of vCard N)
familyName	string Last name (Schema.org familyName, part of vCard N)
additionalName	string Middle name (Schema.org additionalName, part of vCard N)
honorificPrefix	string Title prefix (Schema.org honorificPrefix, part of vCard N)
honorificSuffix	string Title suffix (Schema.org honorificSuffix, part of vCard N)
jobTitle	string Job title (Schema.org jobTitle, vCard TITLE)
worksFor	string Organization the person works for (Schema.org worksFor, vCard ORG)
department	string Department within organization (part of vCard ORG)
image	string <uri> URL to client photo/avatar (Schema.org image, vCard PHOTO)
	Array of objects Phone numbers (Schema.org telephone, vCard TEL)
	Array of objects Email addresses (Schema.org email, vCard EMAIL)
	Array of objects Addresses (Schema.org address, vCard ADR)
	Array of objects Websites (Schema.org url, vCard URL)
birthDate	string <date> Date of birth (Schema.org birthDate, vCard BDAY)
note	string General notes about the client (Schema.org description, vCard NOTE)
dateCreated	string <date-time> When the client record was created (Schema.org dateCreated)
dateModified	string <date-time> When the client record was last updated (Schema.org dateModified)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"@type": "Person",
"name": "John Smith",
"givenName": "John",
"familyName": "Smith",
"additionalName": "Robert",
"honorificPrefix": "Dr.",
"honorificSuffix": "Jr.",
"jobTitle": "Director",
"worksFor": "Acme, Inc.",
"department": "Marketing",
"image": "https://example.com/photos/john-smith.jpg",
"telephone": [{"value": "+1-555-123-4567",
"type": "work"
}
],
"email": [{"value": "john.smith@example.com",
"type": "work"
}
],
"address": [{"streetAddress": "123 Main St",
"addressLocality": "Anytown",
"addressRegion": "CA",
"postalCode": "12345",
"addressCountry": "US",
"type": "work"
}
],
"url": [{"value": "https://example.com",
"type": "work"
}
],
"birthDate": "1980-01-15",
"note": "Prefers to be contacted by email.",
"dateCreated": "2019-08-24T14:15:22Z",
"dateModified": "2019-08-24T14:15:22Z"
}

Delete a Client by ID

Authorizations:

oauth2

path Parameters

id

required

string <uuid>

Responses

Task

Retrieve a list of Task

Authorizations:

oauth2

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"@type": "PlanAction",
"name": "Prepare client proposal",
"description": "Create a detailed proposal for the new website project including timeline and budget.",
"startDate": "2023-06-15T09:00:00Z",
"endDate": "2023-06-20T17:00:00Z",
"completedDate": "2023-06-19T16:30:00Z",
"actionStatus": "ActiveActionStatus",
"priority": 2,
"percentComplete": 75,
"category": ["proposal",
"client",
"website"
],
"agent": {"id": "user-123",
"name": "Jane Doe"
},
"participant": [{"id": "user-456",
"name": "John Smith",
"role": "reviewer"
}
],
"recurrenceRule": "FREQ=WEEKLY;BYDAY=MO,WE,FR",
"clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
"dateCreated": "2019-08-24T14:15:22Z",
"dateModified": "2019-08-24T14:15:22Z"
}
]

Create a new Task

Authorizations:

oauth2

Request Body schema: application/json
required

id required	string <uuid> Unique identifier for the task
@type	string Default: "PlanAction" Schema.org type
name required	string Task name/summary (Schema.org name, iCal SUMMARY)
description	string Task description (Schema.org description, iCal DESCRIPTION)
startDate	string <date-time> Start date/time (Schema.org startTime, iCal DTSTART)
endDate	string <date-time> Due date/time (Schema.org endTime, iCal DUE)
completedDate	string <date-time> Completion date/time (Schema.org endTime, iCal COMPLETED)
actionStatus required	string Enum: "PotentialActionStatus" "ActiveActionStatus" "CompletedActionStatus" "FailedActionStatus" "CanceledActionStatus" Task status (Schema.org actionStatus, iCal STATUS)
priority	integer [ 0 .. 9 ] Priority (0-9, 0=undefined, 1=highest, 9=lowest) (iCal PRIORITY)
percentComplete	integer [ 0 .. 100 ] Percent complete (0-100) (iCal PERCENT-COMPLETE)
category	Array of strings Categories/tags (Schema.org category, iCal CATEGORIES)
	object Person assigned to the task (Schema.org agent, iCal ORGANIZER)
	Array of objects Other participants (Schema.org participant, iCal ATTENDEE)
recurrenceRule	string Recurrence rule (iCal RRULE)
clientId required	string <uuid> ID of the client this task is associated with
dateCreated	string <date-time> When the task record was created (Schema.org dateCreated, iCal CREATED)
dateModified	string <date-time> When the task record was last updated (Schema.org dateModified, iCal LAST-MODIFIED)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"@type": "PlanAction",
"name": "Prepare client proposal",
"description": "Create a detailed proposal for the new website project including timeline and budget.",
"startDate": "2023-06-15T09:00:00Z",
"endDate": "2023-06-20T17:00:00Z",
"completedDate": "2023-06-19T16:30:00Z",
"actionStatus": "ActiveActionStatus",
"priority": 2,
"percentComplete": 75,
"category": ["proposal",
"client",
"website"
],
"agent": {"id": "user-123",
"name": "Jane Doe"
},
"participant": [{"id": "user-456",
"name": "John Smith",
"role": "reviewer"
}
],
"recurrenceRule": "FREQ=WEEKLY;BYDAY=MO,WE,FR",
"clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
"dateCreated": "2019-08-24T14:15:22Z",
"dateModified": "2019-08-24T14:15:22Z"
}

Retrieve a Task by ID

Authorizations:

oauth2

path Parameters

id

required

string <uuid>

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"@type": "PlanAction",
"name": "Prepare client proposal",
"description": "Create a detailed proposal for the new website project including timeline and budget.",
"startDate": "2023-06-15T09:00:00Z",
"endDate": "2023-06-20T17:00:00Z",
"completedDate": "2023-06-19T16:30:00Z",
"actionStatus": "ActiveActionStatus",
"priority": 2,
"percentComplete": 75,
"category": ["proposal",
"client",
"website"
],
"agent": {"id": "user-123",
"name": "Jane Doe"
},
"participant": [{"id": "user-456",
"name": "John Smith",
"role": "reviewer"
}
],
"recurrenceRule": "FREQ=WEEKLY;BYDAY=MO,WE,FR",
"clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
"dateCreated": "2019-08-24T14:15:22Z",
"dateModified": "2019-08-24T14:15:22Z"
}

Update a Task by ID

Authorizations:

oauth2

path Parameters

id

required

string <uuid>

Request Body schema: application/json
required

id required	string <uuid> Unique identifier for the task
@type	string Default: "PlanAction" Schema.org type
name required	string Task name/summary (Schema.org name, iCal SUMMARY)
description	string Task description (Schema.org description, iCal DESCRIPTION)
startDate	string <date-time> Start date/time (Schema.org startTime, iCal DTSTART)
endDate	string <date-time> Due date/time (Schema.org endTime, iCal DUE)
completedDate	string <date-time> Completion date/time (Schema.org endTime, iCal COMPLETED)
actionStatus required	string Enum: "PotentialActionStatus" "ActiveActionStatus" "CompletedActionStatus" "FailedActionStatus" "CanceledActionStatus" Task status (Schema.org actionStatus, iCal STATUS)
priority	integer [ 0 .. 9 ] Priority (0-9, 0=undefined, 1=highest, 9=lowest) (iCal PRIORITY)
percentComplete	integer [ 0 .. 100 ] Percent complete (0-100) (iCal PERCENT-COMPLETE)
category	Array of strings Categories/tags (Schema.org category, iCal CATEGORIES)
	object Person assigned to the task (Schema.org agent, iCal ORGANIZER)
	Array of objects Other participants (Schema.org participant, iCal ATTENDEE)
recurrenceRule	string Recurrence rule (iCal RRULE)
clientId required	string <uuid> ID of the client this task is associated with
dateCreated	string <date-time> When the task record was created (Schema.org dateCreated, iCal CREATED)
dateModified	string <date-time> When the task record was last updated (Schema.org dateModified, iCal LAST-MODIFIED)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"@type": "PlanAction",
"name": "Prepare client proposal",
"description": "Create a detailed proposal for the new website project including timeline and budget.",
"startDate": "2023-06-15T09:00:00Z",
"endDate": "2023-06-20T17:00:00Z",
"completedDate": "2023-06-19T16:30:00Z",
"actionStatus": "ActiveActionStatus",
"priority": 2,
"percentComplete": 75,
"category": ["proposal",
"client",
"website"
],
"agent": {"id": "user-123",
"name": "Jane Doe"
},
"participant": [{"id": "user-456",
"name": "John Smith",
"role": "reviewer"
}
],
"recurrenceRule": "FREQ=WEEKLY;BYDAY=MO,WE,FR",
"clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
"dateCreated": "2019-08-24T14:15:22Z",
"dateModified": "2019-08-24T14:15:22Z"
}

Delete a Task by ID

Authorizations:

oauth2

path Parameters

id

required

string <uuid>

Responses

Message

Retrieve a list of Message

Authorizations:

oauth2

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"@type": "Message",
"about": "Website Project Proposal",
"text": "Dear John,\n\nAttached is the proposal for your website project. Please review and let me know if you have any questions.\n\nBest regards,\nJane",
"sender": {"name": "Jane Doe",
"email": "jane.doe@example.com"
},
"recipient": [{"name": "John Smith",
"email": "john.smith@example.com"
}
],
"ccRecipient": [{"name": "Alice Brown",
"email": "alice.brown@example.com"
}
],
"bccRecipient": [{"name": "Bob Green",
"email": "bob.green@example.com"
}
],
"dateSent": "2023-06-10T14:30:00Z",
"dateReceived": "2023-06-10T14:31:05Z",
"dateRead": "2023-06-10T15:45:22Z",
"attachment": [{"name": "proposal.pdf",
"contentUrl": "https://example.com/files/proposal.pdf",
"encodingFormat": "application/pdf",
"contentSize": "2.4 MB"
}
],
"messageId": "<1234567890@mail.example.com>",
"inReplyTo": "<0987654321@mail.example.com>",
"references": ["<0987654321@mail.example.com>",
"<5678901234@mail.example.com>"
],
"channel": "email",
"direction": "outbound",
"status": "delivered",
"clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
"dateCreated": "2019-08-24T14:15:22Z",
"dateModified": "2019-08-24T14:15:22Z"
}
]

Create a new Message

Authorizations:

oauth2

Request Body schema: application/json
required

id required	string <uuid> Unique identifier for the message
@type	string Default: "Message" Schema.org type
about required	string Message subject (Schema.org about, email Subject)
text required	string Message content (Schema.org text, email Body)
required	object Sender information (Schema.org sender, email From)
required	Array of objects Recipients (Schema.org recipient, email To)
	Array of objects CC recipients (email Cc)
	Array of objects BCC recipients (email Bcc)
dateSent	string <date-time> When message was sent (Schema.org dateSent, email Date)
dateReceived	string <date-time> When message was received (Schema.org dateReceived, email Received)
dateRead	string <date-time> When message was read (custom extension)
	Array of objects File attachments (Schema.org attachment, email Attachments)
messageId	string Unique message identifier (email Message-ID)
inReplyTo	string Message this is a reply to (email In-Reply-To)
references	Array of strings Thread references (email References)
channel required	string Enum: "email" "sms" "chat" "phone" "video" "social" Communication channel (custom extension)
direction required	string Enum: "inbound" "outbound" Message direction (custom extension)
status	string Enum: "draft" "sending" "sent" "delivered" "read" "failed" Delivery status (custom extension)
clientId required	string <uuid> ID of the client this message is associated with
dateCreated	string <date-time> When the message record was created (Schema.org dateCreated)
dateModified	string <date-time> When the message record was last updated (Schema.org dateModified)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"@type": "Message",
"about": "Website Project Proposal",
"text": "Dear John,\n\nAttached is the proposal for your website project. Please review and let me know if you have any questions.\n\nBest regards,\nJane",
"sender": {"name": "Jane Doe",
"email": "jane.doe@example.com"
},
"recipient": [{"name": "John Smith",
"email": "john.smith@example.com"
}
],
"ccRecipient": [{"name": "Alice Brown",
"email": "alice.brown@example.com"
}
],
"bccRecipient": [{"name": "Bob Green",
"email": "bob.green@example.com"
}
],
"dateSent": "2023-06-10T14:30:00Z",
"dateReceived": "2023-06-10T14:31:05Z",
"dateRead": "2023-06-10T15:45:22Z",
"attachment": [{"name": "proposal.pdf",
"contentUrl": "https://example.com/files/proposal.pdf",
"encodingFormat": "application/pdf",
"contentSize": "2.4 MB"
}
],
"messageId": "<1234567890@mail.example.com>",
"inReplyTo": "<0987654321@mail.example.com>",
"references": ["<0987654321@mail.example.com>",
"<5678901234@mail.example.com>"
],
"channel": "email",
"direction": "outbound",
"status": "delivered",
"clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
"dateCreated": "2019-08-24T14:15:22Z",
"dateModified": "2019-08-24T14:15:22Z"
}

Retrieve a Message by ID

Authorizations:

oauth2

path Parameters

id

required

string <uuid>

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"@type": "Message",
"about": "Website Project Proposal",
"text": "Dear John,\n\nAttached is the proposal for your website project. Please review and let me know if you have any questions.\n\nBest regards,\nJane",
"sender": {"name": "Jane Doe",
"email": "jane.doe@example.com"
},
"recipient": [{"name": "John Smith",
"email": "john.smith@example.com"
}
],
"ccRecipient": [{"name": "Alice Brown",
"email": "alice.brown@example.com"
}
],
"bccRecipient": [{"name": "Bob Green",
"email": "bob.green@example.com"
}
],
"dateSent": "2023-06-10T14:30:00Z",
"dateReceived": "2023-06-10T14:31:05Z",
"dateRead": "2023-06-10T15:45:22Z",
"attachment": [{"name": "proposal.pdf",
"contentUrl": "https://example.com/files/proposal.pdf",
"encodingFormat": "application/pdf",
"contentSize": "2.4 MB"
}
],
"messageId": "<1234567890@mail.example.com>",
"inReplyTo": "<0987654321@mail.example.com>",
"references": ["<0987654321@mail.example.com>",
"<5678901234@mail.example.com>"
],
"channel": "email",
"direction": "outbound",
"status": "delivered",
"clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
"dateCreated": "2019-08-24T14:15:22Z",
"dateModified": "2019-08-24T14:15:22Z"
}

Update a Message by ID

Authorizations:

oauth2

path Parameters

id

required

string <uuid>

Request Body schema: application/json
required

id required	string <uuid> Unique identifier for the message
@type	string Default: "Message" Schema.org type
about required	string Message subject (Schema.org about, email Subject)
text required	string Message content (Schema.org text, email Body)
required	object Sender information (Schema.org sender, email From)
required	Array of objects Recipients (Schema.org recipient, email To)
	Array of objects CC recipients (email Cc)
	Array of objects BCC recipients (email Bcc)
dateSent	string <date-time> When message was sent (Schema.org dateSent, email Date)
dateReceived	string <date-time> When message was received (Schema.org dateReceived, email Received)
dateRead	string <date-time> When message was read (custom extension)
	Array of objects File attachments (Schema.org attachment, email Attachments)
messageId	string Unique message identifier (email Message-ID)
inReplyTo	string Message this is a reply to (email In-Reply-To)
references	Array of strings Thread references (email References)
channel required	string Enum: "email" "sms" "chat" "phone" "video" "social" Communication channel (custom extension)
direction required	string Enum: "inbound" "outbound" Message direction (custom extension)
status	string Enum: "draft" "sending" "sent" "delivered" "read" "failed" Delivery status (custom extension)
clientId required	string <uuid> ID of the client this message is associated with
dateCreated	string <date-time> When the message record was created (Schema.org dateCreated)
dateModified	string <date-time> When the message record was last updated (Schema.org dateModified)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"@type": "Message",
"about": "Website Project Proposal",
"text": "Dear John,\n\nAttached is the proposal for your website project. Please review and let me know if you have any questions.\n\nBest regards,\nJane",
"sender": {"name": "Jane Doe",
"email": "jane.doe@example.com"
},
"recipient": [{"name": "John Smith",
"email": "john.smith@example.com"
}
],
"ccRecipient": [{"name": "Alice Brown",
"email": "alice.brown@example.com"
}
],
"bccRecipient": [{"name": "Bob Green",
"email": "bob.green@example.com"
}
],
"dateSent": "2023-06-10T14:30:00Z",
"dateReceived": "2023-06-10T14:31:05Z",
"dateRead": "2023-06-10T15:45:22Z",
"attachment": [{"name": "proposal.pdf",
"contentUrl": "https://example.com/files/proposal.pdf",
"encodingFormat": "application/pdf",
"contentSize": "2.4 MB"
}
],
"messageId": "<1234567890@mail.example.com>",
"inReplyTo": "<0987654321@mail.example.com>",
"references": ["<0987654321@mail.example.com>",
"<5678901234@mail.example.com>"
],
"channel": "email",
"direction": "outbound",
"status": "delivered",
"clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
"dateCreated": "2019-08-24T14:15:22Z",
"dateModified": "2019-08-24T14:15:22Z"
}

Delete a Message by ID

Authorizations:

oauth2

path Parameters

id

required

string <uuid>

Responses

Note

Retrieve a list of Note

Authorizations:

oauth2

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"@type": "Comment",
"title": "Meeting Summary - June 10",
"content": "Met with client to discuss new requirements for the website project. They want to add an e-commerce section and integrate with their inventory system.",
"about": "550e8400-e29b-41d4-a716-446655440000",
"format": "text/markdown",
"language": "en-US",
"createdBy": {"id": "user-123",
"name": "Jane Doe"
},
"createdAt": "2023-06-10T16:30:00Z",
"updatedAt": "2023-06-11T09:15:00Z",
"version": "1.2",
"parent": "folder-789",
"tags": ["meeting",
"requirements",
"important"
],
"visibility": "team",
"pinned": true,
"shared": {"type": "team",
"users": ["user-456"
]
},
"permissions": ["read",
"write",
"share"
]
}
]

Create a new Note

Authorizations:

oauth2

Request Body schema: application/json
required

id required	string <uuid> Unique identifier for the note
@type	string Default: "Comment" Schema.org type
title	string Note title (Schema.org name)
content required	string Note content (Schema.org text, UBL Note)
about required	string <uuid> ID of the entity this note is about (Schema.org about)
format	string Enum: "text/plain" "text/html" "text/markdown" Content format (Schema.org encodingFormat)
language	string Content language (Schema.org inLanguage, UBL LanguageID)
required	object Author information (Schema.org author, UBL IssuerParty)
createdAt required	string <date-time> When the note was created (Schema.org dateCreated, UBL IssueDate)
updatedAt	string <date-time> When the note was last updated (Schema.org dateModified)
version	string Version number (Schema.org version, UBL VersionID)
parent	string Parent container reference (Schema.org isPartOf)
tags	Array of strings Categorization tags (Schema.org keywords)
visibility	string Enum: "private" "team" "public" Who can see the note (custom extension)
pinned	boolean Whether note is pinned (custom extension)
	object Sharing status (custom extension)
permissions	Array of strings Items Enum: "read" "write" "share" "delete" Access rights (custom extension)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"@type": "Comment",
"title": "Meeting Summary - June 10",
"content": "Met with client to discuss new requirements for the website project. They want to add an e-commerce section and integrate with their inventory system.",
"about": "550e8400-e29b-41d4-a716-446655440000",
"format": "text/markdown",
"language": "en-US",
"createdBy": {"id": "user-123",
"name": "Jane Doe"
},
"createdAt": "2023-06-10T16:30:00Z",
"updatedAt": "2023-06-11T09:15:00Z",
"version": "1.2",
"parent": "folder-789",
"tags": ["meeting",
"requirements",
"important"
],
"visibility": "team",
"pinned": true,
"shared": {"type": "team",
"users": ["user-456"
]
},
"permissions": ["read",
"write",
"share"
]
}

Retrieve a Note by ID

Authorizations:

oauth2

path Parameters

id

required

string <uuid>

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"@type": "Comment",
"title": "Meeting Summary - June 10",
"content": "Met with client to discuss new requirements for the website project. They want to add an e-commerce section and integrate with their inventory system.",
"about": "550e8400-e29b-41d4-a716-446655440000",
"format": "text/markdown",
"language": "en-US",
"createdBy": {"id": "user-123",
"name": "Jane Doe"
},
"createdAt": "2023-06-10T16:30:00Z",
"updatedAt": "2023-06-11T09:15:00Z",
"version": "1.2",
"parent": "folder-789",
"tags": ["meeting",
"requirements",
"important"
],
"visibility": "team",
"pinned": true,
"shared": {"type": "team",
"users": ["user-456"
]
},
"permissions": ["read",
"write",
"share"
]
}

Update a Note by ID

Authorizations:

oauth2

path Parameters

id

required

string <uuid>

Request Body schema: application/json
required

id required	string <uuid> Unique identifier for the note
@type	string Default: "Comment" Schema.org type
title	string Note title (Schema.org name)
content required	string Note content (Schema.org text, UBL Note)
about required	string <uuid> ID of the entity this note is about (Schema.org about)
format	string Enum: "text/plain" "text/html" "text/markdown" Content format (Schema.org encodingFormat)
language	string Content language (Schema.org inLanguage, UBL LanguageID)
required	object Author information (Schema.org author, UBL IssuerParty)
createdAt required	string <date-time> When the note was created (Schema.org dateCreated, UBL IssueDate)
updatedAt	string <date-time> When the note was last updated (Schema.org dateModified)
version	string Version number (Schema.org version, UBL VersionID)
parent	string Parent container reference (Schema.org isPartOf)
tags	Array of strings Categorization tags (Schema.org keywords)
visibility	string Enum: "private" "team" "public" Who can see the note (custom extension)
pinned	boolean Whether note is pinned (custom extension)
	object Sharing status (custom extension)
permissions	Array of strings Items Enum: "read" "write" "share" "delete" Access rights (custom extension)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"@type": "Comment",
"title": "Meeting Summary - June 10",
"content": "Met with client to discuss new requirements for the website project. They want to add an e-commerce section and integrate with their inventory system.",
"about": "550e8400-e29b-41d4-a716-446655440000",
"format": "text/markdown",
"language": "en-US",
"createdBy": {"id": "user-123",
"name": "Jane Doe"
},
"createdAt": "2023-06-10T16:30:00Z",
"updatedAt": "2023-06-11T09:15:00Z",
"version": "1.2",
"parent": "folder-789",
"tags": ["meeting",
"requirements",
"important"
],
"visibility": "team",
"pinned": true,
"shared": {"type": "team",
"users": ["user-456"
]
},
"permissions": ["read",
"write",
"share"
]
}

Delete a Note by ID

Authorizations:

oauth2

path Parameters

id

required

string <uuid>

European Client Register API (1.0.0)

clients

tasks

messages

notes

products

services

orders

orderItems

Client

Retrieve a list of Client

Authorizations:

Responses

Response samples

Create a new Client

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Retrieve a Client by ID

Authorizations:

path Parameters

Responses

Response samples

Update a Client by ID

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Delete a Client by ID

Authorizations:

path Parameters

Responses

Task

Retrieve a list of Task

Authorizations:

Responses

Response samples

Create a new Task

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Retrieve a Task by ID

Authorizations:

path Parameters

Responses

Response samples

Update a Task by ID

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Delete a Task by ID

Authorizations:

path Parameters

Responses

Message

Retrieve a list of Message

Authorizations:

Responses

Response samples

Create a new Message

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Retrieve a Message by ID

Authorizations:

path Parameters

Responses

Response samples

Update a Message by ID

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required