Skip to main content
GET
/
me
Get the current project
curl --request GET \
  --url https://apix.spotzee.com/api/client/me \
  --header 'Authorization: Bearer <token>'
{
  "id": 42,
  "organization_id": 7,
  "name": "Acme Marketing",
  "locale": "en-AU",
  "timezone": "Australia/Sydney",
  "created_at": "2026-04-28T05:14:00.000Z",
  "updated_at": "2026-04-28T05:14:00.000Z",
  "role": "support",
  "has_provider": true,
  "description": "<string>",
  "website_url": "https://acme.example",
  "text_opt_out_message": "<string>",
  "text_help_message": "<string>",
  "link_wrap_email": true,
  "link_wrap_push": true,
  "track_opens_email": true,
  "deeplink_mirror_url": "https://links.acme.example"
}

Documentation Index

Fetch the complete documentation index at: https://docs.spotzee.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Project-scoped secret API key (sk_…). Pass in the Authorization: Bearer <key> header. Grants access to the project the key was issued for.

Response

The project the calling key is scoped to.

A tenant scope inside an organisation. Owns its own contacts, segments, lists, journeys, and templates.

​
id
integer
required

Numeric project identifier.

Example:

42

​
organization_id
integer
required

Identifier of the owning organisation.

Example:

7

​
name
string
required

Human-readable project name.

Example:

"Acme Marketing"

​
locale
string
required

Default BCP-47 locale used for content rendering and timestamp formatting.

Example:

"en-AU"

​
timezone
string
required

Default IANA timezone used for time-of-day scheduling.

Example:

"Australia/Sydney"

​
created_at
string | null
required

Time the project was created. ISO 8601.

Example:

"2026-04-28T05:14:00.000Z"

​
updated_at
string | null
required

Time the project was last modified. ISO 8601.

Example:

"2026-04-28T05:14:00.000Z"

​
role
enum<string>
required

The caller’s role on this project.

Available options:
support,
smtpproxy,
editor,
publisher,
admin
​
has_provider
boolean
required

Whether at least one delivery provider is configured for this project.

​
description
string | null

Optional free-text description of the project.

​
website_url
string | null

The project’s public website URL, if set.

Example:

"https://acme.example"

​
text_opt_out_message
string | null

Custom opt-out reply for SMS recipients. When omitted, a system default is used.

​
text_help_message
string | null

Custom HELP reply for SMS recipients. When omitted, a system default is used.

​
link_wrap_email
boolean | null

When true, links in email content are rewritten through the tracking domain.

​
link_wrap_push
boolean | null

When true, links in push payloads are rewritten through the tracking domain.

​
track_opens_email
boolean | null

When true, an open-tracking pixel is embedded in outgoing email.

​
deeplink_mirror_url
string | null

HTTPS-only mirror URL used for Universal Links and App Links resolution.

Example:

"https://links.acme.example"