admin
hubspot-schema

List Properties

Properties on one CRM object, optionally filtered by substring of name or label.

Filter on the label when you know what someone called it in the UI, and read back the name — that is the value a properties request has to use. type and field_type say whether a value is an owner id, an enum or free text, which decides whether it can be mapped exactly or only guessed at.

include_options adds an enumeration's allowed values. Off by default because a full listing drowns in them, but for an enum they are the whole question: whether the stored value is something joinable like an email, or a display name that can only be matched by guessing.

get/admin/hubspot-schema/properties

Request

  • Base URL
    https://api-docs.upsmith.com (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Query parameters

object_typestring
containsstring nullable
include_optionsboolean

Headers

organization-idstring nullable
timezonestring
x-user-idstring nullable
x-actor-emailstring nullable
x-request-sourcestring nullable
x-operation-idstring nullable
x-commit-messagestring nullable
x-confirmation-idstring nullable
x-chat-idstring nullable

Response

Successful Response

object required

Changes

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