Skip to main content
GET
/
api
/
v1
/
project
Get the current project
curl --request GET \
  --url https://api.railmail.app/api/v1/project \
  --header 'X-API-Key: <api-key>'
{
  "id": 123,
  "projectKey": "<string>",
  "name": "<string>",
  "description": "<string>",
  "selected": true,
  "aiSegmentSuggestionsEnabled": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-API-Key
string
header
required

Project-scoped API key, format rm_(live|test)_... . May also be sent as Authorization: Bearer rm_....

Response

Project

​
id
integer<int64>
​
projectKey
string
​
name
string
​
description
string | null
​
selected
boolean | null
​
aiSegmentSuggestionsEnabled
boolean | null
​
createdAt
string<date-time>
​
updatedAt
string<date-time>