Your First API Call

From zero to a working CRM in 5 minutes. No installation, no configuration — just API calls.

Step 1: Register

mutation {
  register(data: {
    displayname: "My Agent"
    email: "agent@myapp.com"
    password: "secure-password-123"
    password_confirmation: "secure-password-123"
  }) {
    token
    user { id displayname default_company }
  }
}

Save the token. You'll use it for all subsequent requests.

Step 2: Verify

query {
  me { id displayname email default_company roles { name } }
}

Step 3: Create a Contact

mutation {
  createPeople(input: {
    firstname: "John"
    lastname: "Smith"
    email: "john@acme.com"
    contacts: [{ contacts_types_id: 1, value: "+1-555-0100" }]
  }) {
    id uuid name email
  }
}

Step 4: Create an Organization

mutation {
  createOrganization(input: {
    name: "Acme Corp"
    address: "123 Business Ave"
  }) {
    id uuid name
  }
}

Step 5: Create a Lead

mutation {
  createLead(input: {
    title: "First deal with Acme"
    people_id: 1
    organization_id: 1
    pipeline_stage_id: 1
  }) {
    id uuid title
    status { name }
    stage { name }
    people { name }
  }
}

Step 6: Query Your Data

query {
  leads(first: 10, orderBy: [{ column: CREATED_AT, order: DESC }]) {
    data {
      id title
      people { name email }
      organization { name }
      status { name }
      pipeline { name }
      stage { name }
      created_at
    }
    paginatorInfo { total }
  }
}

You now have a working CRM through the API. From here, explore Inventory, Commerce, Messaging, and Workflows to build out your full operational backend.