Skip to content

Contacts

The people and companies you work with.

Open Contacts
Checked against the dashboard on November 20, 2026

Contacts has no microservice of its own. Its public methods belong to the account microservice, which also holds Profiles, and to the team microservice for friend requests. Each one acts for the account whose API key you use.

Groups, tags, custom fields, Keep in touch, the duplicate check, the import and choosing a plan have no public method today. Those are done in the dashboard.

Send a request to a method with your key:

curl -s https://xuda.ai/cpi/create_contact \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_API_KEY","name":"Dana Levi","email":"[email protected]","company":"Levi Studio"}'
const res = await fetch('https://xuda.ai/cpi/create_contact', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    api_key: 'YOUR_API_KEY',
    name: 'Dana Levi',
    email: '[email protected]',
    company: 'Levi Studio',
  }),
});
const { code, data } = await res.json();
import requests

res = requests.post(
    'https://xuda.ai/cpi/create_contact',
    json={
        'api_key': 'YOUR_API_KEY',
        'name': 'Dana Levi',
        'email': '[email protected]',
        'company': 'Levi Studio',
    },
)

A refused request answers a negative code and says why in data. Most of the methods below also take an optional workspace_id, to act in a workspace you own other than your home one.

Read contacts

get_contacts lists the contacts.

  • _id or contact_id returns one contact.
  • search filters the list by a search string, and name by a name.
  • filter_type narrows the list, for example to archived, shared, pinned, favorites or online. Left out, it lists the active contacts together with the requests to connect that are waiting.
  • with_requests set to true adds the pending requests, sent and received, to a filtered list too.
  • tag lists the contacts that carry one tag, folder_id lists one folder (send __none__ for the contacts in no folder), and group_id lists the members of one contact group.
  • profile_id reads the contacts of another profile of yours. limit, skip and bookmark page the list.

Add a contact

create_contact adds a person by hand. It takes name and email, which are required, and optionally phone, company, job_title, and account_type set to personal or business, which saves a model the work of guessing.

  • The email is the book's key. Sending one you already hold returns the existing contact instead of a second copy.
  • source records where the contact came from, manual when you send none, and context is one line that shows on the contact's activity.
  • profile_id files the contact under another profile of yours.
  • Nobody is asked anything and no email is sent. It is the same as Add without invitation in the dashboard.

To bring a list in from code, call it once per person.

Friend requests

  • add_contact_member sends a request to another Xuda user, found by access_email or by to_uid.
  • get_contact_members lists your requests and connections, each with the other person's card. stat takes one request status, or several, to list.
  • unfriend_contact takes a contact_id and ends the connection. The contact stays in your book.

Organize a contact

Each of these takes a contact_id.

Archive and delete

Deleting cannot be undone

A contact deleted with delete_contact is gone. Archive is the step to use when you only want a contact out of the way.

How is this guide?

Last updated on November 15, 2026