GET /me

Summary

Get API key info

Returns information about the authenticated API key — name, description, scopes, rate limit, IP allowlist, expiry, accessible companies, and scoped agencies. No additional scope is required beyond a valid API key.

URL Parameters

• None

Query Parameters

• None

Request Example

cURL

curl -X GET 'https://api.requidex.com/api/open/v1/me' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Accept: application/json'

JavaScript

const response = await fetch("https://api.requidex.com/api/open/v1/me", {
  method: "GET",
  headers: {
    Authorization: "Bearer <API_KEY>",
    Accept: "application/json",
  },
});

const json = await response.json();

Python

import requests

response = requests.request(
    'GET',
    'https://api.requidex.com/api/open/v1/me',
    headers={
        'Authorization': 'Bearer <API_KEY>',
        'Accept': 'application/json',
    },
    timeout=30,
)

print(response.json())

Go

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://api.requidex.com/api/open/v1/me", nil)
  req.Header.Set("Authorization", "Bearer <API_KEY>")
  req.Header.Set("Accept", "application/json")

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  payload, _ := io.ReadAll(resp.Body)
  fmt.Println(string(payload))
}

Response Fields

Field	Type	Description
agencies	array	Returned for agency-scoped API keys. Agencies this key is scoped to Show child attributes id string name string
companies	array	Returned for company-scoped API keys. Companies this key can access Show child attributes id string name string
createdAt	string	Timestamp this key was created
description	string	Optional description for this API key
expiresAt	string	Expiry timestamp, returned when the key has an expiry
ipAllowlist	array	Allowed IP addresses or CIDR ranges, returned when the key has IP restrictions
lastUsedAt	string	Timestamp of the most recent request made with this key, returned after the key has been used
name	string	API key name
rateLimitPerDay	integer	Maximum requests allowed per day. Daily limits reset at midnight UTC.
rateLimitPerMinute	integer	Maximum requests allowed per minute
scopes	array	Scopes granted to this key (e.g. read:projects, read:workers, read:purchase-orders, read:invoices, read:credit-notes)
usage	object	Current daily usage information for this API key. Show child attributes requestsToday integer - Requests recorded so far today remainingToday integer - Remaining requests available before the daily cap is reached resetsAt string - Timestamp when the daily usage window resets (midnight UTC)

Response Example (200)

{
  "success": true,
  "data": {
    "name": "Data Warehouse Sync",
    "description": "Used for nightly ETL pipeline",
    "scopes": [
      "read:companies",
      "read:trades",
      "read:projects",
      "read:workers",
      "read:purchase-orders",
      "read:invoices",
      "read:credit-notes"
    ],
    "rateLimitPerMinute": 60,
    "rateLimitPerDay": 5000,
    "ipAllowlist": ["203.0.113.0/24"],
    "expiresAt": "2027-01-01T00:00:00.000Z",
    "lastUsedAt": "2026-03-16T09:30:00.000Z",
    "usage": {
      "requestsToday": 127,
      "remainingToday": 4873,
      "resetsAt": "2026-03-17T00:00:00.000Z"
    },
    "companies": [
      { "id": "67bc36db80a1616ec3f47001", "name": "Requidex Construction Ltd" },
      { "id": "67bc36db80a1616ec3f47002", "name": "Requidex Infrastructure Ltd" }
    ],
    "createdAt": "2025-06-01T10:00:00.000Z"
  }
}

Errors

HTTP Status	Description
401	Missing, invalid, revoked, or expired API key
405	Method not allowed on Open API routes
429	Rate limit exceeded
500	Unexpected internal error