UPupflow
Notes

List Notes

List notes with optional filtering.

get/notes

Request

  • Base URL
    https://api.upflow.io/v1
  • Auth
    API key in header X-Api-Key and API key in header X-Api-Secret

Query parameters

offsetinteger

The 0-based index of the first item to return.

pageinteger
Example:1

The page number to retrieve (1-based). If both page and offset are provided, offset takes priority.

limitinteger
Example:100

Maximum number of items to return per page.

includeAttachmentsboolean

Whether to include attachments in the response.

customerIdstring uuid
Example:00a70b35-2be3-4c43-aefb-397190134655

Filter notes by Customer ID.

userIdstring uuid
Example:00a70b35-2be3-4c43-aefb-397190134655

Filter notes by User ID.

invoiceIdstring uuid
Example:00a70b35-2be3-4c43-aefb-397190134655

Filter notes by Invoice ID.

createdAt.gtstring date-time

Minimum value to filter by (exclusive)

createdAt.gtestring date-time

Minimum value to filter by (inclusive)

createdAt.ltstring date-time

Maximum value to filter by (exclusive)

createdAt.ltestring date-time

Maximum value to filter by (inclusive)

{
  "createdAt.gt": "2015-05-05T12:30:00Z",
  "createdAt.gte": "2015-05-05T12:30:00Z",
  "createdAt.lt": "2015-05-05T12:30:00Z",
  "createdAt.lte": "2015-05-05T12:30:00Z"
}
updatedAt.gtstring date-time

Minimum value to filter by (exclusive)

updatedAt.gtestring date-time

Minimum value to filter by (inclusive)

updatedAt.ltstring date-time

Maximum value to filter by (exclusive)

updatedAt.ltestring date-time

Maximum value to filter by (inclusive)

{
  "updatedAt.gt": "2015-05-05T12:30:00Z",
  "updatedAt.gte": "2015-05-05T12:30:00Z",
  "updatedAt.lt": "2015-05-05T12:30:00Z",
  "updatedAt.lte": "2015-05-05T12:30:00Z"
}
modifiedAt.gtstring date-time

Minimum value to filter by (exclusive)

modifiedAt.gtestring date-time

Minimum value to filter by (inclusive)

modifiedAt.ltstring date-time

Maximum value to filter by (exclusive)

modifiedAt.ltestring date-time

Maximum value to filter by (inclusive)

{
  "modifiedAt.gt": "2015-05-05T12:30:00Z",
  "modifiedAt.gte": "2015-05-05T12:30:00Z",
  "modifiedAt.lt": "2015-05-05T12:30:00Z",
  "modifiedAt.lte": "2015-05-05T12:30:00Z"
}
sortBy'createdAt' | 'updatedAt' | 'modifiedAt'
Example:createdAt

Sort notes by a specific column.

sortOrder'DESC' | 'ASC'

Sort order.

Response

Paginated list of notes.

offsetinteger

0-based index of the first item returned. Returned when using offset-based pagination or by default.

pageinteger

Page number (1-based). Returned when using page-based pagination.

limitinteger required

Maximum number of items returned.

totalinteger required

Total items in the set.

Example response

{
  "page": 1,
  "limit": 50,
  "total": 100,
  "items": [
    {
      "id": "00a70b35-2be3-4c43-aefb-397190134655",
      "createdAt": "2015-05-05T12:30:00Z",
      "updatedAt": "2015-05-05T12:30:00Z",
      "modifiedAt": "2015-05-05T12:30:00Z",
      "customer": {
        "id": "00a70b35-2be3-4c43-aefb-397190134655",
        "externalId": "1a2c3b",
        "companyName": "Upflow SAS",
        "accountingRef": "UPFL-SAS"
      },
      "user": {
        "id": "00a70b35-2be3-4c43-aefb-397190134655",
        "firstName": "John",
        "lastName": "Doe",
        "email": "user@email.com"
      },
      "invoice": {
        "id": "00a70b35-2be3-4c43-aefb-397190134655",
        "externalId": "92842AB37",
        "customId": "FAC123"
      },
      "medium": "UI",
      "attachments": [
        {
          "id": "00a70b35-2be3-4c43-aefb-397190134655",
          "mimeType": "image/png",
          "fileName": "document.pdf",
          "createdAt": "2015-05-05T12:30:00Z",
          "fileUrl": "https://example.com/files/document.pdf"
        }
      ]
    }
  ]
}

Changes

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