Introspect the calling API key

GET

/me

package main

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

func main() {

  url := "https://api.kirimdev.com/v1/me"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://api.kirimdev.com/v1/me';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "https://api.kirimdev.com/v1/me";

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("Authorization", "Bearer <token>".parse().unwrap());

    let client = reqwest::Client::new();
    let response = client.get(url)
        .headers(headers)
        .send()
        .await;

    let results = response.unwrap()
        .json::<serde_json::Value>()
        .await
        .unwrap();

    dbg!(results);
}

Returns the organization, API key, rate-limit tier, and the list of teams under the organization associated with the bearer token. Use to verify key validity from automation scripts and to discover the team_id values required by team-scoped writes (e.g. POST /v1/customers on multi-team orgs).

Authorizations

bearerAuth

Responses

200

API key context

application/json

object

data

required

object

organization

required

object

required

string

object

required

string

Allowed values: organization

name

required

string

api_key

required

object

required

string

object

required

string

Allowed values: api_key

label

required

string

last4

required

string

rate_limits

required

object

tier

required

string

write_per_minute

required

integer

read_per_minute

required

integer

teams

required

Teams under the organization, ordered by creation time (oldest first). For single-team orgs, team_id is auto-selected on writes; for multi-team orgs you must pass one of these ids explicitly.

Array<object>

object

required

Internal team id — pass this as team_id on team-scoped writes (e.g. POST /v1/customers).

string

object

required

string

Allowed values: team

name

required

string

slug

required

string

request_id

required

string

Example

{
  "data": {
    "organization": {
      "id": "org_01HXYZABCDEFGHJKMNPQRSTVWX",
      "object": "organization"
    },
    "api_key": {
      "id": "key_01HXYZABCDEFGHJKMNPQRSTVWX",
      "object": "api_key"
    },
    "teams": [
      {
        "object": "team"
      }
    ]
  }
}

401

Authentication failure

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

429

Rate limit exceeded

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

500

Internal server error

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}