HR Create logo

  • Studio

  • Studio API

  • Bots

  • Web API

  • Designer Resources

  • Host Resources

    • Learn
    Web API

    Endpoints

    Get Grabs

    get

    /grabs

    query parameters

  • Name
    limit
    Type
    integer
    Is Required
    Reference
    Description
  • Name
    sort_order
    Type
    string
    Is Required
    Reference
    Description
  • Name
    title
    Type
    string
    Is Required
    Reference
    Description
  • Name
    starts_after
    Type
    string
    Is Required
    Reference
    Description
  • Name
    ends_before
    Type
    string
    Is Required
    Reference
    Description

    • Body

    200OK

    Responses

    application/json
  • Name
    grabs
    Type
    array
    Is Required
    Reference
    Description
  • Name
    grab_id
    Type
    string
    Is Required
    Reference
    Description
  • Name
    title
    Type
    string
    Is Required
    Reference
    Description
  • Name
    description
    Type
    string
    Is Required
    Reference
    Description
  • Name
    banner_img_url
    Type
    string
    Is Required
    Reference
    Description
  • Name
    starts_at
    Type
    null
    Is Required
    Reference
    Description
  • Name
    expires_at
    Type
    null
    Is Required
    Reference
    Description
  • Name
    rewards
    Type
    array
    Is Required
    Reference
    Description
  • Name
    amount
    Type
    integer
    Is Required
    Reference
    Description
  • Name
    reward_id
    Type
    string
    Is Required
    Reference
    Description
  • Name
    item_id
    Type
    string |
    null
    Is Required
    Reference
    Description
  • Name
    account_bound
    Type
    boolean
    Is Required
    Reference
    Description
  • Name
    metadata
    Type
    ItemMetadata
     |
    null
    Is Required
    Reference
    Description
  • Name
    nfi_metadata
    Type
    NFIItemMetadata
     |
    null
    Is Required
    Reference
    Description
  • Name
    item_number
    Type
    integer
    Is Required
    Reference
    Description
  • Name
    stack_id
    Type
    string
    Is Required
    Reference
    Description
  • Name
    nfi_template_metadata
    Type
    NFITemplateMetadata
     |
    null
    Is Required
    Reference
    Description
  • Name
    total_amount
    Type
    integer |
    null
    Is Required
    Reference
    Description
  • Name
    primary_img_url
    Type
    string |
    null
    Is Required
    Reference
    Description
  • Name
    secondary_img_url
    Type
    string |
    null
    Is Required
    Reference
    Description
  • Name
    costs
    Type
    array
    Is Required
    Reference
    Description
  • Name
    amount
    Type
    integer
    Is Required
    Reference
    Description
  • Name
    reward_id
    Type
    string
    Is Required
    Reference
    Description
  • Name
    item_id
    Type
    string |
    null
    Is Required
    Reference
    Description
  • Name
    account_bound
    Type
    boolean
    Is Required
    Reference
    Description
  • Name
    metadata
    Type
    ItemMetadata
     |
    null
    Is Required
    Reference
    Description
  • Name
    nfi_metadata
    Type
    NFIItemMetadata
     |
    null
    Is Required
    Reference
    Description
  • Name
    item_number
    Type
    integer
    Is Required
    Reference
    Description
  • Name
    stack_id
    Type
    string
    Is Required
    Reference
    Description
  • Name
    nfi_template_metadata
    Type
    NFITemplateMetadata
     |
    null
    Is Required
    Reference
    Description
  • Name
    total_amount
    Type
    integer |
    null
    Is Required
    Reference
    Description
  • Name
    kompu_rewards
    Type
    array
    Is Required
    Reference
    Description
  • Name
    amount
    Type
    integer
    Is Required
    Reference
    Description
  • Name
    reward_id
    Type
    string
    Is Required
    Reference
    Description
  • Name
    item_id
    Type
    string |
    null
    Is Required
    Reference
    Description
  • Name
    account_bound
    Type
    boolean
    Is Required
    Reference
    Description
  • Name
    metadata
    Type
    ItemMetadata
     |
    null
    Is Required
    Reference
    Description
  • Name
    nfi_metadata
    Type
    NFIItemMetadata
     |
    null
    Is Required
    Reference
    Description
  • Name
    item_number
    Type
    integer
    Is Required
    Reference
    Description
  • Name
    stack_id
    Type
    string
    Is Required
    Reference
    Description
  • Name
    nfi_template_metadata
    Type
    NFITemplateMetadata
     |
    null
    Is Required
    Reference
    Description
  • Name
    total_amount
    Type
    integer |
    null
    Is Required
    Reference
    Description
  • Name
    is_tradable
    Type
    boolean
    Is Required
    Reference
    Description
  • Name
    limited_time_kompu
    Type
    LimitedKompuReward
     |
    null
    Is Required
    Reference
    Description
  • Name
    expires_at
    Type
    null
    Is Required
    Reference
    Description
  • Name
    rewards
    Type
    array
    Is Required
    Reference
    Description
  • Name
    amount
    Type
    integer
    Is Required
    Reference
    Description
  • Name
    reward_id
    Type
    string
    Is Required
    Reference
    Description
  • Name
    item_id
    Type
    string |
    null
    Is Required
    Reference
    Description
  • Name
    account_bound
    Type
    boolean
    Is Required
    Reference
    Description
  • Name
    metadata
    Type
    ItemMetadata
     |
    null
    Is Required
    Reference
    Description
  • Name
    nfi_metadata
    Type
    NFIItemMetadata
     |
    null
    Is Required
    Reference
    Description
  • Name
    item_number
    Type
    integer
    Is Required
    Reference
    Description
  • Name
    stack_id
    Type
    string
    Is Required
    Reference
    Description
  • Name
    nfi_template_metadata
    Type
    NFITemplateMetadata
     |
    null
    Is Required
    Reference
    Description
  • Name
    total_amount
    Type
    integer |
    null
    Is Required
    Reference
    Description
  • Name
    progress_reward
    Type
    ProgressReward
     |
    null
    Is Required
    Reference
    Description
  • Name
    rewards_at
    Type
    integer
    Is Required
    Reference
    Description
  • Name
    rewards
    Type
    array
    Is Required
    Reference
    Description
  • Name
    amount
    Type
    integer
    Is Required
    Reference
    Description
  • Name
    reward_id
    Type
    string
    Is Required
    Reference
    Description
  • Name
    item_id
    Type
    string |
    null
    Is Required
    Reference
    Description
  • Name
    account_bound
    Type
    boolean
    Is Required
    Reference
    Description
  • Name
    metadata
    Type
    ItemMetadata
     |
    null
    Is Required
    Reference
    Description
  • Name
    nfi_metadata
    Type
    NFIItemMetadata
     |
    null
    Is Required
    Reference
    Description
  • Name
    item_number
    Type
    integer
    Is Required
    Reference
    Description
  • Name
    stack_id
    Type
    string
    Is Required
    Reference
    Description
  • Name
    nfi_template_metadata
    Type
    NFITemplateMetadata
     |
    null
    Is Required
    Reference
    Description
  • Name
    total_amount
    Type
    integer |
    null
    Is Required
    Reference
    Description
  • Name
    total
    Type
    integer
    Is Required
    Reference
    Description
  • Name
    first_id
    Type
    string
    Is Required
    Reference
    Description
  • Name
    last_id
    Type
    string
    Is Required
    Reference
    Description
    • PocketWorlds Icon

    © 2024 Pocket Worlds. All rights reserved.

    Company

    AboutPartnerships

    Resources

    FAQContact

    Legal

    Privacy PolicyTerms of Service

    Social

    InstagramTwitterFacebookTikTokDiscord