POpolar
custom-fields
public

List Custom Fields

List custom fields.

Scopes: custom_fields:read custom_fields:write

get/v1/custom-fields/

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/custom-fields/
  • Auth
    • OpenID Connect (/.well-known/openid-configuration, scopes: custom_fields:read, custom_fields:write)
    • or HTTP bearer
    • or HTTP bearer

Query parameters

string uuid4

The organization ID.

OR
string[]
Example:1dbfc517-0bbf-4301-9ba8-555ca42b9737
querystring nullable

Filter by custom field name or slug.

'text' | 'number' | 'date' | 'checkbox' | 'select'
OR
CustomFieldType[]
pageinteger

Page number, defaults to 1.

limitinteger

Size of a page, defaults to 10. Maximum is 100.

sortingCustomFieldSortProperty[] nullable

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

Response

Successful Response

Example response

{
  "items": [
    {
      "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"
    }
  ]
}

Changes

No recorded changes to this operation across all 11 revisions of this API.