Example Operations

Below are several example GraphQL API requests with their responses.

There are sections for both queries and mutations.

If you'd like us to provide an example of a specific operation, please let us know by emailing support@paminga.com.

Queries

Retrieve a Single Contact by Email Address

Request:

query ContactByEmail {
  contactByEmail(email: "michael@paminga.com") {
    id
    email
    title
    first_name
    last_name
    identity
    account {
      id
      name
      website
    }
  }
}

Response:

{
  "data": {
    "contactByEmail": {
      "id": "976963867",
      "email": "michael@paminga.com",
      "title": "Founder & CEO",
      "first_name": "Michael",
      "last_name": "Ward",
      "identity": "Michael Ward (michael@paminga.com)",
      "account": {
        "id": "14902486",
        "name": "Paminga",
        "website": "https://www.paminga.com"
      }
    }
  }
}

Retrieve Multiple Contacts With a Single Where Condition

Request:

query PamingaLeads {
  contacts(
    first: 10
    page: 1
    where: { column: EMAIL, operator: LIKE, value: "%@paminga.com"}
    entityType: LEAD
  ) {
    paginatorInfo {
      count
      currentPage
      firstItem
      hasMorePages
      lastItem
      lastPage
      perPage
      total
    }
    data {
      id
      email
      title
      first_name
      last_name
      account {
        id
        name
      }
      custom_fields(ids: ["25262"]) {
        name
        type
        value
      }
    }
  }
}

Response

{
  "data": {
    "contacts": {
      "paginatorInfo": {
        "count": 10,
        "currentPage": 1,
        "firstItem": 1,
        "hasMorePages": true,
        "lastItem": 10,
        "lastPage": 3,
        "perPage": 10,
        "total": 27
      },
      "data": [
        {
          "id": "1002106503",
          "email": "exampleOne@paminga.com",
          "title": "Example Lead One",
          "first_name": "Example",
          "last_name": "Lead One",
          "account": {
            "id": "63159761",
            "name": "Example Account"
          },
          "custom_fields": [
            {
              "name": "ERP in Use",
              "type": "TEXT",
              "value": "IFS"
            }
          ]
        },
        {
          "id": "1002106504",
          "email": "exampleTwo@paminga.com",
          "title": "Example Lead Two",
          "first_name": "Example",
          "last_name": "Lead Two",
          "account": {
            "id": "63159761",
            "name": "Example Account"
          },
          "custom_fields": [
            {
              "name": "ERP in Use",
              "type": "TEXT",
              "value": "IFS"
            }
          ]
        } ...[8 more contacts would appear here]
      ]
    }
  }
}

Retrieve Multiple Contacts With Multiple Where Conditions

Request:

query NonBouncedPamingaContacts {
  contacts(
    first: 50
    page: 1
    where: {
      AND: [
        { column: EMAIL, operator: LIKE, value: "%@paminga.com" }
        { column: BOUNCED, operator: EQ, value: false }
      ]
    }
    entityType: CONTACT
  ) {
    paginatorInfo {
      count
      currentPage
      firstItem
      hasMorePages
      lastItem
      lastPage
      perPage
      total
    }
    data {
      id
      email
      title
      first_name
      last_name
      account {
        id
        name
      }
      custom_fields(ids: ["25262"]) {
        name
        type
        value
      }
    }
  }
}

Response

{
  "data": {
    "contacts": {
      "paginatorInfo": {
        "count": 50,
        "currentPage": 1,
        "firstItem": 1,
        "hasMorePages": true,
        "lastItem": 50,
        "lastPage": 2,
        "perPage": 50,
        "total": 64
      },
      "data": [
        {
          "id": "1002106503",
          "email": "exampleOne@paminga.com",
          "title": "Example Lead One",
          "first_name": "Example",
          "last_name": "Lead One",
          "account": {
            "id": "63159761",
            "name": "Example Account"
          },
          "custom_fields": [
            {
              "name": "ERP in Use",
              "type": "TEXT",
              "value": "IFS"
            }
          ]
        },
        {
          "id": "1002106504",
          "email": "exampleTwo@paminga.com",
          "title": "Example Lead Two",
          "first_name": "Example",
          "last_name": "Lead Two",
          "account": {
            "id": "63159761",
            "name": "Example Account"
          },
          "custom_fields": [
            {
              "name": "ERP in Use",
              "type": "TEXT",
              "value": "IFS"
            }
          ]
        } ...[48 more contacts would appear here]
      ]
    }
  }
}

Retrieve Unsubscribes In A Given Date Range

Request:

query Unsubscribes {
  unsubscribes(
    where: {
      AND: [
        { column: UNSUBSCRIBED_AT, operator: GTE, value: "2024-11-06 15:00:00" }
        { column: UNSUBSCRIBED_AT, operator: LTE, value: "2024-11-06 17:00:00" }
      ]
    }
    first: 10
    page: 1
  ) {
    paginatorInfo {
      count
      currentPage
      firstItem
      hasMorePages
      lastItem
      lastPage
      perPage
      total
    }
    data {
      unsubscribed_at
      contact {
        id
        email
      }
    }
  }
}

Response:

{
  "data": {
    "unsubscribes": {
      "paginatorInfo": {
        "count": 3,
        "currentPage": 1,
        "firstItem": 1,
        "hasMorePages": false,
        "lastItem": 3,
        "lastPage": 1,
        "perPage": 10,
        "total": 3
      },
      "data": [
        {
          "unsubscribed_at": "2024-11-06 16:31:25",
          "contact": {
            "id": "895003377",
            "email": "example@domainOne.com"
          }
        },
        {
          "unsubscribed_at": "2024-11-06 16:18:21",
          "contact": {
            "id": "895000994",
            "email": "example@domainTwo.com"
          }
        },
        {
          "unsubscribed_at": "2024-11-06 15:24:34",
          "contact": {
            "id": "895001009",
            "email": "example@domainThree.com"
          }
        }
      ]
    }
  }
}

Mutations

Create a Contact

Request:

mutation CreateContact {
  createContact(
    input: {
      first_name: "Michael"
      last_name: "Ward"
      email: "sample@paminga.com"
      title: "Founder & CEO"
    }
  ) {
    id
    email
    title
    first_name
    last_name
  }
}

Response:

{
  "data": {
    "createContact": {
      "id": "1024188619",
      "email": "sample@paminga.com",
      "title": "Founder & CEO",
      "first_name": "Michael",
      "last_name": "Ward"
    }
  }
}

Add Contacts to a Marketing List

Request:

mutation AddContactsToList {
  addContactsToList(
    input: {
      email_addresses: ["michael@paminga.com", "acase@paminga.com"]
      list_id: 602926
    }
  ) {
    id
    first_name
    last_name
    email
  }
}

Response:

{
  "data": {
    "addContactsToList": [
      {
        "id": "934778554",
        "first_name": "Amanda",
        "last_name": "Case",
        "email": "acase@paminga.com",
      },
      {
        "id": "976963867",
        "first_name": "Michael",
        "last_name": "Ward",
        "email": "michael@paminga.com",
      }
    ]
  }
}