Skip to content

API Reference / Contacts

GET /contacts/{contact_id}/pinned_attachments

Get a list of attachments pinned to this contact

The list of pinned attachments is sorted based on "pinned_at" field, i.e. most recent attachments come first, the list of attachments is paginated.

Maintained by the OnePageCRM engineering team

Path parameters

Name Type Description
contact_id req string Contact ID

Responses

200 OK
  • statusintegerint32

    Response code

  • messagestring

    Response message

  • timestampintegerunix-timestamp

    Response time

  • dataobject
    object fields →
    • pinned_attachmentsarray<object>
      array item fields →
      • idstringbson-id

        ID of the attachment

      • filenamestringrequired

        Name of the attachment file

      • custom_filenamestring

        Custom name of the attachment file

      • pinnedboolean

        Show if the attachment is pinned to its owner contact

      • pinned_atstring

        Shows pinned at timestamp. Is null if pinned == false

      • sizeintegerint32required

        Size of the attachment file (in bytes)

      • storage_providerstring

        Name of the storage provider (where the attachment file is stored)

        enum: amazon · google_drive · dropbox · evernote

      • urlstring

        External URL of the attachment file

      • url_expires_atstringdate-time

        The time the attachment URL expires

      • thumbnailobject

        An image preview of the attachment file (if one exists)

        object fields →
        • urlstring

          External URL of the attachment's thumbnail

  • total_countintegerint32

    Total number of items

  • pageintegerint32

    Current page number

  • per_pageintegerint32

    Number of items returned in each page

  • max_pageintegerint32

    The page number of the last page of items

Standard error responses: 400 · 401 · 403 · 404 · 409 · 500 — shared across the API. See Errors.

Related guides