Beam API Package

Introduction to the BeamAPI schema.
The following page explains how to set up and the usage of the Beam API package.
The Beam endpoint can be found at - http://localhost:8000/graphiql/beam​
Beam API Queries
GetBeam
Get beam details by its code and optional account.
Query
Response
query GetBeam {
  GetBeam(code: "0dd3694f2c4599179f08686539cd73dc") {
    id
    code
    name
    description
    image
    start
    end
    isClaimable
    claimsRemaining    
    qr {
      url
      payload
    }
    message {
      walletPublicKey
      message
    }
    collection {
      collectionId
      maxTokenCount
      maxTokenSupply
      forceSingleMint
      frozen
      network
    }    
  }
}
​
{
  "data": {
    "GetBeam": {
      "id": 1,
      "code": "0dd3694f2c4599179f08686539cd73dc",
      "name": "236",
      "description": "This is the most awesome Beam ever.",
      "image": "https://en.wikipedia.org/wiki/Firefox#/media/File:Firefox_logo,_2019.svg",
      "start": "2022-11-14T00:00:00+00:00",
      "end": "2028-11-14T00:00:00+00:00",
      "isClaimable": true,
      "claimsRemaining": 10,
      "qr": {
        "url": "https://chart.googleapis.com/chart?cht=qr&chs=512x512&chl=https://devplatform.enjinsandbox.com/claim/0dd3694f2c4599179f08686539cd73dc",
        "payload": "https://devplatform.enjinsandbox.com/claim/0dd3694f2c4599179f08686539cd73dc"
      },
      "message": null,
      "collection": null
    }
  }
}
GetBeams
Get an array of beam details optionally filtered by codes or names.
Query
Response
query GetBeams {
  GetBeams(codes: ["0dd3694f2c4599179f08686539cd73dc"]) {
    totalCount
    pageInfo {
      hasPreviousPage
      hasNextPage
      startCursor
      endCursor
    }
    edges {
      node {
        id
        code
        name
        description
        image
        start
        end
        isClaimable
        qr {
          url
          payload
        }
        collection {
          collectionId
          maxTokenCount
          maxTokenSupply
          forceSingleMint
          frozen
          network
        }
        claims {
          totalCount
          pageInfo {
            hasPreviousPage
            hasNextPage
            startCursor
            endCursor
          }
          edges {
            node {
              id
              claimedAt
              claimStatus
              quantity
              code
              wallet {
                account {
                  publicKey
                  address
                }
              }
              collection {
                collectionId
                maxTokenCount
                maxTokenSupply
                forceSingleMint
                frozen
                network
              }
            }
          }
        }
      }
    }
  }
}
{
  "data": {
    "GetBeams": {
      "totalCount": 1,
      "pageInfo": {
        "hasPreviousPage": false,
        "hasNextPage": false,
        "startCursor": "",
        "endCursor": ""
      },
      "edges": [
        {
          "node": {
            "id": 1,
            "code": "0dd3694f2c4599179f08686539cd73dc",
            "name": "236",
            "description": "This is the most awesome Beam ever.",
            "image": "https://en.wikipedia.org/wiki/Firefox#/media/File:Firefox_logo,_2019.svg",
            "start": "2022-11-14T00:00:00+00:00",
            "end": "2028-11-14T00:00:00+00:00",
            "isClaimable": true,
            "qr": {
              "url": "https://chart.googleapis.com/chart?cht=qr&chs=512x512&chl=https://devplatform.enjinsandbox.com/claim/0dd3694f2c4599179f08686539cd73dc",
              "payload": "https://devplatform.enjinsandbox.com/claim/0dd3694f2c4599179f08686539cd73dc"
            },
            "collection": null,
            "claims": {
              "totalCount": 10,
              "pageInfo": {
                "hasPreviousPage": false,
                "hasNextPage": false,
                "startCursor": "",
                "endCursor": ""
              },
              "edges": [
                {
                  "node": {
                    "id": 1,
                    "claimedAt": null,
                    "claimStatus": null,
                    "quantity": 10,
                    "code": "eyJpdiI6IllGcEg0L0lRL0x5c1BQeWIyVXdCL0E9PSIsInZhbHVlIjoiVmhtcTRqcUhoeFBPTGQ2QTNWOTQ5aWhOR3poVlJrOFo0QTVHeUpVSUZWcTFwaGR1YW1KMmN5YWJLZ2xKbW1WSSIsIm1hYyI6ImRiMGIyMTAyNjEwOTNkNWUwNTUxZWVkMDhlZGEyZjQ2YmQwMGY5MzhhYjA5ZjBmZmE4MDk4NmNiYTkzM2FiNWQiLCJ0YWciOiIifQ==",
                    "wallet": null,
                    "collection": null
                  }
                },
                {
                  "node": {
                    "id": 2,
                    "claimedAt": null,
                    "claimStatus": null,
                    "quantity": 10,
                    "code": "eyJpdiI6ImllVllKclNObjk4QXdtZnRjVitLWmc9PSIsInZhbHVlIjoiQlozZzVQSHZWOTZibWxGSkkzcWxBMVNiMkFaZGcxcERGNitBOE1sMFVwZFJsdkE5OXBMVlNlRVZxOGN4eGZaRyIsIm1hYyI6IjI1NzQ5ZjRkOGMzMzBjMWRkNjY1YWZhYjllYjliYmE0OThmYmQ1MGFiMjhhYjhiNTA0ZDlkYWM2OTU5YzJmN2YiLCJ0YWciOiIifQ==",
                    "wallet": null,
                    "collection": null
                  }
                },
                {
                  "node": {
                    "id": 3,
                    "claimedAt": null,
                    "claimStatus": null,
                    "quantity": 10,
                    "code": "eyJpdiI6IjZYdUVWeTYwK0czRjM2THNHNVBJWFE9PSIsInZhbHVlIjoialhHbS93YkhnNldJa2JHeDFBMCt2V3ZLRDZkVi9INXgvdG1sOGxhSTJwWk12RE1HMEN2ZFZyY2d3dzRDQ0loNCIsIm1hYyI6IjVjOGE0ZGEyYzUzYWQzODgwZDJkNmNlZjM4YjY0YmZmOTcwNTVhNGIyNzUzYWNlYjMxOWNiNGE5OWZhY2NiNmYiLCJ0YWciOiIifQ==",
                    "wallet": null,
                    "collection": null
                  }
                },
                {
                  "node": {
                    "id": 4,
                    "claimedAt": null,
                    "claimStatus": null,
                    "quantity": 10,
                    "code": "eyJpdiI6Ik9TeDE3ZGMxODFHdXRwUTM4QXp3OUE9PSIsInZhbHVlIjoiaC9mUGtjTkd5RjNFdEk4WGFnNW5QOWJhVFVBR3ZrOXE3bTMrTm9GT01SVVV5NVpVRSt2RGtnQndnTld3TFRlZyIsIm1hYyI6IjdhNjgzYTJhMWQ2NzZlZWM1NTIyZWVkNjFkNzNjNzNlN2JhNmMyZTAyYzhmYTE2M2M1NzNlMTAxNTNlMDI3OGQiLCJ0YWciOiIifQ==",
                    "wallet": null,
                    "collection": null
                  }
                },
                {
                  "node": {
                    "id": 5,
                    "claimedAt": null,
                    "claimStatus": null,
                    "quantity": 10,
                    "code": "eyJpdiI6IlhYVVF0c0l0ZDNzS2g3a0hLU3JaeVE9PSIsInZhbHVlIjoiWWltZjlvMjJ1M0psRHJPUG1QRmUvVlZnR2RiREQyTWxYVU9pSUtNb2N2MWxqbzFmTVYxM0xiV3cxZWJ4NFg4TyIsIm1hYyI6IjdlOTExYTg5OTIwMDMxMTZkYmJlNGYwZjU5MjhkOWJlMzgyZWVhYzcyMDEwYzRkNzk5Zjk2OWU5YjZjODExNmYiLCJ0YWciOiIifQ==",
                    "wallet": null,
                    "collection": null
                  }
                },
                {
                  "node": {
                    "id": 6,
                    "claimedAt": null,
                    "claimStatus": null,
                    "quantity": 10,
                    "code": "eyJpdiI6IlVlUjBKeUhrZ092clBqMDVNaTNwOXc9PSIsInZhbHVlIjoiOUNhcUxaQkVDVlZFdnlBM3ZtTUJmWnl0bjN6YVNuUmRXbmoxWXZiOFpZOUFqaW9Od2Z0ZGdWMjF0S2llRHZEUyIsIm1hYyI6Ijg0YjY1ZWEzZGFjOWE5NjI2OTIwMjExNzc2NTNhZWZiMDI3OGQwZGQyZDEzYWJhMjg2OGExZWQyMzJiMmJlM2EiLCJ0YWciOiIifQ==",
                    "wallet": null,
                    "collection": null
                  }
                },
                {
                  "node": {
                    "id": 7,
                    "claimedAt": null,
                    "claimStatus": null,
                    "quantity": 10,
                    "code": "eyJpdiI6InAxU1I4QzlXcGp2RXRuSENCTkVzcnc9PSIsInZhbHVlIjoiL2J2a0UyK0trd0pJMVJ0QVI0NU9TanFuZmVCcUY3dG5TNW50YURzbXdwUkhBSVIyQTlnQnZHK0trTjh1am9pbiIsIm1hYyI6ImMzYzVkZDZmOTQ2OWRiODBmOTMwMWJkYzZhZTE0ZTkwZTczOGFlZjJkMmYzOTQzZjA1ZGMxNjExMmU5MjRiYjQiLCJ0YWciOiIifQ==",
                    "wallet": null,
                    "collection": null
                  }
                },
                {
                  "node": {
                    "id": 8,
                    "claimedAt": null,
                    "claimStatus": null,
                    "quantity": 10,
                    "code": "eyJpdiI6InVaRWlMYk1HSjdkZFRhWVlGQlRMK3c9PSIsInZhbHVlIjoidUJjTWpPODZRMThNeUF1T0hHaWJlUTB0a0thTXl5VnZFSHN4UjYzQk5uZ1NQR0lrNWR1NlY1VG5sU2cyZ0R6diIsIm1hYyI6ImZiZjhkY2JhOTY3MmUwZGI2YzYyZmQ4MGFkYmVjMzI2NzRiYWZmOWI4ZjgzMjNkYTRlZTc5MmEyNzZmN2E0MzciLCJ0YWciOiIifQ==",
                    "wallet": null,
                    "collection": null
                  }
                },
                {
                  "node": {
                    "id": 9,
                    "claimedAt": null,
                    "claimStatus": null,
                    "quantity": 10,
                    "code": "eyJpdiI6Ik14U2ZndlJiLzdsQktMckdQTGQxeHc9PSIsInZhbHVlIjoiUDBEWGNYcDk1ZExlZlMzNzRPWEdFeFliYmIwWWIxUElzaEpHSkQxb05xN2EyVVVucnd2dWQzTC9Ic3JzYnlSeSIsIm1hYyI6ImY4ODI0OGU0Mzc3NjVkMzZlODljYTI2YzhkNDU3N2MyMmNiZTM0YjZkMWQ3YjU2NjE0NmZlZjkyYjk0NjllOGQiLCJ0YWciOiIifQ==",
                    "wallet": null,
                    "collection": null
                  }
                },
                {
                  "node": {
                    "id": 10,
                    "claimedAt": null,
                    "claimStatus": null,
                    "quantity": 10,
                    "code": "eyJpdiI6InhiYWZqWlM3YTRhc01EYXZaR2pwRFE9PSIsInZhbHVlIjoiZXlwVytJbWNRT29VOThrR28wWldBa1l3Y3ZPMW5oUmdwUE02Snh1M2FDek4wOXpsS1FEVEFjNU9GV2psNWZCMyIsIm1hYyI6ImI3NTU3YTJjNWQzODQyNjllOGJmZTA5MjBlMjBhYTI3ZTA1Yjg1MmYzN2RiOWQ2MDJjMGRlMmY3Y2YxMDk2ODkiLCJ0YWciOiIifQ==",
                    "wallet": null,
                    "collection": null
                  }
                }
              ]
            }
          }
        }
      ]
    }
  }
}
GetClaims
Get an array of claim details optionally filtered by ids, codes, accounts, or states.
Query
Response
query GetClaims {
  GetClaims(
    codes: ["0dd3694f2c4599179f08686539cd73dc"]
  ) {
    edges {
      cursor
      node {
        id
        claimedAt
        claimStatus
        quantity
        wallet {
          account {
            publicKey
            address
          }
        }
        collection {
          collectionId
          maxTokenCount
          maxTokenSupply
          forceSingleMint
          frozen
          network
        }
        beam {
          id
          code          
        }
      }
    }
    totalCount
    pageInfo {
      startCursor
      endCursor
      hasPreviousPage
      hasNextPage
    }
  }
}
{
  "data": {
    "GetClaims": {
      "edges": [
        {
          "cursor": "eyJpZCI6MTAsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0",
          "node": {
            "id": 10,
            "claimedAt": null,
            "claimStatus": null,
            "quantity": 10,
            "wallet": null,
            "collection": null,
            "beam": {
              "id": 1,
              "code": "0dd3694f2c4599179f08686539cd73dc"
            }
          }
        },
        {
          "cursor": "eyJpZCI6OSwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ",
          "node": {
            "id": 9,
            "claimedAt": null,
            "claimStatus": null,
            "quantity": 10,
            "wallet": null,
            "collection": null,
            "beam": {
              "id": 1,
              "code": "0dd3694f2c4599179f08686539cd73dc"
            }
          }
        },
        {
          "cursor": "eyJpZCI6OCwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ",
          "node": {
            "id": 8,
            "claimedAt": null,
            "claimStatus": null,
            "quantity": 10,
            "wallet": null,
            "collection": null,
            "beam": {
              "id": 1,
              "code": "0dd3694f2c4599179f08686539cd73dc"
            }
          }
        },
        {
          "cursor": "eyJpZCI6NywiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ",
          "node": {
            "id": 7,
            "claimedAt": null,
            "claimStatus": null,
            "quantity": 10,
            "wallet": null,
            "collection": null,
            "beam": {
              "id": 1,
              "code": "0dd3694f2c4599179f08686539cd73dc"
            }
          }
        },
        {
          "cursor": "eyJpZCI6NiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ",
          "node": {
            "id": 6,
            "claimedAt": null,
            "claimStatus": null,
            "quantity": 10,
            "wallet": null,
            "collection": null,
            "beam": {
              "id": 1,
              "code": "0dd3694f2c4599179f08686539cd73dc"
            }
          }
        },
        {
          "cursor": "eyJpZCI6NSwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ",
          "node": {
            "id": 5,
            "claimedAt": null,
            "claimStatus": null,
            "quantity": 10,
            "wallet": null,
            "collection": null,
            "beam": {
              "id": 1,
              "code": "0dd3694f2c4599179f08686539cd73dc"
            }
          }
        },
        {
          "cursor": "eyJpZCI6NCwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ",
          "node": {
            "id": 4,
            "claimedAt": null,
            "claimStatus": null,
            "quantity": 10,
            "wallet": null,
            "collection": null,
            "beam": {
              "id": 1,
              "code": "0dd3694f2c4599179f08686539cd73dc"
            }
          }
        },
        {
          "cursor": "eyJpZCI6MywiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ",
          "node": {
            "id": 3,
            "claimedAt": null,
            "claimStatus": null,
            "quantity": 10,
            "wallet": null,
            "collection": null,
            "beam": {
              "id": 1,
              "code": "0dd3694f2c4599179f08686539cd73dc"
            }
          }
        },
        {
          "cursor": "eyJpZCI6MiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ",
          "node": {
            "id": 2,
            "claimedAt": null,
            "claimStatus": null,
            "quantity": 10,
            "wallet": null,
            "collection": null,
            "beam": {
              "id": 1,
              "code": "0dd3694f2c4599179f08686539cd73dc"
            }
          }
        },
        {
          "cursor": "eyJpZCI6MSwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ",
          "node": {
            "id": 1,
            "claimedAt": null,
            "claimStatus": null,
            "quantity": 10,
            "wallet": null,
            "collection": null,
            "beam": {
              "id": 1,
              "code": "0dd3694f2c4599179f08686539cd73dc"
            }
          }
        }
      ],
      "totalCount": 10,
      "pageInfo": {
        "startCursor": "",
        "endCursor": "",
        "hasPreviousPage": false,
        "hasNextPage": false
      }
    }
  }
}
GetSingleUseCodes
Get an array of single-use code details by its code, optionally filtered by after and first.
Query
Response
query GetSingleUseCodes {
  GetSingleUseCodes(code: "7cd390ab3d56c42b818d0a1aa2221c8f") {
    edges {
      cursor
      node {
        code
        qr {
          url
          payload
        }
      }
    }
    totalCount
    pageInfo {
      hasPreviousPage
      hasNextPage
      startCursor
      endCursor
    }
  }
}
{
  "data": {
    "GetSingleUseCodes": {
      "edges": [
        {
          "cursor": "eyJpZCI6ODAsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0",
          "node": {
            "code": "eyJpdiI6IlNFM2tRZzgxaU5pZi9hVXBVZTBCeVE9PSIsInZhbHVlIjoicDdsSmlCU1JHNnd6QUtHU1FRV2pNQ2twaDNPT2YreFVrK3Jrb1VXL0NPc2tOeFBVdTZFM2J1Ykp5NTlRNlNwZXg0d1JTbHo1N1BHMDJqaG11WDhDTGIxRVlVenBoTWVwT3ZrL3RwR2pZTzA9IiwibWFjIjoiYWI3ZjdhY2RmMzE2NGM1MjAxMWVmYTk2ZWNjNWQyNTY4MWQ4NGZhY2ZhN2M5Y2FmMmM0MzU5MDM1N2Q1NDFiYSIsInRhZyI6IiJ9",
            "qr": {
              "url": "https://chart.googleapis.com/chart?cht=qr&chs=512x512&chl=https://devplatform.enjinsandbox.com/claim/eyJpdiI6ImVMNTEybWEwSnZ6WlF3QjUvQW15Wmc9PSIsInZhbHVlIjoiVklOcCtCYVpGTG1aRjQyY0FZb3RmS1JSd1JGT0dka05rT1NQUnZoMXZ4UGsxVklzVmNoejhEUDQ5TjVMc0picjR4MmEzQUJTaWMrUVYxb21yMExZRWVjUGp1T2Rnb0owMHcwWmxXWCtGMnM9IiwibWFjIjoiMjUyNzdlODkyMTRkZmViM2M1OWY5MWNlYjgxYjUzOGE3NTA4NmU0NjY3MjIwOGY0ZDkxNTg3ZTJjOWM5NjUxMSIsInRhZyI6IiJ9",
              "payload": "https://devplatform.enjinsandbox.com/claim/eyJpdiI6IkJJWVNYb3lFVGRpaUNEemNJQ20xamc9PSIsInZhbHVlIjoic1ZXMzNGN1FnbWVRc1Z2S2IrYThIT0Rpd2JpeGhza2wxSG1FSlVqTUhzN3UrYmozaXNnZ2dSTU5HTmluZ2laY3JWNUcyemcyaDJZT1VGdGx6SjgxdGVwdUIvN1JhRHRVSnd2RFRYZVhOOUk9IiwibWFjIjoiNzllYmQ1MjFlODBmMWEzOTdjOTc0YWM0YjQ4M2ExZmEyOWZhNzQyY2RlNGJjMzcxNDdkOTQxOWJlYmYyMmUwMSIsInRhZyI6IiJ9"
            }
          }
        },
        {
          "cursor": "eyJpZCI6NzksIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0",
          "node": {
            "code": "eyJpdiI6InU2WkNYOWhTRlpUY2Q0ZnBmRUhrbXc9PSIsInZhbHVlIjoiR1Y2OXk0TWoxTVk3WitETWFqa3pWQW5JbUp5dXBVL2FiMG92Q2N3OXNsVWJtUTF2bWhCeWpxYXY0NGlzTHVUSTF5Qko0T1dkaFZpWTlNV1Z5NWxmU1M2NzBGdGNSZUFkajV3dXB1M2c2MkU9IiwibWFjIjoiZWFjODAxM2VlYWIxM2FhMjk3ZDFiZTdjZGY3OTRkOTBmZGEwYWQ0MjIxMWJkOGMzNDMxZDgxZGJlZmJjYjZhMSIsInRhZyI6IiJ9",
            "qr": {
              "url": "https://chart.googleapis.com/chart?cht=qr&chs=512x512&chl=https://devplatform.enjinsandbox.com/claim/eyJpdiI6IjVvVFkzNlpJRTgreVlxNWFYcHg2dUE9PSIsInZhbHVlIjoibS80TDRSVE5DUTVnSUFVSWZtUlVBaXdVaXVWS04wUHFqVXUrNlBLZndqUnFBdXlZU0tHeGc0bXB0eWJab2JJT1BwL1V3cVZkM0hvbzBPM0RDVTNqeWQza3hsRkFraUxLT3B1eVhDdUR3Sms9IiwibWFjIjoiZjVjZTg3Nzk4OTIwNjk4Nzk4MzA2MjFlYThkNzAzZmQ5M2QxNjg5MWM5MGQ0ZTcyNDk4MTE2MDcyMzc3YmY2ZiIsInRhZyI6IiJ9",
              "payload": "https://devplatform.enjinsandbox.com/claim/eyJpdiI6Im4rNmVxeGFheEx4VVNmeldId0lNU0E9PSIsInZhbHVlIjoiNmdMdHJVODRqSGtvZzdvSTdDMm93eEdnUGRPRktrOHVUSGpxSjZleUNxS0l2NjNjbzlLcklaTjNmUWpwUlczRGRXRWQzeWk1WDhGRHpkRmg1Q1AwTXZHY3F6aUc5U2xENVNJV2hGSExNMUE9IiwibWFjIjoiOTFiYmMzNTU3MjMwMzQwYWFhZWViNDIwNzNiOTNmMWQzZDk3NzQyMmE4ODdkZjIyNDFkZjFkODI1ZGI4MWFkMyIsInRhZyI6IiJ9"
            }
          }
        },
        {
          "cursor": "eyJpZCI6NzgsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0",
          "node": {
            "code": "eyJpdiI6IitFYk12S2dSUkloMUVpd2JwYXpRQ1E9PSIsInZhbHVlIjoibEJTakVrdFpHRTlOZFNwcjN4OUhsdUZQOFIxU2VXWTl5eXFqREFYdzl6TXEzQS80WThOajZPRjJlSXYySjdVTUJtVERTS3pqRW1JOEVrbDQ0UFJBRUtRVkR0bWV0U1Qvc1hxRnBQV2xubWc9IiwibWFjIjoiNDFmYzhkODAzZTk3NmJlZTRlMzc2MzVhNDA5OWQ1OWExMGY1MGY4ODE0MmYxMGIxZGZhNDAzMzM5ZTM2N2UwMSIsInRhZyI6IiJ9",
            "qr": {
              "url": "https://chart.googleapis.com/chart?cht=qr&chs=512x512&chl=https://devplatform.enjinsandbox.com/claim/eyJpdiI6Ijhtak0zYm1UZ3ZrU1NqaVNBemg0TGc9PSIsInZhbHVlIjoiSUhjbGNyWnpSZDFjVVQvaDloWTZrODV2L1NWb3ZVNzN0c09UOHU2d3VwVzc0Zkl1VjRIY2RUUzRUam5xVjVHaUIxWEpMMFByQzE1bUk1ZGU0S1NQWmZjbkJDOXp2NGphZllORnhwWWdTUjA9IiwibWFjIjoiNjkxYWNiYmNkNWNhZjhhYjg0NGI2NzNkNWFmY2NlZDM4ZTI5NmYwOTEwMjZjN2UzMjgxMGViNjA2NDhlOGEzYiIsInRhZyI6IiJ9",
              "payload": "https://devplatform.enjinsandbox.com/claim/eyJpdiI6Ii9Ba1VKS3dkNGlTZ0p3L1ZueTY1aVE9PSIsInZhbHVlIjoiSHdoVXlTbzA2RFFCdTR5elRWellTamF0aFBULzVLckxpS2JXNCswQlA3MEU1bmpRWjN4MWNaSE5SdVgrTjEzekJXY2RoOS9icjIvYlIvVU11YmJEV3NCcWVMaTBvdFhzTW90OFpaZUhkNUU9IiwibWFjIjoiYWQ2ZWMzNGVhYzFmMGQ4OTg0NzZiOWZmZWE1MTVmOTdjZDlkNDFhMjg1MzIxYTdjNTEzZTNlMmRjZDI4ZWI3OCIsInRhZyI6IiJ9"
            }
          }
        },
        {
          "cursor": "eyJpZCI6NzcsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0",
          "node": {
            "code": "eyJpdiI6InV5UkVQd1JHYU8yOTBtcVpYSW54OWc9PSIsInZhbHVlIjoiYlNrVExQSkpscnNFYng1aWlaaUJWZ0xnS2RqRGdMZ1hnTXRzMFFwNGEwSWdZNXczSkFwem5LSnN0cVdFSkxId3pOWGlEbDNmQ3JMOVBKdTREcVdpTTg5d2hvM3V6U2FSa3k0R013SVpGSDg9IiwibWFjIjoiMTIyZDgxYzY4YzNhYTcxNmY1NGNlZjYwMDQ2OTY2MzQ5MmM5NTVlMTFhNTFlZDlhZDc4N2UyZWM4ZDZkMTZlMiIsInRhZyI6IiJ9",
            "qr": {
              "url": "https://chart.googleapis.com/chart?cht=qr&chs=512x512&chl=https://devplatform.enjinsandbox.com/claim/eyJpdiI6Im5zVTBLQW83algrZHlFS2Vpd05xNXc9PSIsInZhbHVlIjoiM2hDRkpqdzV6bE1OQWUrSDdOZGZueEVZdXdUVGp1NVhndllwSTRmQzl1V2FldCtobEpHR2hUM3ltNW93L3RhMS9JZVRhOVVvbHVFbDJTZTRKb2x1Q0xkSU1kcGx2bXRWSnZFSHVBaUZNY1E9IiwibWFjIjoiN2Q2MGFjZTc1NTg0YTNlOGM5ODM5ZjAwYzA4NWEyNDYxMGNlNjNhYTcxNmRhMTE1MzA4ZmQ3NDdkMTYwNjVkYyIsInRhZyI6IiJ9",
              "payload": "https://devplatform.enjinsandbox.com/claim/eyJpdiI6ImVieFdZVENSNFFuV2N5dWdJZU13Wnc9PSIsInZhbHVlIjoiNUdxVkk2NjAvdUZsQnRZdGpVR3VmSDE2ZVY0K2dCRFBFN2VmZloxUE5rVUdKTFpzcWk2OW5aTm1Ra0JITjN6NEZPVGhldVR6ZmJ5TVdwN1B0UytiWUZwdzQzR0lLMFAxRTJnTEtFalBBcVU9IiwibWFjIjoiNjFkZjhmZjQ3MDk1MWUwZTRmMzM0NDYwMDJmNWMwNTNkMzhlMGRlNTVlNjc3ODAxMTFlOGRjMzhiYjRkOGQ2NyIsInRhZyI6IiJ9"
            }
          }
        },
        {
          "cursor": "eyJpZCI6NzYsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0",
          "node": {
            "code": "eyJpdiI6Ik1KVVluYVFGRDV5emVSMysycUVuWmc9PSIsInZhbHVlIjoiLzlRdGNPSTBvS0pXZC8vVk9WQ1NKTE1MSVdzZy9BTWxWWDhVT3JpNXAwYTZGbmE5VkZrNDNSb0dwYVZ2Q1hIWWpyeEdzT0paN3M0V3haSXAvaDhBcXBEdkw0WUlzS09KbnZCMEdRb3Qrd1E9IiwibWFjIjoiOWEzZDYwZGMwMWJkNzg2Zjc1ZGFhZjRjMzhiYzBhYzJmOWQyOGJkZmE1NGNmYWFlNjg2NjkzM2RmNWZiMmE4YiIsInRhZyI6IiJ9",
            "qr": {
              "url": "https://chart.googleapis.com/chart?cht=qr&chs=512x512&chl=https://devplatform.enjinsandbox.com/claim/eyJpdiI6IkJMMTVKdU1aSkNwNUh2bVJEQWRHM3c9PSIsInZhbHVlIjoid1lvWUVRcVBSY3U3OXRVMTdHTHdqMTRtMDFYQjhFTEZSMGpoVkdLbmpRbDBsUkhMYndxby9pclFpQ1F4RWVWcXJvNnpyTEk4VUVGUlE2S3haVTdpaTY2aWhZNEtTYkVvUGV3djNqWkNqQ0E9IiwibWFjIjoiOTIxYzNiN2RlZmU3OWJjYmRkY2UxNzQ1Y2NlNjc1ZGIyNmIyNDU5NDY5YjRmY2YzZjMwNDIyYjE4MTQ5MjExNCIsInRhZyI6IiJ9",
              "payload": "https://devplatform.enjinsandbox.com/claim/eyJpdiI6IlhDNXlHVkIyNFVYU3FNUVhJY3pNRnc9PSIsInZhbHVlIjoiUm1HSVJzdUhVb0ZqTzIyeDEzQ3F5SmNIa0ZQeXV6d1d1SGpjY2o5UDlMWUlLMHY0alJqNDI1TFNJUmdUREs3M0pmcnpSMVB4T1IyYU4zZXJOMkNRd3NZRE5IcC9WaGtpczJpeHRFbDQrSFk9IiwibWFjIjoiYmJmNWIxYjdkNWEzMTRiZjM0ODUyMzk4MzMyZDc3OWE1MWQxZGY0YmY0OGZhZmVhZmYxMDI4YjAxNTgxODk3MyIsInRhZyI6IiJ9"
            }
          }
        },
        {
          "cursor": "eyJpZCI6NzUsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0",
          "node": {
            "code": "eyJpdiI6Im5DQ3pidWlKT0UvWjJwZzhNUHQrY1E9PSIsInZhbHVlIjoiUjRFaExwQ1lvYjU2M0JMdW9hOEdsUXpyV0JLZ1BjcVkyNE5Lak1CR2VuMkRWSWdzcUhpVlkvNkZ1Wm1kWnRURTdIY0MxN0tRd2tVcGhKdlRhS1A3OUVXeHF1TVc4L2Z0SUdLM2VtM3VLVVk9IiwibWFjIjoiMjg5ZDMxMTZmNWU5MTE1ZjY0OTkwNjM5Y2U2Y2Q1OWEwMGM5NWU0YjBkYmQzNzg1MDRmZGE0ZGIzMzdlNTc0MiIsInRhZyI6IiJ9",
            "qr": {
              "url": "https://chart.googleapis.com/chart?cht=qr&chs=512x512&chl=https://devplatform.enjinsandbox.com/claim/eyJpdiI6IkJHTlhXRWp3MUtKeFB3Q0tESnpuRGc9PSIsInZhbHVlIjoiQ1B1cWtRRnR6ZFFnQ2piUlZtemIrOUhzK2lDU3ZYc0E3RUczU3FGUlpmc3dQcUxYV2x0dmdURE1uQzh1OXVGNzd3MVRuUXViNnAzdXFDc3ZIeUdqV3FvZDhla0JmOXNWQ1hib09yaktSZ1U9IiwibWFjIjoiMTg4YWQzY2E2NjNlODRjZWE4NzRiMDM5ZjU1N2FkNGZhZjhiNGVhMjFkOWM0MjJlOTQ0NmM1NTMxZjQ1NWY1ZCIsInRhZyI6IiJ9",
              "payload": "https://devplatform.enjinsandbox.com/claim/eyJpdiI6InkrYnBiVGc4RjRQU1pienlpM01kd1E9PSIsInZhbHVlIjoidHZZNDVOQjNjVEY5NUs5VzhRTERFV3Buc211SzZPd0lDQXJrbWtiTWcvV3VWQXlJeFFuQkNmVTJyWHRCV2l4SE9PRkxyZW0yV2NjenBUQk1JbWIvc3l2SWtCN3gxWkJqNWFsSmFoMVU1R3M9IiwibWFjIjoiZmI2ZTNjNjI3NTcwZWM4MGFmYzBmOTM1ZDI1ODcwYjBmNmI1ZDdhOTAxODUwYzQ5ZGIxMmEyMWNmM2M4N2E1OCIsInRhZyI6IiJ9"
            }
          }
        },
        {
          "cursor": "eyJpZCI6NzQsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0",
          "node": {
            "code": "eyJpdiI6Inltd2dCeWZ5R1NmUmExbTNSNURHemc9PSIsInZhbHVlIjoiTC9Ydll2UTYreERYVzRyS2hPMnJqUjErSlQrQnowT2hkS3NieXh0RGh4ZE5ieTR1ekFNYnVIY0xtMkdPRW9SMXN4U214cFg4RzdzdVdJRGtZb2pXK08yc2dHc0tqOVJsMjlJeDEyOEdWYm89IiwibWFjIjoiY2I3MDA3YWNmYjMyYTg4MGFjZjhhYzQ4MmMwYzE3NWFmZmVjMWU1ZTlkNGU4NGY4Y2RmMWViMDNjZjBjMjc3MiIsInRhZyI6IiJ9",
            "qr": {
              "url": "https://chart.googleapis.com/chart?cht=qr&chs=512x512&chl=https://devplatform.enjinsandbox.com/claim/eyJpdiI6InBFblU1bjJMOTV0THh3MWtzMTlzOXc9PSIsInZhbHVlIjoidDNRczBCdktmWHhGL1ZOanprcDMzazJjMlAxY01yMlN3RTk5WmFGRm5OczRwMkV1VWlJbGs0U2Q5b2ZJaTU4UG03aTRuczZiUTB3ZFpqUWlKZDlSbVNCOU1sdnlQOHR2UzJkTzVTT1N2Rlk9IiwibWFjIjoiOGM3MTAwYTdhYjIyYjQ0MTlhOGEwYmMzZWJiNGU0Nzk5NmNhNmFiYjJiYzVjMjFkNTU4YWQ5MTAxYjIwNDM3ZSIsInRhZyI6IiJ9",
              "payload": "https://devplatform.enjinsandbox.com/claim/eyJpdiI6IkRUMXVmcHo1KzVQUVQ2Kzk3MUYrN0E9PSIsInZhbHVlIjoiMDRYbkpMdmExZnlxcWZoWllIa2MrTHBoNndhSk4vOXQxOHd6T09iakVvazVDcUp4Q1QrTVFFdk1tb2NWMk1TeXpMWEhrc0hBclhWZHRKeFVwSEMvU1I4VVB3MC9iWkR0eVlZTWtZdG8vK0k9IiwibWFjIjoiYzk0YmQ0NzRiMTU2YmU0NmY2ZWYyNTNkYjVlZjRkODM4NjBjZmU3OTU5Yzg5NTBjZmQ2ODUxMzhjNGE3NDA4MSIsInRhZyI6IiJ9"
            }
          }
        },
        {
          "cursor": "eyJpZCI6NzMsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0",
          "node": {
            "code": "eyJpdiI6IjErMjYvRGMzSVlBdzNOdlZMcWt4eUE9PSIsInZhbHVlIjoiNmMwdU5QNHR4T0hHL2drTEpoekt2ODYrcXoxakxMUG9rQ0pLZ1hHeXl1VWlQM0tCaTFvMUhwQk9nSEIvcitkQ1RRN3hyRW02WitscVJiYjZqb2I0S0JLdHJYOHBEZ2dGdmhTQk5DMWdCelE9IiwibWFjIjoiOGNmYWNmN2I0ZmZjMDI2ZmZhOWI5YzY1YTAyYWYxMzc1MDM3ZmY1NjI3N2NlY2ZlOWFiZWI5MTY5OTI2MzcyZSIsInRhZyI6IiJ9",
            "qr": {
              "url": "https://chart.googleapis.com/chart?cht=qr&chs=512x512&chl=https://devplatform.enjinsandbox.com/claim/eyJpdiI6IjI0Snh5ckVmK1hKZzNMblkxNEEwMHc9PSIsInZhbHVlIjoiWFc4ejl5WS9tYlhtOVFVK2J3cXV6REtUKzJ5S01OTWNoSDM0YUxhQ3p5Rllqek5TbFc2bDJNcjhWOUtkNGx0a1g5MzVaRU54Y0dBS0ZVa2FpS0xGZ3JpdEcrQVBxZGQ1cTdtdVNNQVpnQnc9IiwibWFjIjoiOTcyYzdhMDI4ZTI5Zjg0YTZhNDFmODRlZTJlNzkzOTczNTQyYjY1NzQ2YjYwNzAzODBhODU1Mjk1ZmQ1NmQ0NiIsInRhZyI6IiJ9",
              "payload": "https://devplatform.enjinsandbox.com/claim/eyJpdiI6IklvOGZJcnppTVBQVVhEbkZhelBKT2c9PSIsInZhbHVlIjoiQllFcS9HSkQ4ZGFUS3BJbEM4d2QvdVk2SndXYmF6NGRDMHhoc25kNmQvVDUvQ3F3QTVzVk5Sb080T3M0eEFIWnMybkF3MjNVVk1Dajl5M2p6bzZJbG5OUDhSMkk2N2JSSExEbDVpQkN2cDg9IiwibWFjIjoiMzNmNGQ2OTQ3MDgxN2MyMGNkNzU0NmNiNWNkYzQ0NzA4Njk5MGY4YzU1MGE1NGRjMGFhZjFjNjBjNjU1NjMyOSIsInRhZyI6IiJ9"
            }
          }
        },
        {
          "cursor": "eyJpZCI6NzIsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0",
          "node": {
            "code": "eyJpdiI6Ildxb0JqVUpTUHJxTXdqN1NERFJsbmc9PSIsInZhbHVlIjoiMy8wUkZTZis0cHVnMnZwRnFncEZIMUJrby9scHFjaWlzT1huNFNidkNHVnIrMUYxRzlTdVpmZk9qTEdHaG56R0txVG9PeVNzMDI2VjNaMWdkTTNZT2QwWVlqclUwTjk5YVBMZTZkWEJCV1k9IiwibWFjIjoiNTg3YTBjY2QwNjRkMWQyNjgyY2I2NmJkMTNmMjI5Y2ZmMGRlMTFmYTZjZDM3MzUxMjkxOGNlYzU3MTY0NDA5OSIsInRhZyI6IiJ9",
            "qr": {
              "url": "https://chart.googleapis.com/chart?cht=qr&chs=512x512&chl=https://devplatform.enjinsandbox.com/claim/eyJpdiI6InFvUEw3UWRuRHA0Ui9wQXRNbERUK2c9PSIsInZhbHVlIjoiZ3h4aEc0UTAxNjBUTG9uMUhZTlNEUGtVVGY3RG9zWFE0RUl3NEZJU25NTzZYNktlazduUTZvUEVRc1R1WnVKZWVIcXoxbzB5ZHlYbTNyVnZ3YXkzY3JGT2x1eVRIOXhra1NGdmNFQjdja1E9IiwibWFjIjoiOTJmNTllNjYzMDlkNGQ3NmUzMzVkM2RkYmY0Yzc5ZGQzNGUwYWI1YzVhNzhiMjRkZWNlMzU1MmJhN2FmM2I5YiIsInRhZyI6IiJ9",
              "payload": "https://devplatform.enjinsandbox.com/claim/eyJpdiI6ImY1Y0I1NWFzd21TMEdUbDBsai9hUXc9PSIsInZhbHVlIjoiM05sbjZKMzR0cmZQb0QvM243RHNmUDNjaXRucDMzaGsySXMzV0IzUXVuOXg2U2RCNklGZ2VFWVNIbGhGeGQ0ZnBnc042MkNnUkZ2LzJOai96NkhiUUZsdGd2K0N5bEVuQnpFaWU3NXlpRVU9IiwibWFjIjoiNDU0OTQ5ZDBmMThiYjExM2U5Y2RkZTg5NDE0ZjNkNDMzNjY5MWEyODNlNTJlNzYwZWY2Yzg5OTY4MWQxZmVmZiIsInRhZyI6IiJ9"
            }
          }
        },
        {
          "cursor": "eyJpZCI6NzEsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0",
          "node": {
            "code": "eyJpdiI6Imp5R0xzNC9aVWZlT090SGVsL3RyVlE9PSIsInZhbHVlIjoiemJiWmsrZEl2TXVzc2R1c2svalhIRjdGVUFXRThPOTg2RnZJVCtMNEE1UENxN3FLeURhL1J4UXhBakduekduRmxRQTJwdmRCeXZqQi9rbVVyVnRmK2V4c2xDZU9jUW15N0xNSkRiUyt2ZlE9IiwibWFjIjoiNTZlOGQ4NjdmNDNmOTQ3NWYwM2M2MzRlMGRmODlmNmQwZmM2ZDllNjdmMTk4ZTA0ZWJiYTliZTZkZTJhOTM3MyIsInRhZyI6IiJ9",
            "qr": {
              "url": "https://chart.googleapis.com/chart?cht=qr&chs=512x512&chl=https://devplatform.enjinsandbox.com/claim/eyJpdiI6IlhtTHdEdlM5bXlQNnVEaGZpejkrR3c9PSIsInZhbHVlIjoidlh3dVhuTVhOVEQvcElBM0drMVhBQ2Z1SFdob3BtNmJnYVQwWExoVmlUYWdPTUhkUzJ1QS9JL25yeHVPSnBQb2VyM3lJWXd3aEMySVd1MjkwellTdW50UVl1YTJRdmNCV3lzdXVLaE9Wckk9IiwibWFjIjoiOGNhNmY1MzZlZWRjMmE0ZjMwYjQ0ODY0Nzg5MTk5MDU4OTAwYmZhYjYzODI4OGQ3ZDIyNTQ5MjA2Zjc2MTczYiIsInRhZyI6IiJ9",
              "payload": "https://devplatform.enjinsandbox.com/claim/eyJpdiI6IkN4OHZzUDdGc1AwUG9wdXpQSDVGYXc9PSIsInZhbHVlIjoiOTJJRHQ3VjdoZHR0WVpqajVoSGZIZFNoZHJtVE1iRjR0ZndLQXRQYVE1TS8zaGd1WEZDdDQrckNzUXExdnFvZDVVcE5PMVU1bklFRWhqSnVXVi96WVB4RE5CMk1qTFhHYVIvVWdscFljUTA9IiwibWFjIjoiYWIyY2U4YmIzMjJmNjY0ZmE2NzZjMTZhYTE0YjJlMTEwNDQxMjJlY2Y3NzZlYzZkMDNhMGI3NGQ2MDEyYTZlZSIsInRhZyI6IiJ9"
            }
          }
        }
      ],
      "totalCount": 10,
      "pageInfo": {
        "hasPreviousPage": false,
        "hasNextPage": false,
        "startCursor": "",
        "endCursor": ""
      }
    }
  }
}
Beam API Mutations
CreateBeam
Create a Beam
Mutation
Response
mutation CreateBeam {
  CreateBeam(
    name: "My Beam"
    description: "This is a test beam."
    image: "https://assets-global.website-files.com/60f57c496975b84c29335fb7/60f58bd888a6e86e3ff69551_Enjin.svg"
    start: "20230101"
    end: "20240101"
    collectionId: 7153
    tokens: [
      {tokenIds:"1..10" tokenQuantityPerClaim:1 claimQuantity:1 type:MINT_ON_DEMAND}
    ]
  )
}
{
  "data": {
    "CreateBeam": "cd6443f822cf6e89c03edd4f6fbc6e55"
  }
}
ClaimBeam
Claim a Beam from a specific code
Mutation
Response
mutation ClaimBeam {
  ClaimBeam(
    code: "cd6443f822cf6e89c03edd4f6fbc6e55"
    account: "cxMsNPRk7Ek5V76NC4o2HTBrnxcUnxLA9btuKPcuPkmYi84Ts"    
    signature:"0x1d670c35a76efa984fa2bd655d21eb28af0ee470e359848d2105845e170bb589fd6b7c2cbe97c9acce1eb205d4ade39cae75c619230cf44b64b25ec8677d7f0f"
    cryptoSignatureType:SR25519
  )
}
{
  "data": {
    "ClaimBeam": true
  }
}
DeleteBeam
Delete an already created Beam
Mutation
Response
mutation DeleteBeam {
  DeleteBeam(code: "cd6443f822cf6e89c03edd4f6fbc6e55")
}
{
  "data": {
    "DeleteBeam": true
  }
}
UpdateBeam
Update the details of a Beam that has already been created
Mutation
Response
mutation UpdateBeam {
  UpdateBeam(
    code: "ca8524349abab1cc20994841a8e0f175"
    name: "My beam UPDATED"
  )
}
{
  "data": {
    "UpdateBeam": true
  }
}
Marketplace API Package
Last modified 22d ago