PracticePanther

PracticePanther Relationship API

The Relationship API from PracticePanther — 2 operation(s) for relationship.

GitHub OpenAPI

Operations 5

GET /api/relationship/{guid} Returns a relationshi #
GET /api/relationship OData end point to get a list of all relationships for contacts accessible by the user #
PUT /api/relationship Updates an existing relationship #
POST /api/relationship Creates a new relationship #
DELETE /api/relationship Deletes an existing relationship #

Documentation

📖
Documentation
https://support.practicepanther.com/en/articles/479897-practicepanther-api
📖
Authentication
https://support.practicepanther.com/en/articles/480086-api-access

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/practicepanther/refs/heads/main/openapi/practicepanther-relationship-api-openapi.yml

Other Resources

🔗
SwaggerUI
https://app.practicepanther.com/swagger/ui/index

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/practicepanther-relationship-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

practicepanther-relationship-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: v1
  title: Legacy API (v1) Account Relationship API
  description: ''
servers:
- url: https://app.practicepanther.com
tags:
- name: Relationship
paths:
  /api/relationship/{guid}:
    get:
      tags:
      - Relationship
      summary: Returns a relationshi
      operationId: Relationship_GetRelationship
      parameters:
      - name: guid
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelationshipDTO_Detail'
            text/json:
              schema:
                $ref: '#/components/schemas/RelationshipDTO_Detail'
      security:
      - oauth2:
        - full
  /api/relationship:
    get:
      tags:
      - Relationship
      summary: OData end point to get a list of all relationships for contacts accessible by the user
      operationId: Relationship_GetRelationships
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RelationshipDTO'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RelationshipDTO'
      security:
      - oauth2:
        - full
    put:
      tags:
      - Relationship
      summary: Updates an existing relationship
      operationId: Relationship_PutRelationship
      requestBody:
        $ref: '#/components/requestBodies/RelationshipDTO_Detail'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelationshipDTO_Detail'
            text/json:
              schema:
                $ref: '#/components/schemas/RelationshipDTO_Detail'
      security:
      - oauth2:
        - full
    post:
      tags:
      - Relationship
      summary: Creates a new relationship
      operationId: Relationship_PostRelationship
      requestBody:
        $ref: '#/components/requestBodies/RelationshipDTO_Detail'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelationshipDTO_Detail'
            text/json:
              schema:
                $ref: '#/components/schemas/RelationshipDTO_Detail'
      security:
      - oauth2:
        - full
    delete:
      tags:
      - Relationship
      summary: Deletes an existing relationship
      operationId: Relationship_DeleteRelationship
      parameters:
      - name: guid
        in: query
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelationshipDTO_Detail'
            text/json:
              schema:
                $ref: '#/components/schemas/RelationshipDTO_Detail'
      security:
      - oauth2:
        - full
components:
  schemas:
    ProjectRef:
      type: object
      properties:
        nameAndNumber:
          description: This is a read only property This is a read only property
          type: string
          readOnly: true
        guid:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        accountGuid:
          format: uuid
          description: 'Used to set the reference in POST and PUT '
          type: string
          example: 00000000-0000-0000-0000-000000000000
        id:
          format: int64
          type: integer
    RelationshipDTO:
      required:
      - relationshipName
      type: object
      properties:
        guid:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        account:
          $ref: '#/components/schemas/AccountRef'
        contact:
          $ref: '#/components/schemas/ContactRef'
        project:
          $ref: '#/components/schemas/ProjectRef'
        relationshipName:
          type: string
        notes:
          type: string
    AccountRef:
      type: object
      properties:
        nameAndNumber:
          description: ' '
          type: string
          readOnly: true
        guid:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        utbmsIsEnabled:
          type: boolean
        id:
          format: int64
          type: integer
    UserRef:
      type: object
      properties:
        guid:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        displayName:
          description: ' '
          type: string
          readOnly: true
        name:
          description: ' '
          type: string
          readOnly: true
        timeZoneId:
          type: string
    ContactRef:
      type: object
      properties:
        firstName:
          type: string
        lastName:
          type: string
        middleName:
          type: string
        accountName:
          type: string
        displayName:
          type: string
        guid:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        email:
          type: string
    RelationshipDTO_Detail:
      required:
      - contactGuid
      - projectGuid
      - relationshipName
      type: object
      properties:
        contactGuid:
          format: uuid
          description: 'Used to set the reference in POST and PUT '
          pattern: ^(\{{0,1}([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}\}{0,1})$
          type: string
          example: 00000000-0000-0000-0000-000000000000
        projectGuid:
          format: uuid
          description: 'Used to set the reference in POST and PUT '
          pattern: ^(\{{0,1}([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}\}{0,1})$
          type: string
          example: 00000000-0000-0000-0000-000000000000
        createdDate:
          format: date-time
          description: ' '
          type: string
          readOnly: true
        createdBy:
          $ref: '#/components/schemas/UserRef'
        lastModifiedBy:
          $ref: '#/components/schemas/UserRef'
        lastModifiedDate:
          format: date-time
          description: ' '
          type: string
          readOnly: true
        guid:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        account:
          $ref: '#/components/schemas/AccountRef'
        contact:
          $ref: '#/components/schemas/ContactRef'
        project:
          $ref: '#/components/schemas/ProjectRef'
        relationshipName:
          type: string
        notes:
          type: string
  requestBodies:
    RelationshipDTO_Detail:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RelationshipDTO_Detail'
        text/json:
          schema:
            $ref: '#/components/schemas/RelationshipDTO_Detail'
        application/x-www-form-urlencoded:
          schema:
            $ref: '#/components/schemas/RelationshipDTO_Detail'
      required: true
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.0 - Authorization Code Grant
      flows:
        authorizationCode:
          authorizationUrl: /OAuth/Authorize
          tokenUrl: /OAuth/Token
          scopes:
            full: Read/Write access to all resources