Podium

Podium Location API

The Location API from Podium — 2 operation(s) for location.

Documentation GitHub OpenAPI

Operations 3

GET /v4/locations List all locations. #

GET /v4/locations/{uid} Get a location. #

PATCH /v4/locations/{uid} Update a location. #

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-location-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

openapi: 3.2.0
info:
  title: Accounts Location API
  version: 2021.04.01
servers:
- url: https://api.podium.com
  variables: {}
security: []
tags:
- name: Location
paths:
  /v4/locations:
    get:
      callbacks: {}
      description: 'List of all the locations that the caller has access to.


        If the `cursor` parameter is used then all other parameters will be ignored. This is to avoid confusion if passing both a `cursor` and other parameters which would change what data is being returned.


        Required scope: `read_locations`.'
      operationId: location.index
      parameters:
      - description: String you would like to search for in the `searchFields` parameter.
        in: query
        name: search
        required: false
        schema:
          type: string
      - description: A list of the fields where you want to search for the `search` parameters. e.g. ?searchFields[]=name&searchFields[]=displayname
        in: query
        name: searchFields
        required: false
        schema:
          default:
          - name
          items:
            enum:
            - address
            - displayName
            - name
            - podiumPhoneNumber
            type: string
          type: array
      - description: Max number of items to return per request. Defaults to `10`.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          example: 10
          maximum: 100
          minimum: 0
          type: integer
      - description: Only return locations that have been updated after the given date.
        in: query
        name: updatedAfter
        required: false
        schema:
          description: Date time in Coordinated Universal Time (UTC).
          example: '2015-01-23T23:50:07Z'
          format: date-time
          type: string
      - description: Retrieves the page of items that comes after the `cursor`.
        in: query
        name: cursor
        required: false
        schema:
          description: Cursor used to access next or previous page in pagination.
          example: MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/location'
                    type: array
                  metadata:
                    description: Additional response data.
                    properties:
                      nextCursor:
                        description: Cursor to get next set of items.
                        example: MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw
                        type: string
                      previousCursor:
                        description: Cursor to get previous set of items.
                        example: MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw
                        type: string
                      totalItems:
                        description: Total number of items available.
                        type: integer
                      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 all locations.
      tags:
      - Location
  /v4/locations/{uid}:
    get:
      callbacks: {}
      description: 'Gets a single location by its uid.


        Required scope: `read_locations`.'
      operationId: location.get
      parameters:
      - description: Podium unique identifier for location.
        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/location'
                  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: Get a location.
      tags:
      - Location
    patch:
      callbacks: {}
      description: "Update a single location by its uid. \n\nRequired scope: `write_locations`.\n\nBe aware: The `addressDetails` property follows the ISO convention. You might see errors\n\nif trying to update a location's address with an invalid address.\n"
      operationId: location.update
      parameters:
      - description: Podium unique identifier for location.
        in: path
        name: uid
        required: true
        schema:
          example: 00000000-0000-0000-0000-000000000000
          format: uuid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              minProperties: 1
              properties:
                addressDetails:
                  description: Address of the location with details
                  properties:
                    city:
                      description: The city of the location's address
                      example: Sao Paulo
                      type: string
                    country:
                      description: The country of the location's address
                      example: BR
                      type: string
                    countryLongName:
                      description: The long country name of the location's address
                      example: Brazil
                      type: string
                    houseNumber:
                      description: The house number of the location's address
                      example: '195'
                      type: string
                    postalCode:
                      description: The postal code of the location's address
                      example: '84093'
                      type: string
                    road:
                      description: The road of the location's address
                      example: Digital Dr
                      type: string
                    state:
                      description: The state of the location's address
                      example: SP
                      type: string
                    stateLongName:
                      description: The long state name of the location's address
                      example: Sao Paulo
                      type: string
                    unit:
                      description: The unit of the location's address
                      example: '123'
                      type: string
                  type: object
                displayName:
                  description: The display name of the resource
                  example: Podium US
                  type: string
                name:
                  description: The name of the resource
                  example: Podium
                  type: string
                phoneNumber:
                  description: The phone number of the resource
                  example: '+18884441234'
                  pattern: ^\+[1-9]\d{1,15}$
                  type: string
              type: object
        description: Update location params
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/location'
                  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 location.
      tags:
      - Location
components:
  schemas:
    location:
      properties:
        address:
          deprecated: true
          description: Address of the physical location.
          example: 1650 Digital Dr, Lehi, UT 84043
          type:
          - string
          - 'null'
        addressDetails:
          description: Details of the address such as state, country, postal code, etc
          properties:
            city:
              description: City of the location's address.
              type:
              - string
              - 'null'
            country:
              description: Country of the location's address.
              type:
              - string
              - 'null'
            countryLongName:
              description: Long country name of the location's address.
              type:
              - string
              - 'null'
            houseNumber:
              description: House number of the location's address.
              type:
              - string
              - 'null'
            postalCode:
              description: Postal code of the location's address.
              type:
              - string
              - 'null'
            road:
              description: Road of the location's address.
              type:
              - string
              - 'null'
            state:
              description: State of the location's address.
              type:
              - string
              - 'null'
            stateLongName:
              description: Long state name of the location's address.
              type:
              - string
              - 'null'
            unit:
              description: Unit of the location's address.
              type:
              - string
              - 'null'
          type: object
        archived:
          description: If the location has been archived.
          example: false
          type:
          - boolean
          - 'null'
        archivedAt:
          description: When the location was archived.
          example: '2015-01-23T23:50:07Z'
          format: date-time
          type:
          - string
          - 'null'
        createdAt:
          description: When the location was created.
          example: '2015-01-23T23:50:07Z'
          format: date-time
          type:
          - string
          - 'null'
        displayName:
          description: Name of the location that is displayed in the user interface.
          example: Podium, Inc.
          type:
          - string
          - 'null'
        name:
          description: Name of the location.
          type:
          - string
          - 'null'
        organizationUid:
          description: Podium unique identifier for organization.
          example: 00000000-0000-0000-0000-000000000000
          format: uuid
          type:
          - string
          - 'null'
        phoneNumber:
          description: Phone number of the location.
          example: '+18017580580'
          type:
          - string
          - 'null'
        podiumPhoneNumber:
          description: "Podium phone number of the location. \nThis is the number that customer's will see on their phone's when receiving a message from this location."
          example: '+18017580580'
          type:
          - string
          - 'null'
        uid:
          description: Podium unique identifier for location.
          example: 00000000-0000-0000-0000-000000000000
          format: uuid
          type: string
        updatedAt:
          description: When the location was updated.
          example: '2015-01-23T23:50:07Z'
          format: date-time
          type:
          - string
          - 'null'
      title: location
      type: object