Skip to main content
GET
/
objects
List All Objects
curl --request GET \
  --url https://api.g2cplatform.com/v2/objects \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "externalId": "<string>",
      "name": "<string>",
      "status": "active",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "summary": "<string>",
      "owner": "<string>",
      "categoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "subcategoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "metadata": {},
      "blockchain": {
        "txId": "<string>",
        "lastTxId": "<string>",
        "eventCount": 123
      }
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123,
    "hasNext": true,
    "hasPrevious": true
  }
}

Authorizations

​
X-API-Key
string
header
required

API key for authenticating requests. Include in X-API-Key header.

Query Parameters

​
limit
integer
default:20

Maximum number of objects to return

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of objects to skip

Required range: x >= 0
​
status
enum<string>
default:active

Filter by object status

Available options:
active,
inactive,
all
​
name
string

Filter by object name (partial match)

​
externalId
string

Filter by external ID (exact match)

​
categoryId
string<uuid>

Filter by category ID

​
subcategoryId
string<uuid>

Filter by subcategory ID

​
owner
string

Filter by owner name (partial match)

​
sort
string
default:createdAt:desc

Sort field and direction (format: field:direction)

Example:

"name:asc"

Response

200 - application/json

List of objects

​
data
object[]
required
​
pagination
object
required