Podium

Podium Contact Attribute API

The Contact Attribute API from Podium — 2 operation(s) for contact attribute.

GitHub OpenAPI

Operations 5

GET /v4/contact_attributes List contact attributes #
POST /v4/contact_attributes Create a contact attribute #
DELETE /v4/contact_attributes/{uid} Delete a contact attribute #
GET /v4/contact_attributes/{uid} Gets a contact attribute by uid #
PATCH /v4/contact_attributes/{uid} Update a contact attribute #

Documentation

📖
Documentation
https://docs.podium.com/reference/introduction
📖
GettingStarted
https://docs.podium.com/docs/getting-started
📖
Authentication
https://docs.podium.com/reference/authentication
📖
APIReference
https://docs.podium.com/reference/introduction

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/podium/refs/heads/main/openapi/podium-contact-attribute-api-openapi.yml

Other Resources

🔗
Versioning
https://docs.podium.com/docs/api-version
🔗
ErrorCodes
https://docs.podium.com/docs/errors
🔗
Webhooks
https://docs.podium.com/reference/webhookget-1
🔗
PostmanWorkspace
https://www.postman.com/podiumhq/podium-s-api-workspace
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/podium/refs/heads/main/scopes/podium-scopes.yml
🔗
Pagination
https://docs.podium.com/reference/pagination

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/podium-contact-attribute-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

podium-contact-attribute-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Contacts Contact Attribute API
  version: 2021.04.01
servers:
- url: https://api.podium.com
  variables: {}
security: []
tags:
- name: Contact Attribute
paths:
  /v4/contact_attributes:
    get:
      callbacks: {}
      description: 'List contact attributes that are tied to the ownerResource on the token.


        Required scope: `read_contacts`.

        '
      operationId: contact_entity_attribute.index
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/contact_entity_attribute'
                    type: array
                  metadata:
                    description: Additional response data.
                    properties:
                      url:
                        description: The resource URL.
                        example: https://www.podium.com/
                        type: string
                    type: object
                type: object
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                properties:
                  code:
                    description: Podium code for the error.
                    type: integer
                  message:
                    description: Specific details about the error.
                    type:
                    - string
                    - 'null'
                  moreInfo:
                    description: URL providing more information about the error.
                    type: string
                title: Error
                type: object
          description: Error response.
      summary: List contact attributes
      tags:
      - Contact Attribute
    post:
      callbacks: {}
      description: 'Create an application or organization level attribute to be used on contacts.


        Required scope: `write_contacts`.

        '
      operationId: contact_entity_attribute.create
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              properties:
                dataType:
                  description: The data type of the attribute value
                  enum:
                  - ADDRESS
                  - BOOLEAN
                  - DATETIME
                  - FLOAT
                  - INTEGER
                  - STRING
                  - UUID
                  - SINGLE_SELECT
                  - MULTI_SELECT
                  type: string
                isEncrypted:
                  default: true
                  description: If the attribute is encrypted it cannot be used as a filter. Attributes that will have sensitive information, such as PII or PHI, should be encrypted. Defaults to true.
                  type: boolean
                label:
                  description: The label of the attribute.
                  example: Internal Contact ID
                  minLength: 1
                  type: string
                ownerResourceType:
                  enum:
                  - PRODUCT
                  - ORGANIZATION
                  type: string
              required:
              - dataType
              - label
              - ownerResourceType
              type: object
        description: Create contact attribute params
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/contact_entity_attribute'
                  metadata:
                    description: Additional response data.
                    properties:
                      url:
                        description: The resource URL.
                        example: https://www.podium.com/
                        type: string
                    type: object
                type: object
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                properties:
                  code:
                    description: Podium code for the error.
                    type: integer
                  message:
                    description: Specific details about the error.
                    type:
                    - string
                    - 'null'
                  moreInfo:
                    description: URL providing more information about the error.
                    type: string
                title: Error
                type: object
          description: Error response.
      summary: Create a contact attribute
      tags:
      - Contact Attribute
  /v4/contact_attributes/{uid}:
    delete:
      callbacks: {}
      description: 'Delete a contact attribute with its uid.


        Required scope: `write_contacts`.'
      operationId: contact_entity_attribute.delete
      parameters:
      - description: Podium unique identifier for attribute.
        in: path
        name: uid
        required: true
        schema:
          example: 00000000-0000-0000-0000-000000000000
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/contact_entity_attribute'
                  metadata:
                    description: Additional response data.
                    properties:
                      url:
                        description: The resource URL.
                        example: https://www.podium.com/
                        type: string
                    type: object
                type: object
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                properties:
                  code:
                    description: Podium code for the error.
                    type: integer
                  message:
                    description: Specific details about the error.
                    type:
                    - string
                    - 'null'
                  moreInfo:
                    description: URL providing more information about the error.
                    type: string
                title: Error
                type: object
          description: Error response.
      summary: Delete a contact attribute
      tags:
      - Contact Attribute
    get:
      callbacks: {}
      description: 'Gets an application or organization level attribute by its uid, to be used on contacts.


        Required scope: `read_contacts`.

        '
      operationId: contact_entity_attribute.get
      parameters:
      - description: Contacts attribute uid
        in: path
        name: uid
        required: true
        schema:
          example: 00000000-0000-0000-0000-000000000000
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/contact_entity_attribute'
                  metadata:
                    description: Additional response data.
                    properties:
                      url:
                        description: The resource URL.
                        example: https://www.podium.com/
                        type: string
                    type: object
                type: object
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                properties:
                  code:
                    description: Podium code for the error.
                    type: integer
                  message:
                    description: Specific details about the error.
                    type:
                    - string
                    - 'null'
                  moreInfo:
                    description: URL providing more information about the error.
                    type: string
                title: Error
                type: object
          description: Error response.
      summary: Gets a contact attribute by uid
      tags:
      - Contact Attribute
    patch:
      callbacks: {}
      description: 'Update an application or organization level attribute to be used on contacts.


        Required scope: `write_contacts`.

        '
      operationId: contact_entity_attribute.update
      parameters:
      - description: Podium unique identifier for attribute.
        in: path
        name: uid
        required: true
        schema:
          example: 00000000-0000-0000-0000-000000000000
          format: uuid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                dataType:
                  description: The data type of the attribute value.
                  enum:
                  - ADDRESS
                  - BOOLEAN
                  - DATETIME
                  - FLOAT
                  - INTEGER
                  - STRING
                  - UUID
                  - SINGLE_SELECT
                  - MULTI_SELECT
                  type: string
                isEncrypted:
                  description: If the attribute is encrypted it cannot be used as a filter. Attributes that will have sensitive information, such as PII or PHI, should be encrypted.
                  type: boolean
                label:
                  description: The label of the attribute.
                  example: Internal Contact ID
                  type: string
                ownerResourceType:
                  description: Owner resource object
                  enum:
                  - PRODUCT
                  - ORGANIZATION
                  type: string
              type: object
        description: Update contact attribute params
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/contact_entity_attribute'
                  metadata:
                    description: Additional response data.
                    properties:
                      url:
                        description: The resource URL.
                        example: https://www.podium.com/
                        type: string
                    type: object
                type: object
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                properties:
                  code:
                    description: Podium code for the error.
                    type: integer
                  message:
                    description: Specific details about the error.
                    type:
                    - string
                    - 'null'
                  moreInfo:
                    description: URL providing more information about the error.
                    type: string
                title: Error
                type: object
          description: Error response.
      summary: Update a contact attribute
      tags:
      - Contact Attribute
components:
  schemas:
    contact_entity_attribute:
      description: A contact attribute.
      properties:
        createdAt:
          description: Time at which the resource was created. Date time is in Coordinated Universal Time (UTC).
          example: '2015-01-23T23:50:07Z'
          format: date-time
          type: string
        dataType:
          description: The data type of the attribute value
          enum:
          - ADDRESS
          - BOOLEAN
          - DATETIME
          - FLOAT
          - INTEGER
          - STRING
          - UUID
          - SINGLE_SELECT
          - MULTI_SELECT
          type: string
        isEncrypted:
          default: true
          description: If the attribute is encrypted it cannot be used as a filter. Attributes that will have sensitive information, such as PII or PHI, should be encrypted.
          type: boolean
        label:
          description: The label of the attribute.
          type: string
        ownerResource:
          properties:
            type:
              enum:
              - PRODUCT
              - ORGANIZATION
              type:
              - string
              - 'null'
            uid:
              description: The unique identify of the owner resource. Either an application uid or organization uid.
              example: 00000000-0000-0000-0000-000000000000
              format: uuid
              type:
              - string
              - 'null'
          type: object
        uid:
          description: Podium unique identifier for attribute.
          example: 00000000-0000-0000-0000-000000000000
          format: uuid
          type: string
        updatedAt:
          description: Time at which the resource was updated. Date time is in Coordinated Universal Time (UTC).
          example: '2015-01-23T23:50:07Z'
          format: date-time
          type: string
      title: contact_entity_attribute
      type: object