Skip to main content

Get a grid by ID

Use this example to retrieve grid card details by ID with a raw Administration API request.

Before you begin, authenticate the Admin API application and obtain an auth token.

The Admin API application requires the GRIDS:VIEW permission. Submit a request to retrieve a grid card. Replace {gridId} with the grid card's UUID.

  • Method: GET
  • Path: /api/web/v2/grids/{gridId}

Example request header​

Authorization: Bearer <auth-token>

Example request body​

No request body is required for this endpoint.

Example response body​

HTTP 200 returns the grid card's details. The following partial response omits most grid cells:

{
  "id": "6c5ad3b4-888c-4d3b-88f2-8ab71ae4f917",
  "serialNumber": 2,
  "expired": false,
  "state": "ACTIVE",
  "gridContents": [["TP", "0M", "P8", "KW"]],
  "allowedActions": ["DELETE", "DISABLE"],
  "userId": "2c422a2f-e8ae-4af8-8b03-e1ce0ddde0b0",
  "userName": "john"
}

Treat gridContents as authentication credentials. Do not log the values or expose them beyond the intended recipient. For the complete response schema and error responses, including a grid that is not found, see Get a grid.