HighLevel

HighLevel Associations API

Documentation for Associations API

GitHub OpenAPI

Operations 7

GET /associations/key/{key_name} Get association key by key name #
GET /associations/objectKey/{objectKey} Get association by object keys #
PUT /associations/{associationId} Update Association By Id #
DELETE /associations/{associationId} Delete Association #
GET /associations/{associationId} Get association by ID #
POST /associations/ Create Association #
GET /associations/ Get all associations for a sub-account / location #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/highlevel/openapi/highlevel-associations-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/highlevel/json-schema/highlevel-get-post-successful-response-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/highlevel/json-schema/highlevel-create-association-req-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/highlevel/json-schema/highlevel-delete-associations-response-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/highlevel/json-schema/highlevel-update-association-req-dto-schema.json

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/highlevel:highlevel-associations-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

highlevel-associations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Associations API
  description: Documentation for Associations API
  version: '1.0'
  contact: {}
servers:
- url: https://services.leadconnectorhq.com
tags:
- name: Associations
  description: Documentation for Associations API
paths:
  /associations/key/{key_name}:
    get:
      operationId: get-association-key-by-key-name
      summary: Get association key by key name
      description: Using this api you can get standard / user defined association by key
      parameters:
      - name: Version
        in: header
        description: API Version
        required: true
        schema:
          type: string
          enum:
          - '2021-07-28'
      - name: key_name
        required: true
        in: path
        schema:
          type: string
      - name: locationId
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPostSuccessfulResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/BadRequestDTO
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/UnauthorizedDTO
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/UnprocessableDTO
      tags:
      - Associations
      security:
      - bearer:
        - associations.readonly
  /associations/objectKey/{objectKey}:
    get:
      operationId: get-association-by-object-keys
      summary: Get association by object keys
      description: Get association by object keys like contacts, custom objects and opportunities. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f4122abc04d3
      externalDocs:
        url: https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f4122abc04d3
        description: Click here for more information
      parameters:
      - name: Version
        in: header
        description: API Version
        required: true
        schema:
          type: string
          enum:
          - '2021-07-28'
      - name: objectKey
        required: false
        in: path
        schema:
          example: custom_objects.car
          type: string
      - name: locationId
        required: false
        in: query
        schema:
          example: ve9EPM428h8vShlRW1KT
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPostSuccessfulResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/BadRequestDTO
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/UnauthorizedDTO
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/UnprocessableDTO
      tags:
      - Associations
      security:
      - bearer:
        - associations.readonly
  /associations/{associationId}:
    put:
      operationId: update-association
      summary: Update Association By Id
      description: Update Association , Allows you to update labels of an associations. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f4122abc04d3
      externalDocs:
        url: https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f4122abc04d3
        description: Click here for more information
      parameters:
      - name: Version
        in: header
        description: API Version
        required: true
        schema:
          type: string
          enum:
          - '2021-07-28'
      - name: associationId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAssociationReqDto'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPostSuccessfulResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/BadRequestDTO
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/UnauthorizedDTO
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/UnprocessableDTO
      tags:
      - Associations
      security:
      - bearer:
        - associations.write
    delete:
      operationId: delete-association
      summary: Delete Association
      description: Delete USER_DEFINED Association By Id, deleting an association will also all the relations for that association
      parameters:
      - name: Version
        in: header
        description: API Version
        required: true
        schema:
          type: string
          enum:
          - '2021-07-28'
      - name: associationId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteAssociationsResponseDTO'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/BadRequestDTO
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/UnauthorizedDTO
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/UnprocessableDTO
      tags:
      - Associations
      security:
      - bearer:
        - associations.write
    get:
      operationId: get-association-by-ID
      summary: Get association by ID
      description: Using this api you can get SYSTEM_DEFINED / USER_DEFINED association by id
      parameters:
      - name: Version
        in: header
        description: API Version
        required: true
        schema:
          type: string
          enum:
          - '2021-07-28'
      - name: associationId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPostSuccessfulResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/BadRequestDTO
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/UnauthorizedDTO
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/UnprocessableDTO
      tags:
      - Associations
      security:
      - bearer:
        - associations.readonly
  /associations/:
    post:
      operationId: create-association
      summary: Create Association
      description: Allow you to create contact - contact , contact - custom objects associations, will add more in the future.Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f4122abc04d3
      externalDocs:
        url: https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f4122abc04d3
        description: Click here for more information
      parameters:
      - name: Version
        in: header
        description: API Version
        required: true
        schema:
          type: string
          enum:
          - '2021-07-28'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createAssociationReqDto'
      responses:
        '201':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPostSuccessfulResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/BadRequestDTO
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/UnauthorizedDTO
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/UnprocessableDTO
      tags:
      - Associations
      security:
      - bearer:
        - associations.write
    get:
      operationId: find-associations
      summary: Get all associations for a sub-account / location
      description: Get all Associations
      parameters:
      - name: Version
        in: header
        description: API Version
        required: true
        schema:
          type: string
          enum:
          - '2021-07-28'
      - name: locationId
        required: true
        in: query
        schema:
          example: string
          type: string
      - name: skip
        required: true
        in: query
        schema:
          example: '10'
          type: number
      - name: limit
        required: true
        in: query
        schema:
          example: '100'
          type: number
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPostSuccessfulResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/BadRequestDTO
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/UnauthorizedDTO
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: ../common/common-schemas.json#/components/schemas/UnprocessableDTO
      tags:
      - Associations
      security:
      - bearer:
        - associations.readonly
components:
  schemas:
    UpdateAssociationReqDto:
      type: object
      properties:
        firstObjectLabel:
          type: object
          example: student
        secondObjectLabel:
          type: object
          example: tutor
      required:
      - firstObjectLabel
      - secondObjectLabel
    DeleteAssociationsResponseDTO:
      type: object
      properties:
        deleted:
          type: boolean
          example: true
          description: Deletion status
        id:
          type: string
          example: 6d6f6e676f5f6576656e7473
          description: Association Id
        message:
          type: string
          example: Association deleted successfully
      required:
      - deleted
      - id
      - message
    GetPostSuccessfulResponseDto:
      type: object
      properties:
        locationId:
          type: string
          example: string
        id:
          type: string
          example: ve9EPM428h8vShlRW1KT
        key:
          type: string
          example: student
          description: First Objects Association Label (custom_objects.children)
        firstObjectLabel:
          type: object
          example: student
          description: First Objects Association Label (custom_objects.children)
        firstObjectKey:
          type: object
          example: custom_objects.children
          description: First Objects Key
        secondObjectLabel:
          type: object
          example: Teacher
          description: Second Object Association Label (contact)
        secondObjectKey:
          type: object
          example: contact
          description: Second Objects Key
        associationType:
          type: object
          example: USER_DEFINED
          description: Association Type can be USER_DEFINED or SYSTEM_DEFINED
      required:
      - locationId
      - id
      - key
      - firstObjectLabel
      - firstObjectKey
      - secondObjectLabel
      - secondObjectKey
      - associationType
    createAssociationReqDto:
      type: object
      properties:
        locationId:
          type: string
          example: string
        key:
          type: string
          example: student_teacher
          description: Association's Unique key
        firstObjectLabel:
          type: object
          example: student
          description: First Objects Association Label (custom_objects.children)
        firstObjectKey:
          type: object
          example: custom_objects.children
          description: First Objects Key
        secondObjectLabel:
          type: object
          example: Teacher
          description: Second Object Association Label (contact)
        secondObjectKey:
          type: object
          example: contact
          description: Second Objects Key
      required:
      - locationId
      - key
      - firstObjectLabel
      - firstObjectKey
      - secondObjectLabel
      - secondObjectKey
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      name: Authorization
      in: header
      description: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.
      type: http
    Location-Access:
      scheme: bearer
      bearerFormat: JWT
      name: Authorization
      in: header
      description: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.
      type: http
    Location-Access-Only:
      scheme: bearer
      bearerFormat: JWT
      name: Authorization
      in: header
      description: Use the Access Token generated with user type as Sub-Account.
      type: http
    Agency-Access:
      scheme: bearer
      bearerFormat: JWT
      name: Authorization
      in: header
      description: Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.
      type: http
x-tagGroups:
  name: Associations
  tags:
  - Associations
  - Relations