Notes

List Notes

Changed on

List notes with optional filters and cursor pagination.

get/notes

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /notes
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL /authorize, token URL /oauth/token)

Query parameters

cursorstring nullable

Opaque cursor from a previous page's next_cursor; omit for the first page.

Example:eyJ0IjogIjIwMjYtMDEtMTVUMDk6MzA6MDArMDA6MDAiLCAiaWQiOiAiM2YyYjhjMWUtN2Q0YS00ZTliLWE2YzUtMWQyZTNmNGE1YjZjIn0=
limitinteger

Maximum number of notes to return (1-200).

Example:25
apistring nullable

Only return notes attached to APIs matching vendor[:name[:version]].

Example:stripe.com:stripe:2024-04-10
operation_idstring nullable

Only return notes attached to this operation.

Example:listCharges
execution_idstring nullable

Only return notes attached to this execution.

Example:exec_6968b3982706c619fe73f0cf
credential_idstring nullable

Only return notes attached to this credential.

Example:cred_6968b39855d91a3561684b32
typestring nullable

Only return notes of this type.

Example:usage_hint
created_bystring nullable

Only return notes created by this actor ID.

Example:usr_6968b3987ee4c3ec0b4ee3b9

Response

Successful Response

unknown required

Changes

  • c516481e6ed8Revision changes
    • info

      the endpoint scheme security OAuth2 was added to the API

  • d65fcba0d25aRevision changes
    • breaking

      for the query request parameter limit, the max was decreased from 500.00 to 200.00

    • breaking

      the response's property type changed from array to string for status

    • warning

      deleted the query request parameter resource

    • info

      api operation id list_notes_notes_get removed and replaced with listNotes

    • info

      the endpoint scheme security BearerAuth was added to the API

    • info

      the endpoint scheme security AgentOauthAccessToken was removed from the API

    • info

      the endpoint scheme security HumanLogin was removed from the API

    • info

      the endpoint scheme security JenticApiKey was removed from the API

    • info

      api tag Notes added

    • info

      api tag catalog removed

    • info

      added the new optional query request parameter api

    • info

      added the new optional query request parameter created_by

    • info

      added the new optional query request parameter credential_id

    • info

      added the new optional query request parameter cursor

    • info

      added the new optional query request parameter execution_id

    • info

      added the new optional query request parameter operation_id

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status