List of sites that the current user has access to
Use page[number] and page[size] parameters to paginate results:
GET /v1/sites?page[number]=1&page[size]=10GET /v1/sites?page[number]=2&page[size]=25The response includes pagination links and meta data:
{
"links": {
"self": "https://api.kajabi.com/v1/sites?page[number]=2&page[size]=10",
"first": "https://api.kajabi.com/v1/sites?page[number]=1&page[size]=10",
"prev": "https://api.kajabi.com/v1/sites?page[number]=1&page[size]=10",
"next": "https://api.kajabi.com/v1/sites?page[number]=3&page[size]=10",
"last": "https://api.kajabi.com/v1/sites?page[number]=5&page[size]=10"
},
"meta": {
"total_pages": 5,
"total_count": 50,
"current_page": 2
}
}
Use the sort parameter to sort the results:
GET /v1/sites?sort=titleGET /v1/sites?sort=-titleResponse will include sites sorted by the specified field
{
"data": [
{
"id": "123",
"type": "sites",
"attributes": {
"title": "Advanced Training Site",
"subdomain": "advanced-training"
}
},
{
"id": "456",
"type": "sites",
"attributes": {
"title": "Beginner Training Site",
"subdomain": "beginner-training"
}
}
]
}
Use the fields[sites] parameter to request only specific attributes:
GET /v1/sites?fields[sites]=title,subdomainResponse will only include requested fields
{
"data": [{
"id": "123",
"type": "sites",
"attributes": {
"title": "Advanced Training Site",
"subdomain": "advanced-training"
}
}]
}
Use the filter[title_cont] parameter to find sites where the title contains specific text:
GET /v1/sites?filter[title_cont]=trainingResponse will include sites with matching titles
{
"data": [{
"id": "123",
"type": "sites",
"attributes": {
"title": "Advanced Training Site",
"subdomain": "advanced-training"
}
},
{
"id": "456",
"type": "sites",
"attributes": {
"title": "Beginner Training Site",
"subdomain": "beginner-training"
}
}]
}
Use the filter[subdomain_cont] parameter to find sites where the subdomain contains specific text:
GET /v1/sites?filter[subdomain_cont]=trainingResponse will include sites with matching subdomains
{
"data": [{
"id": "123",
"type": "sites",
"attributes": {
"title": "Advanced Training Site",
"subdomain": "advanced-training"
}
},
{
"id": "456",
"type": "sites",
"attributes": {
"title": "Beginner Training Site",
"subdomain": "beginner-training"
}
}]
}
You can combine pagination, sorting and sparse fields in a single request:
GET /v1/sites?page[number]=2&page[size]=10&sort=-title&fields[sites]=title,subdomainResponse will include paginated sites with sparse fields
{
"data": [
{
"id": "456",
"type": "sites",
"attributes": {
"title": "Beginner Training Site",
"subdomain": "beginner-training"
}
}
],
"links": {
"self": "https://api.kajabi.com/v1/sites?page[number]=2&page[size]=10&sort=-title&fields[sites]=title,subdomain",
"first": "https://api.kajabi.com/v1/sites?page[number]=1&page[size]=10&sort=-title&fields[sites]=title,subdomain",
"prev": "https://api.kajabi.com/v1/sites?page[number]=1&page[size]=10&sort=-title&fields[sites]=title,subdomain",
"next": null,
"last": "https://api.kajabi.com/v1/sites?page[number]=2&page[size]=10&sort=-title&fields[sites]=title,subdomain"
},
"meta": {
"total_pages": 2,
"total_count": 15,
"current_page": 2
}
}
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Sort order, use: title, subdomain, for descending order use '-' e.g. &sort=-title
Number of documents
Partial attributes as specified, e.g. fields[sites]=title,subdomain
Filter by title contains, for example ?filter[title_cont]=training
Filter by subdomain contains, for example ?filter[subdomain_cont]=training