Get Organization

GET/v2/organizations/{id}

Returns a single organization by ID, including its groups, keywords, tags, members, and subscription state.

100 req/s

Parameters

Path Parameters

idintegerrequiredpath

The unique identifier of the organization (int64).

Try it

Parameters

id *integer

Organization ID

Response

{
  "id": 100,
  "name": "Acme Inc.",
  "groupIds": [10, 11],
  "userIds": [12345, 67890],
  "timeZone": "Europe/Zagreb",
  "groups": [
    {
      "id": 10,
      "name": "PR Team",
      "color": "#4A90D9",
      "colorNew": "blue",
      "public": true,
      "keywordIds": [200, 201],
      "memberIds": [12345],
      "invitedUsers": [
        { "email": "newuser@example.com", "roleId": "member" }
      ]
    }
  ],
  "keywords": [
    {
      "id": 200,
      "name": "Acme",
      "color": "#E94E77",
      "colorNew": "red",
      "active": true,
      "editedAt": "2024-03-10T14:00:00Z",
      "createdAt": "2024-01-15T09:30:00Z"
    }
  ],
  "tags": [
    { "id": 1, "name": "Important" }
  ],
  "state": "ACTIVE",
  "createdAt": "2024-01-15T09:30:00Z",
  "currentMonthMentionsLimit": 50000
}

Response Fields

Field	Type	Description
id	integer (int64)	Unique identifier for the organization
name	string	Display name of the organization
groupIds	array of integer (int64)	IDs of the groups within the organization
userIds	array of integer (int64)	IDs of the users belonging to the organization
timeZone	string	The organization's time zone (IANA identifier, e.g. Europe/Zagreb)
groups	array	Detailed group objects (see below)
keywords	array	Detailed keyword objects (see below)
tags	array	Tag objects associated with the organization (see below)
state	string	Subscription state. One of BLOCKED, UNUSED, SUSPENDED, ACTIVE
createdAt	string (date-time)	Timestamp of when the organization was created
currentMonthMentionsLimit	integer (int64)	Mentions limit for the current billing month

Group Object

Field	Type	Description
id	integer (int64)	Unique identifier for the group
name	string	Display name of the group
color	string	Group color (legacy hex value)
colorNew	string	Group color (current palette value)
public	boolean	Whether the group is visible to all organization members
keywordIds	array of integer (int64)	IDs of the keywords in the group
memberIds	array of integer (int64)	IDs of the users who are members of the group
invitedUsers	array	Users invited to the group but not yet accepted (see below)

Invited User Object

Field	Type	Description
email	string	Email address of the invited user
roleId	string	Identifier of the role the user is invited with

Keyword Object

Field	Type	Description
id	integer (int64)	Unique identifier for the keyword
name	string	Display name of the keyword
color	string	Keyword color (legacy hex value)
colorNew	string	Keyword color (current palette value)
active	boolean	Whether the keyword is currently active
editedAt	string	Timestamp of the last edit
createdAt	string	Timestamp of when the keyword was created

Tag Object

Field	Type	Description
id	integer (int64)	Unique identifier for the tag
name	string	Display name of the tag

Errors

Status	Description
404 Not Found	No organization with the given ID exists, or the authenticated user does not have access to it

See the Errors & Rate Limits page for the full error response structure.