Contact details

curl --request GET \
  --url https://api.kajabi.com/v1/contacts/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.kajabi.com/v1/contacts/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.kajabi.com/v1/contacts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kajabi.com/v1/contacts/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kajabi.com/v1/contacts/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.kajabi.com/v1/contacts/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.kajabi.com/v1/contacts/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "type": "<string>",
    "attributes": {
      "name": "<string>",
      "email": "<string>",
      "phone_number": "<string>",
      "business_number": "<string>",
      "subscribed": true,
      "address_line_1": "<string>",
      "address_line_2": "<string>",
      "address_city": "<string>",
      "address_state": "<string>",
      "address_country": "<string>",
      "external_user_id": "<string>",
      "address_zip": "<string>",
      "custom_1": "<string>",
      "custom_2": "<string>",
      "custom_3": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "relationships": {
      "customer": {
        "data": {
          "id": "<string>",
          "type": "<string>"
        }
      },
      "offers": {
        "data": [
          {
            "id": "<string>",
            "type": "<string>"
          }
        ],
        "links": {
          "self": "<string>"
        }
      },
      "site": {
        "data": {
          "id": "<string>",
          "type": "<string>"
        }
      },
      "tags": {
        "data": [
          {
            "id": "<string>",
            "type": "<string>"
          }
        ]
      }
    },
    "links": {
      "customer": "<string>"
    }
  },
  "links": {
    "self": "<string>",
    "current": "<string>"
  }
}

{
  "errors": [
    {
      "status": "<string>",
      "source": {
        "pointer": "<string>"
      },
      "title": "<string>",
      "detail": "<string>"
    }
  ]
}

{
  "errors": [
    {
      "status": "<string>",
      "source": {
        "pointer": "<string>"
      },
      "title": "<string>",
      "detail": "<string>"
    }
  ]
}

Contacts

Contact details

Show details for a contact

Contact Attributes

name (string) - The name of the contact
email (string) - The email of the contact, must be a valid and deliverable email address
address_line_1 (string) - The first line of the contact’s address
address_line_2 (string) - The second line of the contact’s address
address_city (string) - The city of the contact’s address
address_country (string) - The country of the contact’s address
address_state (string) - The state of the contact’s address
address_zip (string) - The zip code of the contact’s address
phone_number (string) - The phone number of the contact
business_number (string) - The business phone number of the contact
subscribed (boolean) - Whether the contact has opted in to receive marketing communications from the site
external_user_id (string) - The external user ID of the contact/customer; this field is only updatable if the contact has been granted an offer or made a purchase
created_at (string) - The date and time the contact was created
updated_at (string) - The date and time the contact was last updated

Including Relationships

Use the include parameter to include related resources in the response:

GET /v1/contacts/123?include=offers,tags,customer

Response will include the related contact offers, tags and customer resources

{
  "data": {
    "id": "123",
    "type": "contacts",
    "attributes": {
      "name": "John Smith",
      "email": "john@example.com",
      "address_line_1": null,
      "address_line_2": null,
      "address_city": null,
      "address_country": null,
      "address_state": null,
      "address_zip": null,
      "phone_number": null,
      "business_number": null,
      "subscribed": false,
      "external_user_id": null,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    "links": {
      "customer": "https://api.kajabi.com/v1/customers/321"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "123",
          "type": "sites"
        }
      },
      "offers": {
        "links": {
          "data": [
            { "id": "456", "type": "offers" }
          ],
          "self": "https://api.kajabi.com/v1/contacts/123/relationships/offers"
        }
      },
      "tags": {
        "data": [
          { "id": "789", "type": "contact_tags" }
        ],
        "links": {
          "self": "https://api.kajabi.com/v1/contacts/123/relationships/tags"
        }
      },
      "customer": {
        "data": {
          "id": "321",
          "type": "customers"
        }
      }
    }
  },
  "included": [
    {
      "id": "456",
      "type": "offers",
      "attributes": {
        "name": "Offer 1",
        "description": "Offer 1 description",
        "internal_title": "Offer 1",
        "price_in_cents": 0,
        "payment_type": "free",
        "token": "offer_123",
        "payment_method": "none",
        "price_description": "Free",
        "checkout_url": "https://mywebsite.com/offers/456",
        "recurring_offer": false,
        "subscription": false,
        "one_time": true,
        "single": false,
        "free": true
      }
    },
    {
      "id": "789",
      "type": "contact_tags",
      "attributes": {
        "name": "Tag Name"
      }
    },
    {
      "id": "321",
      "type": "customers",
      "attributes": {
        "name": "John Smith",
        "email": "john@example.com",
        "avatar": null,
        "external_user_id": "cust_123",
        "public_bio": null,
        "public_location": null,
        "public_website": null,
        "socials": null,
        "net_revenue": "0.0",
        "sign_in_count": 0,
        "last_request_at": null,
        "bounced_at": null,
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-15T10:30:00Z"
      }
    }
  ]
}

Sparse Fields

Use the fields[contacts] parameter to get specific fields for a contact:

GET /v1/contacts/123?fields[contacts]=name,email

Response will include only requested fields for the contact

{
  "data": {
    "id": "123",
    "type": "contacts",
    "attributes": {
      "name": "John Smith",
      "email": "john@example.com"
    }
  }
}

Using Multiple Parameters Together

You can combine multiple parameters to include related resources and get specific fields for a contact:

GET /v1/contacts/123?include=customer&fields[contacts]=email&fields[customers]=net_revenue

Response will include the related customer resource and only requested fields for the contact and customer

{
  "data": {
    "id": "123",
    "type": "contacts",
    "attributes": {
      "email": "sam@example.com"
    },
    "relationships": {}
  },
  "included": [
    {
      "id": "321",
      "type": "customers",
      "attributes": {
        "net_revenue": "0.0"
      }
    }
  ]
}

GET

contacts

{id}

Contact details

curl --request GET \
  --url https://api.kajabi.com/v1/contacts/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.kajabi.com/v1/contacts/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.kajabi.com/v1/contacts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kajabi.com/v1/contacts/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kajabi.com/v1/contacts/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.kajabi.com/v1/contacts/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.kajabi.com/v1/contacts/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "type": "<string>",
    "attributes": {
      "name": "<string>",
      "email": "<string>",
      "phone_number": "<string>",
      "business_number": "<string>",
      "subscribed": true,
      "address_line_1": "<string>",
      "address_line_2": "<string>",
      "address_city": "<string>",
      "address_state": "<string>",
      "address_country": "<string>",
      "external_user_id": "<string>",
      "address_zip": "<string>",
      "custom_1": "<string>",
      "custom_2": "<string>",
      "custom_3": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "relationships": {
      "customer": {
        "data": {
          "id": "<string>",
          "type": "<string>"
        }
      },
      "offers": {
        "data": [
          {
            "id": "<string>",
            "type": "<string>"
          }
        ],
        "links": {
          "self": "<string>"
        }
      },
      "site": {
        "data": {
          "id": "<string>",
          "type": "<string>"
        }
      },
      "tags": {
        "data": [
          {
            "id": "<string>",
            "type": "<string>"
          }
        ]
      }
    },
    "links": {
      "customer": "<string>"
    }
  },
  "links": {
    "self": "<string>",
    "current": "<string>"
  }
}

{
  "errors": [
    {
      "status": "<string>",
      "source": {
        "pointer": "<string>"
      },
      "title": "<string>",
      "detail": "<string>"
    }
  ]
}

{
  "errors": [
    {
      "status": "<string>",
      "source": {
        "pointer": "<string>"
      },
      "title": "<string>",
      "detail": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Query Parameters

include

string

with ?include=offers,tags,customer the response will include the related contact offers, tags and customer resources

fields[contacts]

string

Sparse fields, use: name, email for example ?fields[contacts]=name,email

Response

Success, shows details for specified contact and tags relationship

data

object

Show child attributes

links

object

Show child attributes

Create a contact

Delete contact

Overview

Authentication

Blog posts

Contact Notes

Contact Tags

Contacts

Courses

Custom Fields

Customers

Forms

Webhooks

Kajabi Payments Payouts

Landing pages

Me

Offers

Orders

Podcasts

Products

Purchases

Sites

Transactions

Version

Contact details

Contact Attributes

Including Relationships

Sparse Fields

Using Multiple Parameters Together

Authorizations

Path Parameters

Query Parameters

Response