Get project

Returns the data of the project associated with the provided API key.

Method

GET

Path

/v1/project

Use this endpoint to verify API key access and fetch core project metadata.

Typical Use Cases

Validate that backend integrations use the correct API key.
Fetch the project token/domain before configuring tracking clients.
Check public dashboard and filtering-related settings.

Headers

Authorization

required

Bearer token for a project API key. This endpoint returns data for that project only.

Example: Bearer vem_abcdefghijklmnopqrstuvwxyz123456

Responses

200 Success

application/json

project

* required

Description

Project data associated with the provided API key.

Type

object

id

* required

Description

Unique project identifier

Type

string

Example

"4232882524803099"

name

* required

Description

Name of the project

Type

string

Example

"Vemetric"

domain

* required

Description

Primary domain of the project

Type

string

Example

"vemetric.com"

token

* required

Description

Public token used for tracking

Type

string

Example

"project_token_123"

createdAt

* required

Description

Project creation timestamp (ISO 8601)

Type

string

Example

"2026-02-07T12:00:00.000Z"

firstEventAt

* required

Description

Timestamp of the first ingested event, if available (ISO 8601)

Type

string | null

Example

"2026-02-07T12:30:00.000Z"

hasPublicDashboard

* required

Description

Whether the project has public dashboard access enabled

Type

boolean

Example

false

excludedIps

* required

Description

List of excluded IP Addresses

Type

array<string>

Example

["127.0.0.1"]

excludedCountries

* required

Description

List of excluded countries as ISO 3166-1 alpha-2 codes

Type

array<string>

Example

["DE","AT"]

400 Bad request - invalid request payload or parameters

application/json

error

* required

Description

Validation error details.

Type

object

code

* required

Description

Machine-readable validation error code.

Type

"VALIDATION_ERROR"

message

* required

Description

Human-readable validation summary.

Type

string

details

* required

Description

Per-field validation issues.

Type

array<object>

Show nested properties (2)

field

* required

Description

Path to the invalid request field.

Type

string

Example

"group_by.0"

message

* required

Description

Validation error message for the field.

Type

string

401 Unauthorized - invalid or revoked API key

application/json

error

* required

Description

Error details.

Type

object

code

* required

Description

Machine-readable error code.

Type

"UNAUTHORIZED"

message

* required

Description

Human-readable error message.

Type

string

429 Rate limit exceeded

application/json

error

* required

Description

Error details.

Type

object

code

* required

Description

Machine-readable error code.

Type

"RATE_LIMIT_EXCEEDED"

message

* required

Description

Human-readable error message.

Type

string

500 Unexpected internal error

application/json

error

* required

Description

Error details.

Type

object

code

* required

Description

Machine-readable error code.

Type

"INTERNAL_SERVER_ERROR"

message

* required

Description

Human-readable error message.

Type

string