List Groups

org:groups:read

GET /groups/{network}

List Groups

cURL

curl --request GET \
  --url https://api.pinata.cloud/v3/groups/{network} \
  --header 'Authorization: Bearer <token>'

200

{
  "data": {
    "groups": [
      {
        "id": "01919976-955f-7d06-bd59-72e80743fb95",
        "name": "Test Private Group",
        "is_public": false,
        "created_at": "2024-08-28T14:49:31.246596Z"
      }
    ],
    "next_page_token": "MDE5MTk5NzYtOTU1Zi03ZDA2LWJkNTktNzJlODA3NDNmYjk1"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

name · string

Filter groups by name

isPublic · boolean

Filters groups by is_public set to true or false

limit · integer

Limit the number of results

pageToken · string

Paginate using the nextPageToken

Response

200 - application/json

OK

data · object

Show child attributes