Kajabi API V1 (0.4.0)

Request access_token and refresh_token

There are three ways to exchange parameters for tokens

1. Provide client credentials client_id and client_secret
2. Provide a refresh_token
3. Provide username and password (client credentials is preferred)

Using grant_type=client_credentials

Only include params: client_id, client_secret, and grant_type.

• The grant_type param value must be: client_credentials

Using grant_type=refresh_token

Only include params: refresh_token and grant_type.

• The grant_type param value must be: refresh_token
• The refresh_token must be a unexpired JWT token, from a prior client credential token grant.

Using username and password

Only include params: username and password.

Response

A successful response will provide access_token and refresh_token values.

• Use the access_token in your Authorization header as a "Bearer" token to make authenticated requests to the API. E.g. GET https://api.kajabi.com/v1/me
• Store the refresh_token to exchange for a new access_token when it expires.
• Tokens may be invalidated using the v1/oauth/revoke endpoint to "log out".

Attributes

• access_token (string) - The access token for the API session
• refresh_token (string) - The refresh token for the API session
• token_type (string) - The type of token, always Bearer
• expires_in (integer) - The number of seconds the access token will be valid for

Revoke an access_token and refresh_token

Either token may be provided to "log out" of the API session. Both tokens we be invalidated.

• Only include param: token with your access_token or refresh_token
• Requires an Authorization header as Bearer access_token to authenticate the request.

Response

• A successful response will have an empty body
• An error response will include a JSON body with error details.

Tags (not archived) for a site

Contact Tag Attributes

• name (string) - The name of the contact tag

Pagination

Use the page[number] and page[size] query parameters to paginate results:

Get first page of 10 items

• GET /v1/contact_tags?page[number]=1&page[size]=10

Get second page of 25 items

• GET /v1/contact_tags?page[number]=2&page[size]=25

The response includes pagination links and meta data:

{
  "links": {
    "self": "https://api.kajabi.com/v1/contact_tags?page[number]=2&page[size]=10",
    "first": "https://api.kajabi.com/v1/contact_tags?page[number]=1&page[size]=10",
    "prev": "https://api.kajabi.com/v1/contact_tags?page[number]=1&page[size]=10",
    "next": "https://api.kajabi.com/v1/contact_tags?page[number]=3&page[size]=10",
    "last": "https://api.kajabi.com/v1/contact_tags?page[number]=5&page[size]=10"
  },
  "meta": {
    "total_pages": 5,
    "total_count": 50,
    "current_page": 2
  }
}

Filter by Site ID

Use the filter[site_id] parameter to get contact tags for a specific site:

Get contact tags for site with ID 123

• GET /v1/contact_tags?filter[site_id]=123

Response will only include contact tags for that site

{
  "data": [{
    "id": "456",
    "type": "contact_tags",
    "attributes": {
      "name": "Source"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "123",
          "type": "sites"
        }
      }
    }
  }]
}

Filter by Name Contains

Use the filter[name_cont] parameter to find contact tags where the name contains specific text:

Get contact tags with names containing "vip"

• GET /v1/contact_tags?filter[name_cont]=vip

Response will include contact tags with matching names

{
  "data": [{
    "id": "456",
    "type": "contact_tags",
    "attributes": {
      "name": "VIP Customer"
    }
  }]
}

Using Multiple Parameters Together

You can combine pagination, sorting, sparse fields and filtering in a single request:

Get page 2 of contact tags for site 123, sorted by name descending

• GET /v1/contact_tags?page[number]=2&page[size]=10&sort=-name&filter[site_id]=123

Response will include only requested fields, sorted and paginated

{
  "data": [{
    "id": "456",
    "type": "contact_tags",
    "attributes": {
      "name": "Webinar Attendee"
    }
  }, {
    "id": "789",
    "type": "contact_tags",
    "attributes": {
      "name": "VIP Customer"
    }
  }],
  "links": {
    "self": "https://api.kajabi.com/v1/contact_tags?page[number]=2&page[size]=10&sort=-name&fields[contact_tags]=name,handle&filter[site_id]=123",
    "first": "https://api.kajabi.com/v1/contact_tags?page[number]=1&page[size]=10&sort=-name&fields[contact_tags]=name,handle&filter[site_id]=123",
    "prev": "https://api.kajabi.com/v1/contact_tags?page[number]=1&page[size]=10&sort=-name&fields[contact_tags]=name,handle&filter[site_id]=123",
    "next": "https://api.kajabi.com/v1/contact_tags?page[number]=3&page[size]=10&sort=-name&fields[contact_tags]=name,handle&filter[site_id]=123",
    "last": "https://api.kajabi.com/v1/contact_tags?page[number]=5&page[size]=10&sort=-name&fields[contact_tags]=name,handle&filter[site_id]=123"
  },
  "meta": {
    "total_pages": 5,
    "total_count": 50,
    "current_page": 2
  }
}

Contact Tag Attributes

• name (string) - The name of the contact tag

Contact Tag Relationships

The contact tag belongs to a site

Create a contact for a site.

Contact attributes

• New contact does not support external_user_id attribute.
• See custom_fields endpoint to discover attributes for using custom fields attributes.

Create a contact

Request body must include a site relationship. Example request body:

{
  "data": {
    "type": "contacts",
    "attributes": {
      "name": "John Doe",
      "email": "[email protected]"
    },
    "relationships": {
      "site": {
        "data": {
          "type": "sites",
          "id": "123"
        }
      }
    }
  }
}

Response will include the newly created contact resource.

{
  "data": {
    "id": "456",
    "type": "contacts",
    "attributes": {
      "name": "John Doe",
      "email": "[email protected]",
      "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"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "123",
          "type": "sites"
        }
      }
    }
  }
}

List of contacts, we recommended filtering by site.

Filtering

Use the filter[site_id] parameter to filter contacts by site:

Get contacts for site with ID 123

• GET /v1/contacts?filter[site_id]=123

Response will include only contacts for the specified site

{
  "data": [{
    "id": "456",
    "type": "contacts",
    "attributes": {
      "name": "John Smith",
      "email": "[email protected]",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "123",
          "type": "sites"
        }
      }
    }
  }]
}

Search Filter

Use the filter[search] parameter along with filter[site_id] to search contacts by name or email:

Search for contacts containing "smith" in site with ID 123

• GET /v1/contacts?filter[site_id]=123&filter[search]=smith

Response will include only matching contacts for the specified site

{
  "data": [{
    "id": "456",
    "type": "contacts",
    "attributes": {
      "name": "John Smith",
      "email": "[email protected]",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "123",
          "type": "sites"
        }
      }
    }
  }]
}

Using Indexed Data Search

Use the use_indexed_data parameter along with filter[site_id] and filter[search] to search contacts using an alternative search algorithm:

Search for contacts containing "smith" in site with ID 123 using indexed data

• GET /v1/contacts?filter[site_id]=123&filter[search]=smith&use_indexed_data=true

Response will include matching contacts using the indexed search algorithm

{
  "data": [{
    "id": "456",
    "type": "contacts",
    "attributes": {
      "name": "John Smith",
      "email": "[email protected]",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "123",
          "type": "sites"
        }
      }
    }
  }]
}

Using Pagination with Site Filter

Use the filter[site_id] parameter along with pagination parameters page[number] and page[size] to get paginated results for a specific site:

Get page 2 of contacts from site with ID 123, with 10 items per page

• GET /v1/contacts?filter[site_id]=123&page[number]=2&page[size]=10

Response will include paginated contacts for the specified site along with pagination metadata

{
  "data": [{
    "id": "456",
    "type": "contacts",
    "attributes": {
      "name": "John Smith",
      "email": "[email protected]",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "123",
          "type": "sites"
        }
      }
    }
  }],
  "links": {
    "self": "https://api.kajabi.com/v1/contacts?filter[site_id]=123&page[number]=2&page[size]=10",
    "first": "https://api.kajabi.com/v1/contacts?filter[site_id]=123&page[number]=1&page[size]=10",
    "prev": "https://api.kajabi.com/v1/contacts?filter[site_id]=123&page[number]=1&page[size]=10",
    "next": "https://api.kajabi.com/v1/contacts?filter[site_id]=123&page[number]=3&page[size]=10",
    "last": "https://api.kajabi.com/v1/contacts?filter[site_id]=123&page[number]=5&page[size]=10"
  },
  "meta": {
    "total_pages": 5,
    "total_count": 50,
    "current_page": 2
  }
}

Using Sort with Site Filter

• The default Sorting is by created_at in descending order (newest first)

Sorting by created_at in ascending order (oldest first)

• GET /v1/contacts?filter[site_id]=123&sort=created_at

Use the sort parameter along with filter[site_id] to get sorted results for a specific site:

Get contacts from site with ID 123, sorted by name in ascending order

• GET /v1/contacts?filter[site_id]=123&sort=name

Get contacts from site with ID 123, sorted by email in descending order

• GET /v1/contacts?filter[site_id]=123&sort=-email

Response will include sorted contacts for the specified site

{
  "data": [{
    "id": "456",
    "type": "contacts",
    "attributes": {
      "name": "Alice Smith",
      "email": "[email protected]",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "123",
          "type": "sites"
        }
      }
    }
  }]
}

Using Sparse Fields with Site Filter

Use the fields[contacts] parameter along with filter[site_id] to get specific fields for contacts in a site:

Get only name and email fields for contacts from site with ID 123

• GET /v1/contacts?filter[site_id]=123&fields[contacts]=name,email

Response will include only requested fields for contacts in the specified site

{
  "data": [{
    "id": "456",
    "type": "contacts",
    "attributes": {
      "name": "Alice Smith",
      "email": "[email protected]"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "123",
          "type": "sites"
        }
      }
    }
  }]
}

Filtering by Site and Offer

Use the filter[site_id] parameter along with filter[has_offer_id] to get contacts who have been granted a specific offer

Get contacts from site with ID 123 who have been granted offer with ID 789

• GET /v1/contacts?filter[site_id]=123&filter[has_offer_id]=789

Response will include only contacts from the specified site who have been granted the offer

{
  "data": [{
    "id": "456",
    "type": "contacts",
    "attributes": {
      "name": "Alice Smith",
      "email": "[email protected]",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "123",
          "type": "sites"
        }
      }
    }
  }]
}

Filtering by Site and Product

Use the filter[site_id] parameter along with filter[has_product_id] to get contacts who have purchased a specific product

Get contacts from site with ID 123 who have purchased product with ID 789

• GET /v1/contacts?filter[site_id]=123&filter[has_product_id]=789

Response will include only contacts from the specified site who have purchased the product

{
  "data": [{
    "id": "456",
    "type": "contacts",
    "attributes": {
      "name": "Alice Smith",
      "email": "[email protected]",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "123",
          "type": "sites"
        }
      }
    }
  }]
}

Filtering by Site and Tag

Use the filter[site_id] parameter along with filter[has_tag_id] to get contacts who have a specific tag

Get contacts from site with ID 123 who have tag with ID 456

• GET /v1/contacts?filter[site_id]=123&filter[has_tag_id]=456

Response will include only contacts from the specified site who have the tag

{
  "data": [{
    "id": "789",
    "type": "contacts",
    "attributes": {
      "name": "Bob Jones",
      "email": "[email protected]",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "123",
          "type": "sites"
        }
      }
    }
  }]
}

Using Multiple Parameters Together

You can combine multiple parameters to filter, search, paginate and format the response:

Get paginated contacts from site 123 with tag 456, searching for "smith", using indexed data and sparse fields

• GET /v1/contacts?filter[site_id]=123&filter[has_tag_id]=456&filter[search]=smith&use_indexed_data=true&page[number]=1&page[size]=10&fields[contacts]=name,email

Response will include paginated contacts matching all filters with only requested fields

{
  "data": [{
    "id": "789",
    "type": "contacts",
    "attributes": {
      "name": "John Smith",
      "email": "[email protected]"
    }
  }],
  "links": {
    "self": "https://api.kajabi.com/v1/contacts?filter[site_id]=123&filter[has_tag_id]=456&filter[search]=smith&use_indexed_data=true&page[number]=1&page[size]=10&fields[contacts]=name,email",
    "first": "https://api.kajabi.com/v1/contacts?filter[site_id]=123&filter[has_tag_id]=456&filter[search]=smith&use_indexed_data=true&page[number]=1&page[size]=10&fields[contacts]=name,email",
    "prev": null,
    "next": null,
    "last": "https://api.kajabi.com/v1/contacts?filter[site_id]=123&filter[has_tag_id]=456&filter[search]=smith&use_indexed_data=true&page[number]=1&page[size]=10&fields[contacts]=name,email"
  },
  "meta": {
    "total_pages": 1,
    "total_count": 1,
    "current_page": 1
  }
}

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": "[email protected]",
      "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": "[email protected]",
        "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": "[email protected]"
    }
  }
}

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": "[email protected]"
    },
    "relationships": {}
  },
  "included": [
    {
      "id": "321",
      "type": "customers",
      "attributes": {
        "net_revenue": "0.0"
      }
    }
  ]
}

Contact attributes

• A contact with a related customer resource does support external_user_id attribute.
• See custom_fields endpoint to discover attributes for using custom fields attributes.

Update a contact

Example request body:

{
  "data": {
    "type": "contacts",
    "id": "456",
    "attributes": {
      "phone_number": "12134567890"
    }
  }
}

Response will include the update contact resource.

{
  "data": {
    "id": "456",
    "type": "contacts",
    "attributes": {
      "name": "John Doe",
      "email": "[email protected]",
      "address_line_1": null,
      "address_line_2": null,
      "address_city": null,
      "address_country": null,
      "address_state": null,
      "address_zip": null,
      "phone_number": "12134567890",
      "business_number": null,
      "subscribed": false,
      "external_user_id": null,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "123",
          "type": "sites"
        }
      }
    }
  }
}

Get the contact's relationship to offers (granted).

Response is a list of resource identifiers

{
  "data": [
    { "type": "offers", "id": "123" },
    { "type": "offers", "id": "456" }
  ]
}

The related tag resources are available using the GET api/v1/offers endpoint. The resource identifier includes the offer id and type. Example URLs: /api/v1/offers/123, /api/v1/offers/456

Grant offer(s) to a contact

Create an offer grant for a contact which results in creating a new customer record for your contact.

In the request body inlcude offer resource identifier(s), id: OFFER_ID, type: "offers".

To skip sending a welcome email to the customer include a meta object in the request body.

{ "data": [{"type": "offers", "id": "123"}], "meta": {"send_customer_welcome_email": false}}

The meta attribute send_customer_welcome_email as false will prevent sending the welcome email.

(The default behavior is to send the welcome email.)

Response

• A successful response body will list the offers related to the contact
• An error response will include a JSON body with error details.

Behaviors and side effects

• Checks if the contact was already granted the offer
• Checks for existing customerby email
  • If no existing customer, generates a new customer record with contact details
• May send a welcome email to the customer
• May send a gift granted email if this is a gift offer
• Triggers automations if configured

Revoke offer grant(s) for a contact

Revoke offer grant(s) using a list of resource identifiers In the request body inlcude offer resource identifier(s), id: OFFER_ID, type: "offers".

{ "data": [{"type": "offers", "id": "123"}] }

Response

• A successful response body will list the offers related to the contact
• An error response will include a JSON body with error details.

Behaviors and side effects

• Only affects active offers
• Handles both offer purchases and offer grants
• Deactivates all associated product memberships

Replace offer grant(s) for a contact

Replace offer grants (grants and revokes offers to/from contact) using a list of resource identifiers In the request body inlcude offer resource identifier(s), id: OFFER_ID, type: "offers".

{ "data": [{"type": "offers", "id": "456"}, {"type": "offers", "id": "789"}] }

Response

• A successful response body will list the offers related to the contact
• An error response will include a JSON body with error details.

Get the contact's relationship to tags, response is a list of resource identifiers

Response is a list of resource identifiers

{
  "data": [
    { "type": "contact_tags", "id": "123" },
    { "type": "contact_tags", "id": "456" }
  ]
}

The related tag resources are available using the GET api/v1/contact_tags endpoint. The resource identifier includes the contact tag id and type. Example URLs: /api/v1/contact_tags/123, /api/v1/contact_tags/456

Add tag relationships to contact resource using a list of resource identifiers

Request body includes a list of resource identifiers, id: CONTACT_TAG_ID, type: "contact_tags".

{ "data": [{ "type": "contact_tags", "id": "456" }] }

The response body will include the updated list of tag relationships.

Example response body:

{ "data": [{ "type": "contact_tags", "id": "123" }, { "type": "contact_tags", "id": "456" }] }

Remove tag relationships to contact resource using a list of resource identifiers.

Request body includes a list of resource identifiers, id: CONTACT_TAG_ID, type: "contact_tags".

{ "data": [{ "type": "contact_tags", "id": "456" }] }

The response body will include the updated list of tag relationships.

Example response body:

{ "data": [{ "type": "contact_tags", "id": "123" }] }

Replace tag relationships to contact resource using a list of resource identifiers.

Request body includes a list of resource identifiers, id: CONTACT_TAG_ID, type: "contact_tags".

{ "data": [{ "type": "contact_tags", "id": "123" }, { "type": "contact_tags", "id": "456" }] }

The response body will include the updated list of tag relationships.

{ "data": [{ "type": "contact_tags", "id": "123" }, { "type": "contact_tags", "id": "456" }] }

List of courses that can be offered to a contact or purchased

Pagination

Use the page[number] and page[size] query parameters to paginate results:

Get first page of 10 items

• GET /v1/courses?page[number]=1&page[size]=10

Get second page of 25 items

• GET /v1/courses?page[number]=2&page[size]=25

The response includes pagination links and meta data:

{
  "links": {
    "self": "https://api.kajabi.com/v1/courses?page[number]=2&page[size]=10",
    "first": "https://api.kajabi.com/v1/courses?page[number]=1&page[size]=10",
    "prev": "https://api.kajabi.com/v1/courses?page[number]=1&page[size]=10",
    "next": "https://api.kajabi.com/v1/courses?page[number]=3&page[size]=10",
    "last": "https://api.kajabi.com/v1/courses?page[number]=5&page[size]=10"
  },
  "meta": {
    "total_pages": 5,
    "total_count": 50,
    "current_page": 2
  }
}

Sorting

Use the sort parameter to sort the results:

Sort by title in ascending order

• GET /v1/courses?sort=title

Sort by title in descending order

• GET /v1/courses?sort=-title

Response will include courses sorted by the specified field

{
  "data": [
    {
      "id": "123",
      "type": "courses",
      "attributes": {
        "title": "Advanced Marketing",
        "description": "Master level marketing course",
        "status": "active"
      }
    },
    {
      "id": "456",
      "type": "courses",
      "attributes": {
        "title": "Marketing Basics",
        "description": "Introduction to marketing",
        "status": "active"
      }
    }
  ]
}

Sparse Fields

Use the fields parameter to request only specific attributes:

Only return title and thumbnail_url attributes

• GET /v1/courses?fields[courses]=title,thumbnail_url

Response will only include requested fields

{
  "data": [{
    "id": "123",
    "type": "courses",
    "attributes": {
      "title": "Marketing Fundamentals",
      "thumbnail_url": "https://example.com/thumbnail.jpg"
    }
  }]
}

Filter by Site ID

Use the filter[site_id] parameter to get courses for a specific site:

Get courses for site with ID 123

• GET /v1/courses?filter[site_id]=123

Response will only include courses for that site

{
  "data": [{
    "id": "456",
    "type": "courses",
    "attributes": {
      "title": "Marketing Fundamentals",
      "description": "Introduction to marketing concepts",
      "status": "active"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "123",
          "type": "sites"
        }
      }
    }
  }]
}

Filter by Title Contains

Use the filter[title_cont] parameter to find courses where the title contains specific text:

Get courses with titles containing "marketing"

• GET /v1/courses?filter[title_cont]=marketing

Response will include courses with matching titles

{
  "data": [{
    "id": "456",
    "type": "courses",
    "attributes": {
      "title": "Marketing Fundamentals",
      "description": "Introduction to marketing concepts",
      "status": "active"
    }
  }]
}

Filter by Description Contains

Use the filter[description_cont] parameter to find courses where the description contains specific text:

Get courses with descriptions containing "marketing"

• GET /v1/courses?filter[description_cont]=marketing

Response will include courses with matching descriptions

{
  "data": [{
    "id": "456",
    "type": "courses",
    "attributes": {
      "title": "Marketing Fundamentals",
      "description": "Introduction to marketing concepts and strategies",
      "status": "active"
    }
  }]
}

Using Multiple Parameters Together

You can combine pagination, sparse fields, filtering and sorting in a single request:

Get first page of 10 courses for site 123, sorted by title, showing only specific fields

• GET /v1/courses?page[number]=1&page[size]=10&filter[site_id]=123&sort=title&fields[courses]=title,thumbnail_url

Response will include pagination, sorted filtered results with requested fields

{
  "data": [{
    "id": "456",
    "type": "courses",
    "attributes": {
      "title": "Advanced Marketing",
      "thumbnail_url": "https://example.com/thumbnail1.jpg"
    }
  },
  {
    "id": "789",
    "type": "courses",
    "attributes": {
      "title": "Marketing Basics",
      "thumbnail_url": "https://example.com/thumbnail2.jpg"
    }
  }],
  "links": {
    "self": "https://api.kajabi.com/v1/courses?page[number]=1&page[size]=10&filter[site_id]=123&sort=title&fields[courses]=title,thumbnail_url",
    "first": "https://api.kajabi.com/v1/courses?page[number]=1&page[size]=10&filter[site_id]=123&sort=title&fields[courses]=title,thumbnail_url",
    "next": "https://api.kajabi.com/v1/courses?page[number]=2&page[size]=10&filter[site_id]=123&sort=title&fields[courses]=title,thumbnail_url",
    "last": "https://api.kajabi.com/v1/courses?page[number]=3&page[size]=10&filter[site_id]=123&sort=title&fields[courses]=title,thumbnail_url"
  },
  "meta": {
    "total_pages": 3,
    "total_count": 25,
    "current_page": 1
  }
}

Details of a course that can be offered to a contact or purchased

Course Attributes

• created_at (string) - The date and time the course was created
• title (string) - The title of the course
• description (string) - The description of the course
• thumbnail_url (string) - The URL of the course thumbnail

Including Relationships

Use the include query parameter to load related resources:

Include modules, lessons and related media, and offers

• GET /v1/courses/123?include=modules,lessons,lessons.media,offers

Response will include the requested related resources (Note: The responses listed within the "included" array will also include the relationships for each resource)

{
  "data": {
    "id": "123",
    "type": "courses",
    "attributes": {
      "created_at": "2024-08-06T05:30:38.669Z",
      "title": "Advanced Marketing",
      "description": "Master level marketing course",
      "thumbnail_url": "https://example.com/thumbnail.jpg"
    },
    "relationships": {
      "modules": {
        "data": [{
          "id": "456",
          "type": "modules"
        }]
      },
      "lessons": {
        "data": [{
          "id": "789",
          "type": "lessons"
        }]
      },
      "offers": {
        "data": [{
          "id": "101",
          "type": "offers"
        }]
      }
    },
    "included": [{
      "id": "456",
      "type": "modules",
      "attributes": {
        "title": "Marketing Fundamentals",
        "description": "Introduction to marketing concepts",
        "position": 1,
        "poster_image_url": "https://example.com/poster.jpg",
        "publishing_option": "published"
      }
    },
    {
      "id": "789",
      "type": "lessons",
      "attributes": {
        "title": "Marketing Basics",
        "position": 1,
        "status": "published",
        "publishing_option": "published"
      }
    },
    {
      "id": "202",
      "type": "media",
      "attributes": {
        "duration_in_minutes": 1,
      }
    },
    {
      "id": "101",
      "type": "offers",
      "attributes": {
        "price": 100.0,
        "currency": "USD",
        "status": "active"
      }
    }]
  }
}

Module attributes

Modules are part of Kajabi's course structure: courses contain modules and modules contain lessons

• title (string) - A required field that represents the name or heading of the module. This is used to:
  • Identify and display the module in the course outline
  • Organize related lessons/content
  • Provide navigation structure in the course
  • The title must be unique within a course.
• description (string) - An optional text field that provides additional information about the module's content. This can be used to:
  • Give students an overview of what they'll learn
  • Explain the module's objectives
  • Provide context for the contained lessons
  • Help students understand the module's purpose in the course structure
• position (integer) - A numeric field that determines the order of modules within a course. This:
  • Used for sorting
  • Allows modules to be reordered
  • Maintains the course's logical progression
  • Is used for navigation between modules
  • Starts at position 1 for the first module
• poster_image_url (string) - A URL to an image that represents the module visually. This:
  • Can be uploaded through the Kajabi admin interface
  • Is used as a thumbnail/preview image
  • Helps with visual organization of the course
• publishing_option (string) - Controls the visibility and availability of the module. Options include:
  • published - Module is visible and available to students
  • draft - Module is hidden and not yet available
  • Can be used with drip settings for timed release
  • Affects the visibility of contained lessons
  • Syncs with the course's overall publishing status

Lesson attributes

Lessons can include various types of content: text content (body), videos, audio, quizzes, assessments, and downloads.

• title (string) - A required field that represents the name or heading of the lesson. This:
  • Must be present
  • Has a maximum length of 200 characters
  • Is used for display and navigation
  • Can be searched (using pg_search)
  • Is used in course outlines and navigation
• position (integer) - A numeric field that determines the order of lessons within a module (category). This:
  • Usedfor sorting (ranks :sort, column: :position)
  • Is scoped within each module
  • Allows lessons to be reordered
  • Maintains the logical flow of content
  • Is used for navigation between lessons
• status (string) - An field that tracks the lesson's processing state:
  • ready - Default state, lesson is ready for use
  • duplicating - Lesson is being copied
  • failed - An error occurred during processing
  • This is particularly relevant for lessons with media content or during duplication.
• publishing_option (string) - Controls the visibility and availability of the lesson. Options include:
  • draft - Lesson is hidden and not yet available to students
  • published - Lesson is visible and available (sets publish_at to current time)
  • drip - Lesson becomes available after a specified number of days
  • locked - Lesson is locked until certain conditions are met (e.g., completing previous lessons)

Media attributes

• duration_in_minutes (float) - The length of a media file (typically video or audio) in minutes.

Sparse Fields

Use the fields parameter to request only specific attributes:

Only return title and thumbnail_url attributes

• GET /v1/courses/123?fields[courses]=title,thumbnail_url

Response will only include requested fields

{
  "data": {
    "id": "123",
    "type": "courses",
    "attributes": {
      "title": "Marketing Fundamentals",
      "thumbnail_url": "https://example.com/thumbnail.jpg"
    }
  }
}

Using Multiple Parameters Together

You can combine sparse fields and include in a single request:

Get course details with modules and lessons, showing only specific fields

• GET /v1/courses/123?include=modules,lessons,lessons.media&fields[courses]=title,thumbnail_url&fields[modules]=title&fields[lessons]=title&fields[media]=duration_in_minutes

Response will include related resources with requested fields

{
  "data": {
    "id": "123",
    "type": "courses",
    "attributes": {
      "title": "Marketing Fundamentals",
      "thumbnail_url": "https://example.com/thumbnail.jpg"
    },
    "relationships": {}
  },
  "included": [{
    "id": "456",
    "type": "modules",
    "attributes": {
      "title": "Marketing Basics"
    }
  },
  {
    "id": "789",
    "type": "lessons",
    "attributes": {
      "title": "Marketing Strategies"
    }
  },
  {
    "id": "101",
    "type": "media",
    "attributes": {
      "duration_in_minutes": 30
    }
  }]
}