Exemples de requêtes

Ces exemples montrent des requêtes basiques pour chaque requête de premier niveau dans l’API. Pour les détails complets des arguments et des types de retour, consultez les pages de référence des requêtes et les pages de référence des types.

Requête Organisation

Voir : requête organisation · type Organisation

query GetOrganisation($id: ID!) {
  organisation(id: $id) {
    id
    name
    retention
    pdfRetention
    attachmentRetention
    textRetention
    created
    userCount
  }
}

Requête Template

Voir : requête template · type Template

query GetTemplate($id: ID!) {
  template(id: $id) {
    id
    title
    pageCount
    fileName
    link
    autoArchive
    valid
    locked
    tags
    groupId
    archived
    createdBy
    lastSent
    created
    modified
  }
}

Requête Experience

Voir : requête experience · type Experience

query GetExperience($id: ID!) {
  experience(id: $id) {
    id
    name
    header
    text1
    text2
    text3
    allowSignatureReuse
    attachDraft
    backgroundColour
    defaultExperience
    language
    created
    modified
  }
}

Requête Document

Voir : requête document · type Document

query GetDocument($id: ID!) {
  document(id: $id) {
    id
    name
    link
    status
    hash
    created
    modified
    senderName
    senderEmail
    batchId
    batchName
    taskId
    certifyDocument
    sendMethod
  }
}

Requête Batch

Voir : requête batch · type Batch

query GetBatch($id: ID!) {
  batch(id: $id) {
    id
    name
    enforceOrder
    type
    creatorName
    documentCount
    inProgressCount
    rejectedCount
    completedCount
    bouncedCount
    created
    modified
    status
    progress
  }
}

Requête Group

Voir : requête group · type Group

query GetGroup($id: ID!) {
  group(id: $id) {
    id
    name
    publicName
    attachmentRetention
    pdfRetention
    retention
    textRetention
    apiIntegration
    certifyDocuments
    sequentialSend
    stopPDFPrinting
    stopPDFCopying
    licensesRemaining
    credit
  }
}

Requête Contact Group

Voir : requête contactGroup · type ContactGroup

query GetContactGroup($id: ID!) {
  contactGroup(id: $id) {
    id
    name
    colour
    contacts {
      id
      name
      firstName
      lastName
      email
      timeZone
      phoneNumber
    }
  }
}

Requête User

Voir : requête user · type User

query GetUser($id: ID) {
  user(id: $id) {
    id
    name
    firstName
    lastName
    email
    timeZone
    companySize
    companyRole
    companyType
    lastDocumentSentAt
    lastValidTemplateMadeAt
    uploadedTemplatesCount
    webhookHmacSecret
  }
}

Requête Task

Voir : requête task

query GetTask($id: ID!) {
  task(id: $id) {
    data
    report {
      status
      batchId
      documents
      errors
    }
  }
}

Requête Draft

Voir : requête draft · type Draft

query GetDraft($id: ID!) {
  draft(id: $id) {
    id
    name
    shared
    templateCount
    batch
    multidoc
    version
    created
    modified
    link
  }
}

Requête Recipient

Voir : requête recipient · type Recipient

query GetRecipient($id: ID!) {
  recipient(id: $id) {
    id
    phoneNumber
    firstName
    lastName
    email
    role
    roleType
    status
    authentication
    timeZone
    experience
    expiryDate
    skipped
    nominate
    detailsTBD
    emailOpenedDateTime
    documentFirstViewedDateTime
    signedDateTime
    sentDateTime
    emailProblem
    recipientOrder
  }
}

Requête Invoice

Voir : requête invoice · type Invoice

query GetInvoice($id: ID!) {
  invoice(id: $id) {
    id
    created
    supplyDate
    currency
    paymentSystem
    invoiceNumber
    taxRate
    subTotal
    totalIncTax
    creditReason
    customerName
    address1
    postcode
    link
  }
}

Requête Node

Voir : requête node

query GetNode($id: ID!) {
  node(id: $id) {
    id
  }
}

Requête Upload

Voir : requête upload · Comment télécharger des fichiers

query GetUpload($id: ID!, $uploadType: UploadType!, $extension: String!) {
  upload(id: $id, uploadType: $uploadType, extension: $extension) {
    url
  }
}