Organizations
Fetch current organization details
- API Reference
- Discord Support
- GETGet subscribers
- POSTCreate subscriber
- POSTBulk create subscribers
- GETGet subscriber
- PUTUpdate subscriber
- DELDelete subscriber
- PUTUpdate subscriber credentials
- DELDelete subscriber credentials by providerId
- PATCHUpdate subscriber online status
- GETGet subscriber preferences
- GETGet subscriber preferences by level
- PATCHUpdate subscriber preference
- PATCHUpdate subscriber global preferences
- GETGet in-app notification feed for a particular subscriber
- GETGet the unseen in-app notifications count for subscribers feed
- POSTMark a subscriber feed messages as seen or as read
- POSTMarks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed.
- POSTMark message action as seen
- GETHandle providers oauth redirect
- GETHandle chat oauth
- GETFilter topics
- POSTTopic creation
- POSTSubscribers addition
- GETCheck topic subscriber
- POSTSubscribers removal
- GETGet topic
- DELDelete topic
- PATCHRename a topic
- GETGet notifications
- GETGet notification statistics
- GETGet notification graph statistics
- GETGet notification
- GETGet workflows
- POSTCreate workflow
- GETGet workflow
- PUTUpdate workflow
- DELDelete workflow
- PUTUpdate workflow status
- POSTCreate workflow override
- GETGet workflow overrides
- GETGet workflow override
- GETGet workflow override by id
- PUTUpdate workflow override by id
- PUTUpdate workflow override
- DELDelete workflow override
- GETGet workflow groups
- POSTCreate workflow group
- GETGet workflow group
- DELDelete workflow group
- PATCHUpdate workflow group
- GETGet integrations
- POSTCreate integration
- GETGet active integrations
- GETGet webhook support status for provider
- PUTUpdate integration
- DELDelete integration
- POSTSet integration as primary
- GETFilter layouts
- POSTLayout creation
- GETGet layout
- DELDelete layout
- PATCHUpdate a layout
- POSTSet default layout
- GETGet execution details
Subscribers
Topics
Notification
Workflows
Workflow Overrides
Workflow groups
Integrations
Layouts
Execution Details
Organizations
Fetch current organization details
GET
/
v1
/
organizations
/
me
Authorization
string
*
Authorization
Required
string
curl --request GET \
--url https://api.novu.co/v1/organizations/me
{
"data": {
"name": "<string>",
"logo": "<string>",
"branding": {
"direction": "ltr",
"logo": "<string>",
"color": "<string>",
"fontColor": "<string>",
"contentBackground": "<string>",
"fontFamily": "<string>"
},
"partnerConfigurations": [
{
"projectIds": [
"<string>"
],
"accessToken": "<string>",
"configurationId": "<string>",
"teamId": "<string>",
"partnerType": "vercel"
}
]
}
}
Enter your API key in the Authorization
field like the example shown below:
E.g ApiKey 18d2e625f05d80e
Response
200 - application/json
data
object
data.name
string
requireddata.logo
string
data.branding
object
requireddata.branding.direction
enum<string>
Available options:
ltr
, trl
data.branding.logo
string
requireddata.branding.color
string
requireddata.branding.fontColor
string
requireddata.branding.contentBackground
string
requireddata.branding.fontFamily
string
data.partnerConfigurations
object[]
data.partnerConfigurations.projectIds
string[]
data.partnerConfigurations.accessToken
string
requireddata.partnerConfigurations.configurationId
string
requireddata.partnerConfigurations.teamId
string
data.partnerConfigurations.partnerType
enum<string>
requiredPartner Type Enum
Available options:
vercel
Was this page helpful?
curl --request GET \
--url https://api.novu.co/v1/organizations/me
{
"data": {
"name": "<string>",
"logo": "<string>",
"branding": {
"direction": "ltr",
"logo": "<string>",
"color": "<string>",
"fontColor": "<string>",
"contentBackground": "<string>",
"fontFamily": "<string>"
},
"partnerConfigurations": [
{
"projectIds": [
"<string>"
],
"accessToken": "<string>",
"configurationId": "<string>",
"teamId": "<string>",
"partnerType": "vercel"
}
]
}
}