LeafLink

LeafLink Customer API

The Customer API from LeafLink — 4 operation(s) for customer.

GitHub OpenAPI
Business capability
Customer Data Management BC-420.10

Operations 4

GET /customer_statuses List Company Customer Status #
GET /customer_statuses/{id} Get Company Customer Status #
GET /customers List Customers #
GET /customers/{id} Get Customer #

Documentation

📖
Documentation
https://developer.leaflink.com/api/
📖
APIReference
https://developer.leaflink.com/api/ref/
📖
GettingStarted
https://developer.leaflink.com/api/getting-started/
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/leaflink/refs/heads/main/rate-limits/leaflink-rate-limits.yml
📖
Documentation
https://developer.leaflink.com/legacy/v2/api/getting-started/
📖
APIReference
https://developer.leaflink.com/legacy/v2/api/ref/
📖
Authentication
https://developer.leaflink.com/legacy/v2/api/authorization/

Specifications

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

Other Resources

🔗
ChangeLog
https://developer.leaflink.com/legacy/v2/api/release-notes/
🔗
FAQ
https://developer.leaflink.com/legacy/v2/api/faqs/

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/leaflink-customer-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

leaflink-customer-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: LeafLink Customer API
  version: '2022-10-31'
  description: 'This reference specification outlines all the available HTTP operations of the LeafLink API.


    See the [LeafLink Developer Hub](/api) for guides, how-to, and general information of the API.

    '
  termsOfService: https://www.leaflink.com/terms-and-conditions/
  contact:
    email: support@leaflink.com
servers:
- url: https://api.leaflink.com
  description: LeafLink API production URL.
- url: https://staging-api.leaflink.com
  description: LeafLink API staging URL.
security:
- bearerAuth: []
tags:
- name: Customer
paths:
  /customer_statuses:
    get:
      operationId: customer_statuses_list
      description: List multiple Company Customer Status.
      summary: List Company Customer Status
      parameters:
      - in: query
        name: company_slug
        schema:
          type: string
      - in: query
        name: description
        schema:
          type: string
      - in: query
        name: hex_color
        schema:
          type: string
      - in: query
        name: id
        schema:
          type: integer
      - in: query
        name: is_stock
        schema:
          type: boolean
      - in: query
        name: order
        schema:
          type: integer
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - in: query
        name: owner
        schema:
          type: integer
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: state
        schema:
          type: string
      - name: LeafLink-Version
        description: '[API version docs](/api/getting-started/#versioning)'
        required: false
        in: header
        schema:
          type: string
          format: date
      tags:
      - Customer
      security:
      - bearerAuth: []
      responses:
        '200':
          description: A list of serialized Company Customer Status
          headers:
            RateLimit-Limit:
              schema:
                type: integer
              description: The requests quota in the time window.
            RateLimit-Remaining:
              schema:
                type: integer
              description: The remaining requests quota in the current window.
            RateLimit-Reset:
              schema:
                type: integer
              description: The time remaining in the current window, specified in seconds.
            RateLimit-Policy:
              schema:
                type: string
              description: The quota policy information.
        '429':
          description: Rate Limit Error
          headers:
            Retry-After:
              schema:
                type: integer
              description: The time remaining before the rejected request can be tried again, specified in seconds.
  /customer_statuses/{id}:
    get:
      operationId: customer_statuses_retrieve
      description: Get a single Company Customer Status.
      summary: Get Company Customer Status
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this company customer status.
        required: true
      - name: LeafLink-Version
        description: '[API version docs](/api/getting-started/#versioning)'
        required: false
        in: header
        schema:
          type: string
          format: date
      tags:
      - Customer
      security:
      - bearerAuth: []
      responses:
        '200':
          description: A serialized Company Customer Status
          headers:
            RateLimit-Limit:
              schema:
                type: integer
              description: The requests quota in the time window.
            RateLimit-Remaining:
              schema:
                type: integer
              description: The remaining requests quota in the current window.
            RateLimit-Reset:
              schema:
                type: integer
              description: The time remaining in the current window, specified in seconds.
            RateLimit-Policy:
              schema:
                type: string
              description: The quota policy information.
        '429':
          description: Rate Limit Error
          headers:
            Retry-After:
              schema:
                type: integer
              description: The time remaining before the rejected request can be tried again, specified in seconds.
  /customers:
    get:
      operationId: customers_list
      description: List multiple Customers.
      summary: List Customers
      parameters:
      - in: query
        name: address
        schema:
          type: string
      - in: query
        name: address__in
        schema:
          type: string
      - in: query
        name: address__startswith
        schema:
          type: string
      - in: query
        name: archived
        schema:
          type: boolean
      - in: query
        name: brand
        schema:
          type: string
      - in: query
        name: brand__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: brand__startswith
        schema:
          type: string
      - in: query
        name: business_identifier
        schema:
          type: string
      - in: query
        name: business_identifier__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: business_identifier__startswith
        schema:
          type: string
      - in: query
        name: business_license_name
        schema:
          type: string
      - in: query
        name: business_license_name__in
        schema:
          type: string
      - in: query
        name: business_license_name__startswith
        schema:
          type: string
      - in: query
        name: company_slug
        schema:
          type: string
      - in: query
        name: created_on__gt
        schema:
          type: string
          format: date-time
      - in: query
        name: created_on__gte
        schema:
          type: string
          format: date-time
      - in: query
        name: created_on__lt
        schema:
          type: string
          format: date-time
      - in: query
        name: created_on__lte
        schema:
          type: string
          format: date-time
      - in: query
        name: dba
        schema:
          type: string
      - in: query
        name: dba__in
        schema:
          type: string
      - in: query
        name: dba__startswith
        schema:
          type: string
      - in: query
        name: delinquent
        schema:
          type: boolean
      - in: query
        name: discount_percent__gt
        schema:
          type: number
      - in: query
        name: discount_percent__gte
        schema:
          type: number
      - in: query
        name: discount_percent__lt
        schema:
          type: number
      - in: query
        name: discount_percent__lte
        schema:
          type: number
      - in: query
        name: ein
        schema:
          type: string
      - in: query
        name: ein__in
        schema:
          type: string
      - in: query
        name: ein__startswith
        schema:
          type: string
      - in: query
        name: email
        schema:
          type: string
      - in: query
        name: email__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: email__startswith
        schema:
          type: string
      - in: query
        name: ext_acct_id
        schema:
          type: string
      - in: query
        name: ext_acct_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: ext_acct_id__isnull
        schema:
          type: boolean
      - in: query
        name: ext_acct_id__startswith
        schema:
          type: string
      - in: query
        name: external_id
        schema:
          type: string
      - in: query
        name: external_id__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: external_id__startswith
        schema:
          type: string
      - in: query
        name: external_id_key
        schema:
          type: string
        description: Filter by external ID key (integration system name)
      - in: query
        name: external_id_unmapped
        schema:
          type: boolean
      - in: query
        name: external_id_values
        schema:
          type: string
      - in: query
        name: id
        schema:
          type: array
          items:
            type: integer
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: id__in
        schema:
          type: array
          items:
            type: integer
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: is_archived
        schema:
          type: boolean
      - in: query
        name: leaflink_source
        schema:
          type: boolean
      - in: query
        name: license_inactive
        schema:
          type: boolean
      - in: query
        name: license_number
        schema:
          type: string
      - in: query
        name: license_type
        schema:
          type: string
      - in: query
        name: modified__gt
        schema:
          type: string
          format: date-time
      - in: query
        name: modified__gte
        schema:
          type: string
          format: date-time
      - in: query
        name: modified__lt
        schema:
          type: string
          format: date-time
      - in: query
        name: modified__lte
        schema:
          type: string
          format: date-time
      - in: query
        name: name
        schema:
          type: string
      - in: query
        name: name__in
        schema:
          type: string
      - in: query
        name: name__startswith
        schema:
          type: string
      - in: query
        name: next_contact_date__gt
        schema:
          type: string
          format: date
      - in: query
        name: next_contact_date__gte
        schema:
          type: string
          format: date
      - in: query
        name: next_contact_date__lt
        schema:
          type: string
          format: date
      - in: query
        name: next_contact_date__lte
        schema:
          type: string
          format: date
      - in: query
        name: nickname
        schema:
          type: string
      - in: query
        name: nickname__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: nickname__startswith
        schema:
          type: string
      - in: query
        name: old_license_number
        schema:
          type: string
      - in: query
        name: old_license_number__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: old_license_number__startswith
        schema:
          type: string
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - in: query
        name: owner
        schema:
          type: integer
      - in: query
        name: owner__slug
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: partner
        schema:
          type: integer
      - in: query
        name: payment_term
        schema:
          type: array
          items:
            type: integer
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: phone
        schema:
          type: string
      - in: query
        name: phone__in
        schema:
          type: string
      - in: query
        name: phone__startswith
        schema:
          type: string
      - in: query
        name: price_schedule
        schema:
          type: array
          items:
            type: integer
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: service_zone
        schema:
          type: array
          items:
            type: integer
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: state
        schema:
          type: array
          items:
            type: integer
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: status
        schema:
          type: array
          items:
            type: integer
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: tier
        schema:
          type: array
          items:
            type: integer
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: website
        schema:
          type: string
      - in: query
        name: website__in
        schema:
          type: string
      - in: query
        name: website__startswith
        schema:
          type: string
      - name: LeafLink-Version
        description: '[API version docs](/api/getting-started/#versioning)'
        required: false
        in: header
        schema:
          type: string
          format: date
      tags:
      - Customer
      security:
      - bearerAuth: []
      responses:
        '200':
          description: A list of serialized customers
          headers:
            RateLimit-Limit:
              schema:
                type: integer
              description: The requests quota in the time window.
            RateLimit-Remaining:
              schema:
                type: integer
              description: The remaining requests quota in the current window.
            RateLimit-Reset:
              schema:
                type: integer
              description: The time remaining in the current window, specified in seconds.
            RateLimit-Policy:
              schema:
                type: string
              description: The quota policy information.
        '429':
          description: Rate Limit Error
          headers:
            Retry-After:
              schema:
                type: integer
              description: The time remaining before the rejected request can be tried again, specified in seconds.
  /customers/{id}:
    get:
      operationId: customers_retrieve
      description: Get a single Customer.
      summary: Get Customer
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this company customer.
        required: true
      - name: LeafLink-Version
        description: '[API version docs](/api/getting-started/#versioning)'
        required: false
        in: header
        schema:
          type: string
          format: date
      tags:
      - Customer
      security:
      - bearerAuth: []
      responses:
        '200':
          description: A serialized customer
          headers:
            RateLimit-Limit:
              schema:
                type: integer
              description: The requests quota in the time window.
            RateLimit-Remaining:
              schema:
                type: integer
              description: The remaining requests quota in the current window.
            RateLimit-Reset:
              schema:
                type: integer
              description: The time remaining in the current window, specified in seconds.
            RateLimit-Policy:
              schema:
                type: string
              description: The quota policy information.
        '429':
          description: Rate Limit Error
          headers:
            Retry-After:
              schema:
                type: integer
              description: The time remaining before the rejected request can be tried again, specified in seconds.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Authentication is done via access tokens (JWTs). See the [API authentication doc](/api/getting-started/#authentication) for more information.

        '
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"