---
updatedAt: 2026-04-22T14:03:15.000Z
agentTools:
  projectIndex: https://docs.performyard.com/llms.txt
---

# Verify your API key and retrieve usage details

Validates your API credentials and returns current usage metrics for your account, including rate limits and request counts.

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "PerformYard API",
    "description": "The PerformYard API allows customers to programmatically retrieve and manage data related to their performance management processes.",
    "version": "0.1.0",
    "contact": {
      "name": "PerformYard",
      "url": "https://www.performyard.com/contact",
      "email": "info@performyard.com"
    }
  },
  "paths": {
    "/v1/auth/verify": {
      "get": {
        "summary": "Verify your API key and retrieve usage details",
        "tags": [
          "Auth"
        ],
        "description": "Validates your API credentials and returns current usage metrics for your account, including rate limits and request counts.",
        "responses": {
          "200": {
            "description": "Default Response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "company_name": {
                      "type": "string"
                    },
                    "last_used": {
                      "anyOf": [
                        {
                          "type": "string",
                          "format": "date-time"
                        },
                        {
                          "type": "string",
                          "nullable": true,
                          "enum": [
                            null
                          ]
                        }
                      ]
                    },
                    "is_enabled": {
                      "type": "boolean"
                    },
                    "quota_limit": {
                      "type": "number"
                    },
                    "requests_made": {
                      "type": "number"
                    },
                    "refresh_period": {
                      "anyOf": [
                        {
                          "type": "string",
                          "enum": [
                            "DAY"
                          ]
                        },
                        {
                          "type": "string",
                          "enum": [
                            "WEEK"
                          ]
                        },
                        {
                          "type": "string",
                          "enum": [
                            "MONTH"
                          ]
                        },
                        {
                          "type": "string",
                          "enum": [
                            "NOT_FOUND"
                          ]
                        }
                      ]
                    }
                  },
                  "required": [
                    "company_name",
                    "last_used",
                    "is_enabled",
                    "quota_limit",
                    "requests_made",
                    "refresh_period"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "400": {
            "description": "Default Response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string"
                    },
                    "details": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "meta": {
                      "type": "object",
                      "additionalProperties": {
                        "type": "string"
                      }
                    }
                  },
                  "required": [
                    "message"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "401": {
            "description": "Default Response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string"
                    },
                    "details": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "meta": {
                      "type": "object",
                      "additionalProperties": {
                        "type": "string"
                      }
                    }
                  },
                  "required": [
                    "message"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "500": {
            "description": "Default Response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string"
                    },
                    "details": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "meta": {
                      "type": "object",
                      "additionalProperties": {
                        "type": "string"
                      }
                    }
                  },
                  "required": [
                    "message"
                  ],
                  "additionalProperties": false
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.talent.performyard.com/"
    }
  ],
  "externalDocs": {
    "url": "https://support.performyard.com/article/183-api-reference",
    "description": "PerformYard API Reference"
  }
}
```