Identify the authenticated API client

Confirm your credentials work and discover which organizations you can access.

The me query is the simplest way to confirm your API credentials are working. It returns the identity of the authenticated API client, the scopes it has been granted, and the organizations and offices it can access. Use an organizationId and office key from this response when creating cases.

Required scope: read-only

Request

query me {
  me {
    apiClientId
    friendlyApiClientName
    scopes
    accessibleOrganizations {
      organizationId
      name
      offices {
        key
        name
      }
    }
  }
}

Response

{
  "data": {
    "me": {
      "apiClientId": "Qm7tR2xV9kLp4WzN8cHd3JfY6sBa1EgU",
      "friendlyApiClientName": "Harbour View Practice Management",
      "scopes": [
        "read-only",
        "case-management"
      ],
      "accessibleOrganizations": [
        {
          "organizationId": "3f2b8c1e9a4d4e7f8b6c5d4e3f2a1b0c",
          "name": "Harbour View Legal",
          "offices": [
            {
              "key": "8e7d6c5b4a3f4e2d9c1b0a9f8e7d6c5b",
              "name": "Auckland"
            },
            {
              "key": "2c4e6a8b1d3f4b5a8c7e9f0a1b2c3d4e",
              "name": "Wellington"
            }
          ]
        }
      ]
    }
  }
}

---