GET /api/v1/me

Endpoint

GET /api/v1/me

Returns the profile of the client associated with the API token used in the request. This is the simplest way to verify that a token is valid and to retrieve the client's account details.

Request

No query parameters or request body are required.

curl https://billing.example.com/api/v1/me \
  -H "Authorization: Bearer {your-token}"

Response

{
  "data": {
    "id": 42,
    "name": "Jane Smith",
    "email": "jane@example.com",
    "company": "Acme Hosting Ltd",
    "phone": "+1 555 0123",
    "address1": "123 Main Street",
    "address2": "Suite 4B",
    "city": "Austin",
    "state": "TX",
    "postcode": "78701",
    "country": "US",
    "currency_code": "USD",
    "status": "active",
    "created_at": "2024-11-03T09:22:41Z"
  }
}

Response Fields

Field	Type	Description
`id`	integer	Unique client ID
`name`	string	Full name (first + last)
`email`	string	Primary email address
`company`	string	Company name, or `null` if not set
`phone`	string	Phone number, or `null` if not set
`address1`	string	Address line 1
`address2`	string	Address line 2, or `null`
`city`	string	City
`state`	string	State or region
`postcode`	string	Postal or ZIP code
`country`	string	Two-letter ISO country code
`currency_code`	string	Default billing currency (e.g., `USD`, `EUR`)
`status`	string	Account status: `active`, `suspended`, or `closed`
`created_at`	string	ISO 8601 timestamp of account creation

Use Cases

Verify authentication. Make a request to /me on startup to confirm the token is valid before proceeding with further API calls.

Pre-fill forms. Use the returned address and contact data to pre-populate checkout or support forms in your integration.

Identify the client. The id field can be used to cross-reference records in other responses (services, invoices, etc.).

[!TIP] If you only need to check whether a token is valid without caring about the profile data, /me is the right endpoint — it is the lightest request available and always returns a 200 for authenticated tokens or a 401 for invalid ones.

Error Responses

Status	Meaning
`401 Unauthorized`	Token is missing, invalid, or revoked

Endpoint#

Request#

Response#

Response Fields#