Leads

Types

type CrmLead {
    id: ID
    estimatedCheckIn: string
    estimatedCheckOut: string
    applicationStatus: string
    building: Building # See building page
    contact: CrmContact # See crm contact page
    status {
        id: ID
        internalReference: string
        stepResult: string
    }
    totalAdults: number
    totalChildren: number
    uniqueReference: string
    verified: boolean
}

Search / List leads

input CrmLeadsSearchQueryInput {
   workspaceIds: ID[]
}

query {
    crm {
       leads {
          search(
             q: CrmLeadsSearchQueryInput
          ) {
             edges {
                node {
                   # CrmLead
                }
             }
          }   
       }
    }
}

* For brevity cursor types have been excluded - See Pagination (Cursors)

** For brevity most connection keys have been excluded - See Connections

Create Lead

This functionality is now documented via the API Explorer

Get lead

query {
    crm {
       lead(leadId: ID) {
          # CrmLead
       }
    }
}

Edit lead

mutation {
    crm {
       leads {
          update(
             leadId: ID
             data: CrmLead
          ) {
             # CrmLead
          }   
       }
    }
}

Delete lead

mutation {
    crm {
       leads {
          delete(
             leadId: ID
          ) 
       }
    }
}