cURL
curl -H "X-API-Key: $PARTICLE_API_KEY" \
"https://api.particle.pro/v1/me"{
"api_key": {
"created_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"key_prefix": "<string>",
"name": "<string>",
"created_by": {
"id": "<string>",
"name": "<string>"
},
"expires_at": "2023-11-07T05:31:56Z",
"last_used_at": "2023-11-07T05:31:56Z"
},
"organization": {
"id": "<string>",
"name": "<string>",
"plan": "<string>",
"subscription_status": "<string>",
"plan_display_name": "<string>"
},
"project": {
"created_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>"
}
}{
"detail": "Property foo is required but is missing.",
"error_code": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"resolve": {
"message": "<string>",
"action": "<string>",
"endpoint": "<string>",
"method": "<string>",
"url": "<string>"
},
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}Account
Identify your API key
Returns the organization, project, and API key a request authenticates as, with the organization’s plan. Free: call it to check that a key works and which project it belongs to. A missing, mistyped, revoked, or expired key returns 401 api_key_required. When the organization’s access is blocked, it returns the same 402 as every other endpoint, naming the billing state and how to resolve it.
GET
/
v1
/
me
cURL
curl -H "X-API-Key: $PARTICLE_API_KEY" \
"https://api.particle.pro/v1/me"{
"api_key": {
"created_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"key_prefix": "<string>",
"name": "<string>",
"created_by": {
"id": "<string>",
"name": "<string>"
},
"expires_at": "2023-11-07T05:31:56Z",
"last_used_at": "2023-11-07T05:31:56Z"
},
"organization": {
"id": "<string>",
"name": "<string>",
"plan": "<string>",
"subscription_status": "<string>",
"plan_display_name": "<string>"
},
"project": {
"created_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>"
}
}{
"detail": "Property foo is required but is missing.",
"error_code": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"resolve": {
"message": "<string>",
"action": "<string>",
"endpoint": "<string>",
"method": "<string>",
"url": "<string>"
},
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}Authorizations
ApiKeyHeaderBearerAuth
Pass your API key in the X-API-Key header (recommended).
Response
OK
The key the request authenticated with. Only its prefix is returned, never the full key.
Show child attributes
Show child attributes
The organization the key belongs to, and its plan.
Show child attributes
Show child attributes
The project the key belongs to.
Show child attributes
Show child attributes
Was this page helpful?