---
title: "Workspace, plan and usage for this API key"
method: GET
path: "/me"
tags: ["Workspace"]
---

# Workspace, plan and usage for this API key

`GET /me`

## Request

- Base URL: `https://social-automation.cresclab.com/api/v1`
- URL: `https://social-automation.cresclab.com/api/v1/me`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/cresclab/apis/social-automation-api/docs/me/get.ts> (a function with typed inputs; its response is checked against the schema)

## Response `200`

OK

- Workspace
  - `user` object
  - `workspace` object
    - `id` string
    - `name` string, nullable
    - `plan` string, nullable
    - `trial_ends_at` string, nullable
    - `service_status` string
    - `billing_url` string
  - `usage` object, nullable
  - `api_key` object

## Other responses

- `400`: Invalid request (see error.field)
- `401`: Missing or invalid API key
- `403`: Insufficient scope, trial expired, contract expired or plan limit (see error.code and error.action_url)
- `429`: Rate limited

---

[API](https://skmtc.dev/cresclab/apis/social-automation-api.md) - [All operations](https://skmtc.dev/cresclab/apis/social-automation-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cresclab/apis/social-automation-api/revisions/1d4ea62ba46d?raw)