List a purchase payment note's files

Returns the files attached to one purchase payment note.

GET /purchase_payments/{purchase_payment_id}/notes/{pp_note_id}/files

cURL

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/purchase_payments/PP-0001/notes/note_8d1e2f3a4b5c4d6e8f9a0b1c2d3e4f5a/files?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200

{
  "data": [
    {
      "uuid": "<string>",
      "filename": "<string>",
      "content_type": "<string>",
      "size": 123,
      "href": "<string>"
    }
  ],
  "object": "<string>",
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  },
  "url": "<string>"
}

Lists the files attached to the note under data, with each file’s name, type, size and uuid.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization · string · header · required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

purchase_payment_id · string · required

The purchase payment's id.

pp_note_id · string · required

The note's id, from the note create or the notes list.

Query Parameters

limit · integer

The most records to return on one page.

Example:

20

cursor · string

The next_cursor value from the previous page, to read the next one.

sort · string

The field to sort by. Prefix it with - for descending order, such as -created_on.

Example:

"-created_on"

Response

200 - application/json

The note's files.

data · object[]

Show child attributes

object · string

pagination · object

Show child attributes

url · string