find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/metricool:metricool-organization-roles-api-service-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Metricool Organization Roles Api Service API
  description: 'Metricool API


    The base URL for all endpoints is: https://app.metricool.com/api


    All endpoints require authentication.'
  version: 2.0.0
servers:
- url: https://app.metricool.com/api
tags:
- name: Organization Roles Api Service
paths:
  /v2/organizations/{organizationId}/roles:
    get:
      tags:
      - Organization Roles Api Service
      summary: List the roles of an organization.
      operationId: getRoles_2
      parameters:
      - name: organizationId
        in: path
        description: Id of the organization
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Roles retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkListResponseBrandRole'
        '400':
          description: The organization owner's plan does not include shared profiles.
        '403':
          description: Caller is not a regular-user session, the organization permissions feature is disabled for the organization's owner, the organization's owner does not hold an Advanced-or-higher plan, or the caller cannot read the roles of this organization.
        '404':
          description: Organization not found, or its owner account could no longer be resolved.
    post:
      tags:
      - Organization Roles Api Service
      summary: Create a role in an organization.
      operationId: createRole
      parameters:
      - name: organizationId
        in: path
        description: Id of the organization
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBrandRoleRequest'
        required: true
      responses:
        '200':
          description: Role created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkResponseBrandRole'
        '400':
          description: Invalid request body, or the role could not be created.
        '403':
          description: Caller is not a regular-user session, the organization permissions feature is disabled for the organization's owner, the organization's owner does not hold an Advanced-or-higher plan, or the caller cannot manage the roles of this organization.
        '404':
          description: Organization not found, or its owner account could no longer be resolved.
  /v2/organizations/{organizationId}/roles/{roleId}:
    delete:
      tags:
      - Organization Roles Api Service
      summary: Delete a role of an organization.
      operationId: deleteRole_1
      parameters:
      - name: organizationId
        in: path
        description: Id of the organization
        required: true
        schema:
          type: integer
          format: int64
      - name: roleId
        in: path
        description: Id of the role to delete
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Role deleted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkResponseBoolean'
        '400':
          description: The role still has collaborator assignments or is still held by a team member, or roleId does not belong to the organization owner or is a SYSTEM/INTERNAL role.
        '403':
          description: Caller is not a regular-user session, the organization permissions feature is disabled for the organization's owner, the organization's owner does not hold an Advanced-or-higher plan, or the caller cannot manage the roles of this organization, or roleId is the role granting the caller their own delegation.
        '404':
          description: Organization not found, its owner account could no longer be resolved, or no role exists with roleId.
    patch:
      tags:
      - Organization Roles Api Service
      summary: Update a role of an organization.
      operationId: updateRole_1
      parameters:
      - name: organizationId
        in: path
        description: Id of the organization
        required: true
        schema:
          type: integer
          format: int64
      - name: roleId
        in: path
        description: Id of the role to update
        required: true
        schema:
          type: integer
          format: int64
      - name: fields
        in: query
        required: true
        schema:
          type: array
          items:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateBrandRoleRequest'
        required: true
      responses:
        '200':
          description: Role updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonOkResponseBrandRole'
        '400':
          description: Invalid request body, or roleId does not belong to the organization owner or is a SYSTEM/INTERNAL role.
        '403':
          description: Caller is not a regular-user session, the organization permissions feature is disabled for the organization's owner, the organization's owner does not hold an Advanced-or-higher plan, or the caller cannot manage the roles of this organization, or roleId is the role granting the caller their own delegation.
        '404':
          description: Organization not found, its owner account could no longer be resolved, or no role exists with roleId.
components:
  schemas:
    CreateBrandRoleRequest:
      required:
      - actions
      - color
      - name
      type: object
      properties:
        name:
          minLength: 1
          type: string
        description:
          type: string
        color:
          minLength: 1
          type: string
        actions:
          $ref: '#/components/schemas/BrandRoleActions'
        organizationActions:
          $ref: '#/components/schemas/OrganizationRoleActionsDto'
    UpdateBrandRoleRequest:
      required:
      - actions
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        color:
          type: string
        actions:
          $ref: '#/components/schemas/BrandRoleActions'
        organizationActions:
          $ref: '#/components/schemas/OrganizationRoleChangeActionsDto'
    OrganizationRoleChangeActionsDto:
      type: object
      properties:
        manageBrands:
          type: boolean
          description: Whether the role can create and manage brands at the organization level.
        manageRoles:
          type: boolean
          description: Whether the role can create and manage other brand roles at the organization level.
        manageTeamMembers:
          type: boolean
          description: Whether the role can manage team members at the organization level.
        manageAgencyConfig:
          type: boolean
          description: Whether the role can manage the agency configuration.
        manageAgencyClients:
          type: boolean
          description: Whether the role can manage agency clients.
      description: 'Partial update of the organization-level permissions granted by a brand role. Each field is nullable: only the fields also listed in the request''s ''fields'' query param are actually applied - the rest are ignored, whether null or not. Omitting this object entirely from the request body (leaving it null) means ''do not touch organization permissions in this PATCH''.'
    JsonOkResponseBoolean:
      type: object
      properties:
        metadata:
          type: object
        page:
          $ref: '#/components/schemas/JsonPaging'
        data:
          type: boolean
    OrganizationRoleActionsDto:
      type: object
      properties:
        manageBrands:
          type: boolean
          description: Whether the role can create and manage brands at the organization level.
        manageRoles:
          type: boolean
          description: Whether the role can create and manage other brand roles at the organization level.
        manageTeamMembers:
          type: boolean
          description: Whether the role can manage team members at the organization level.
        manageAgencyConfig:
          type: boolean
          description: Whether the role can manage the agency configuration.
        manageAgencyClients:
          type: boolean
          description: Whether the role can manage agency clients.
      description: Organization-level permissions granted by a brand role, on top of the per-brand actions. Never null in a read response - a role that never had organization permissions set is reported with every field false.
    JsonPaging:
      type: object
      properties:
        next:
          type: string
    JsonOkResponseBrandRole:
      type: object
      properties:
        metadata:
          type: object
        page:
          $ref: '#/components/schemas/JsonPaging'
        data:
          $ref: '#/components/schemas/BrandRole'
    BrandRoleActions:
      type: object
      properties:
        viewAnalytics:
          type: boolean
        viewInbox:
          type: boolean
        viewPlanner:
          type: boolean
        viewAds:
          type: boolean
        viewSmartlinks:
          type: boolean
        fullAccessReports:
          type: boolean
        fullAccessInbox:
          type: boolean
        fullAccessPlanner:
          type: boolean
        fullAccessAds:
          type: boolean
        fullAccessSmartlinks:
          type: boolean
        fullAccessHashtagTracker:
          type: boolean
        editBrand:
          type: boolean
        schedulePosts:
          type: boolean
        publishPosts:
          type: boolean
        approvePosts:
          type: boolean
        viewCondensedAnalytics:
          type: boolean
        fullAccessDashboards:
          type: boolean
        viewDashboards:
          type: boolean
        editFlow:
          type: boolean
        viewFlow:
          type: boolean
        fullAccessStudio:
          type: boolean
    JsonOkListResponseBrandRole:
      type: object
      properties:
        metadata:
          type: object
        page:
          $ref: '#/components/schemas/JsonPaging'
        data:
          type: array
          items:
            $ref: '#/components/schemas/BrandRole'
    DateTimeInfo:
      required:
      - dateTime
      type: object
      properties:
        dateTime:
          type: string
          description: 'Local Date-time represented with a certain timezone '
        timezone:
          type: string
          description: Timezone applied to the datetime
    BrandRole:
      required:
      - actions
      - name
      - organizationActions
      - userId
      type: object
      properties:
        id:
          type: integer
          format: int64
        userId:
          type: integer
          format: int32
        name:
          minLength: 1
          type: string
        description:
          type: string
        color:
          type: string
        type:
          type: string
        assignable:
          type: boolean
        teamMemberOnly:
          type: boolean
        deletedDate:
          $ref: '#/components/schemas/DateTimeInfo'
        deleted:
          type: boolean
        actions:
          $ref: '#/components/schemas/BrandRoleActions'
        organizationActions:
          $ref: '#/components/schemas/OrganizationRoleActionsDto'
        assignedUsersCount:
          type: integer
          format: int32
        assignedEnabledCount:
          type: integer
          format: int32
        assignedDisabledCount:
          type: integer
          format: int32