Account107

Activity124

API Access2

Approval32

Call8

Chat8

Client34

Company Email2

Contact131

Country8

Currency24

Custom Entity26

Document40

Email90

Email Sequence32

Field34

Forecast8

Form24

Import8

Interface8

Lead8

Lead & Opportunity164

MasterRight80

Media8

Memo16

Message24

Note8

Online Form56

Opportunity16

Phone8

Pipeline8

Process32

Product50

Product Line Items8

Profile14

Project58

Quote72

Report16

SalesRole8

SalesUnit10

Solution16

Step24

Tag16

Target16

Text Message32

Timeframe2

Translation8

Webhook16

Webresource8

Note

Notes.get

Returns the Note record with the given id.

get/entities/Notes/{id}

Request

Base URL
https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id
Auth
HTTP basic
TypeScript
https://skmtc.dev/coevera/apis/coevera-crm-api/docs/entities/Notes/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring uuid required

Id of the Note record to retrieve.

Query parameters

expandstring

Related records to return inline instead of their URIs, comma-separated; dots reach nested relations. The only parameter this call accepts.

Response

The Note record.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "account_id": "01234567-abcd-dcba-ffff-000000000000",
    "contact_id": "01234567-abcd-dcba-ffff-000000000000",
    "custom_entity_id": "01234567-abcd-dcba-ffff-000000000000",
    "lead_oppty_id": "01234567-abcd-dcba-ffff-000000000000",
    "note": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "project_id": "01234567-abcd-dcba-ffff-000000000000",
    "quote_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.