Organizations#

The company or agency that pays: its plan, its people and its workspaces, one per brand.

Authentication required

All endpoints require a Bearer token in the Authorization header. See the Authentication guide for setup instructions.

GET /v1/organizations#

List the organizations the current user belongs to, with their role, plan and number of workspaces.

bash

GET /v1/organizations
Authorization: Bearer {token}

Response#

Returns { items, totalCount, facets, _meta } with paginated results.

GET /v1/organizations/:id#

Retrieve an organization with the workspaces the user can open, each with its share of search, unexplained moments and activities this month, and its people.

bash

GET /v1/organizations/:id?organization_id=...
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
organizationId	`string (UUID)`	Required	Organization identifier.

Response#

Returns { data, _meta } with the result.

GET /v1/organizations/:id/monthly-reports#

Retrieve one month for every workspace in the organization the user belongs to: what went out, how brand searches, Share of Search, visits and results compare with the month before and a year earlier, and each workspace share link. Month defaults to last month.

bash

GET /v1/organizations/:id/monthly-reports?organization_id=...
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
organizationId	`string (UUID)`	Required	Organization identifier.
month	`string`	—	Calendar month in the form YYYY-MM. Defaults to last month.

Response#

Returns { data, _meta } with the result.