Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

NoteTypes

Get a note type

Retrieve the details of a single note type (required scope notes:read)

get/v1/noteTypes/{noteTypeId}

Path parameters

noteTypeIdinteger required

The unique identifer of the note type

Headers

Customer-Idinteger required

The customer identifier

Response

OK

idinteger

The unique identifier of the note type

namestring

The name of the note type

defaultOwnedByUserIdinteger nullable

The default owner for notes of this type

createdAtstring date-time

The UTC timestamp of when this note type was created

Example response

{
  "id": 5514123,
  "name": "Complaint",
  "defaultOwnedByUserId": 5514123,
  "createdAt": "2022-11-29T16:50:16.0000000+00:00"
}