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"
      }
    }
  ]
}