GroundTruth

GroundTruth Tenants API

The Tenants API from GroundTruth — 1 operation(s) for tenants.

GitHub OpenAPI

Operations 4

GET /tenants/{tenant_id}/dashboard/onboarding Get Tenant Dashboard Onboarding #
GET /tenants/{tenant_id}/dashboard/campaigns Get Tenant Dashboard Campaigns #
GET /tenants/{tenant_id} Get Tenant #
PUT /tenants/{tenant_id} Update Tenant #

Documentation

📖
Documentation
https://api-docs.groundtruth.com/
📖
APIReference
https://api-docs.groundtruth.com/
📖
Authentication
https://artifacts.apis.io/groundtruth/authentication/groundtruth-authentication.yml
📖
Documentation
https://reporting.groundtruth.com/api
📖
APIReference
https://reporting.groundtruth.com/api

Specifications

⚙
OpenAPI
https://artifacts.apis.io/groundtruth/openapi/groundtruth-tenants-api-openapi.yml

Other Resources

🔗
Console
https://api-public.groundtruth.com/docs
🔗
Conventions
https://artifacts.apis.io/groundtruth/conventions/groundtruth-conventions.yml
🔗
ErrorCatalog
https://artifacts.apis.io/groundtruth/errors/groundtruth-problem-types.yml
🔗
DataModel
https://artifacts.apis.io/groundtruth/data-model/groundtruth-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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/groundtruth:groundtruth-tenants-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

groundtruth-tenants-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Ads Manager Tenants API
  description: Ads Manager API
  version: 1.0.0
tags:
- name: Tenants
paths:
  /tenants/{tenant_id}/dashboard/onboarding:
    get:
      tags:
      - Tenants
      summary: Get Tenant Dashboard Onboarding
      description: Returns onboarding data for the tenant home page.
      operationId: get_tenant_dashboard_onboarding
      security:
      - api-key: []
      - user-id: []
      - session: []
      parameters:
      - name: tenant_id
        in: path
        required: true
        schema:
          type: integer
          title: Tenant Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantDashboardOnboardingModel'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
          description: Internal Server Error
  /tenants/{tenant_id}/dashboard/campaigns:
    get:
      tags:
      - Tenants
      summary: Get Tenant Dashboard Campaigns
      description: Returns a short list of campaigns for the tenant home page. Supports home-specific filters (pacing, flight start/end windows, inactive with no spend).
      operationId: get_tenant_dashboard_campaigns
      security:
      - api-key: []
      - user-id: []
      - session: []
      parameters:
      - name: tenant_id
        in: path
        required: true
        schema:
          type: integer
          title: Tenant Id
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 25
          minimum: 1
          description: Max campaigns to return
          default: 10
          title: Limit
        description: Max campaigns to return
      - name: sort_by
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/TenantDashboardCampaignSortField'
          description: Field to sort campaigns by
          default: created_date
        description: Field to sort campaigns by
      - name: sort_order
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/SortOrder'
          description: Sort order
          default: desc
        description: Sort order
      - name: pacing_min
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Include campaigns with pacing >= this value
          title: Pacing Min
        description: Include campaigns with pacing >= this value
      - name: pacing_max
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Include campaigns with pacing < this value
          title: Pacing Max
        description: Include campaigns with pacing < this value
      - name: flight_start_from
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          description: Include campaigns whose start date is on or after this date (YYYY-MM-DD)
          title: Flight Start From
        description: Include campaigns whose start date is on or after this date (YYYY-MM-DD)
      - name: flight_start_to
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          description: Include campaigns whose start date is on or before this date (YYYY-MM-DD)
          title: Flight Start To
        description: Include campaigns whose start date is on or before this date (YYYY-MM-DD)
      - name: flight_end_from
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          description: Include campaigns whose end date is on or after this date (YYYY-MM-DD)
          title: Flight End From
        description: Include campaigns whose end date is on or after this date (YYYY-MM-DD)
      - name: flight_end_to
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          description: Include campaigns whose end date is on or before this date (YYYY-MM-DD)
          title: Flight End To
        description: Include campaigns whose end date is on or before this date (YYYY-MM-DD)
      - name: inactive_no_spend
        in: query
        required: false
        schema:
          type: boolean
          description: When true, only campaigns with no lifetime spend and no active ad groups (includes campaigns with no ad groups, or only paused ad groups)
          default: false
          title: Inactive No Spend
        description: When true, only campaigns with no lifetime spend and no active ad groups (includes campaigns with no ad groups, or only paused ad groups)
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              $ref: '#/components/schemas/CampaignDashboardStatus'
          - type: 'null'
          description: Filter by derived campaign dashboard statuses (e.g. active)
          title: Status
        description: Filter by derived campaign dashboard statuses (e.g. active)
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantDashboardCampaignsModel'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
          description: Internal Server Error
  /tenants/{tenant_id}:
    get:
      tags:
      - Tenants
      summary: Get Tenant
      description: Gets a tenant
      operationId: get_tenant
      security:
      - api-key: []
      - user-id: []
      - session: []
      parameters:
      - name: tenant_id
        in: path
        required: true
        schema:
          type: integer
          title: Tenant Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantModel'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
          description: Internal Server Error
    put:
      tags:
      - Tenants
      summary: Update Tenant
      description: Updates a tenant
      operationId: update_tenant
      security:
      - api-key: []
      - user-id: []
      - session: []
      parameters:
      - name: tenant_id
        in: path
        required: true
        schema:
          type: integer
          title: Tenant Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTenantModel'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantModel'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseModel'
          description: Internal Server Error
components:
  schemas:
    ErrorResponseModel:
      properties:
        errors:
          items:
            $ref: '#/components/schemas/ErrorModel'
          type: array
          title: Errors
      type: object
      required:
      - errors
      title: ErrorResponseModel
    TenantDashboardCampaignModel:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        account_id:
          type: integer
          title: Account Id
        start_date:
          type: string
          format: date
          title: Start Date
        end_date:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: End Date
        created_date:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Created Date
        budget:
          anyOf:
          - type: number
          - type: 'null'
          title: Budget
        budget_type:
          $ref: '#/components/schemas/BudgetType'
        pacing:
          anyOf:
          - type: number
          - type: 'null'
          title: Pacing
      type: object
      required:
      - id
      - name
      - account_id
      - start_date
      - budget_type
      title: TenantDashboardCampaignModel
    UpdateTenantModel:
      properties:
        name:
          type: string
          maxLength: 64
          minLength: 1
          title: Name
      type: object
      required:
      - name
      title: UpdateTenantModel
    TenantDashboardOnboardingModel:
      properties:
        has_campaigns:
          type: boolean
          title: Has Campaigns
        has_chargeable_card:
          type: boolean
          title: Has Chargeable Card
      type: object
      required:
      - has_campaigns
      - has_chargeable_card
      title: TenantDashboardOnboardingModel
    TenantDashboardCampaignSortField:
      oneOf:
      - const: created_date
        title: CREATED_DATE
      - const: start_date
        title: START_DATE
      - const: end_date
        title: END_DATE
      - const: pacing
        title: PACING
      type: string
      enum:
      - created_date
      - start_date
      - end_date
      - pacing
      title: TenantDashboardCampaignSortField
      x-enum-varnames:
      - CREATED_DATE
      - START_DATE
      - END_DATE
      - PACING
    PaymentType:
      oneOf:
      - const: 0
        title: INVOICE
      - const: 1
        title: CREDIT_CARD
      - const: 2
        title: SPEND_LIMIT
      - const: 3
        title: CREDIT_CARD_V2
      - const: 4
        title: ACCOUNT_LEVEL_CREDIT_CARD
      type: integer
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      title: PaymentType
      x-enum-varnames:
      - INVOICE
      - CREDIT_CARD
      - SPEND_LIMIT
      - CREDIT_CARD_V2
      - ACCOUNT_LEVEL_CREDIT_CARD
    BudgetType:
      oneOf:
      - const: 0
        title: LIFETIME
      - const: 1
        title: PERIODIC
      - const: 2
        title: TIME_PERIOD
      - const: 3
        title: DAILY
      type: integer
      enum:
      - 0
      - 1
      - 2
      - 3
      title: BudgetType
      x-enum-varnames:
      - LIFETIME
      - PERIODIC
      - TIME_PERIOD
      - DAILY
    SortOrder:
      oneOf:
      - const: desc
        title: DESC
      - const: asc
        title: ASC
      type: string
      enum:
      - desc
      - asc
      title: SortOrder
      x-enum-varnames:
      - DESC
      - ASC
    ErrorModel:
      properties:
        code:
          type: string
          title: Code
        message:
          type: string
          title: Message
        fields:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Fields
      type: object
      required:
      - code
      - message
      - fields
      title: ErrorModel
    TenantDashboardCampaignsModel:
      properties:
        items:
          items:
            $ref: '#/components/schemas/TenantDashboardCampaignModel'
          type: array
          title: Items
      type: object
      required:
      - items
      title: TenantDashboardCampaignsModel
    CampaignDashboardStatus:
      oneOf:
      - const: active
        title: ACTIVE
      - const: paused
        title: PAUSED
      - const: pending
        title: PENDING
      - const: expired
        title: EXPIRED
      type: string
      enum:
      - active
      - paused
      - pending
      - expired
      title: CampaignDashboardStatus
      x-enum-varnames:
      - ACTIVE
      - PAUSED
      - PENDING
      - EXPIRED
    TenantType:
      oneOf:
      - const: 0
        title: MANAGED
      - const: 1
        title: SELF_SERVE
      - const: 2
        title: CHANNEL
      type: integer
      enum:
      - 0
      - 1
      - 2
      title: TenantType
      x-enum-varnames:
      - MANAGED
      - SELF_SERVE
      - CHANNEL
    TenantModel:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        type:
          $ref: '#/components/schemas/TenantType'
        tier:
          type: integer
          title: Tier
        is_holding_company:
          type: boolean
          title: Is Holding Company
        payment_type:
          $ref: '#/components/schemas/PaymentType'
        created_date:
          type: string
          format: date-time
          title: Created Date
        updated_date:
          type: string
          format: date-time
          title: Updated Date
        referrer_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Referrer Url
        utm_campaign:
          anyOf:
          - type: string
          - type: 'null'
          title: Utm Campaign
      type: object
      required:
      - id
      - name
      - type
      - tier
      - is_holding_company
      - payment_type
      - created_date
      - updated_date
      - referrer_url
      - utm_campaign
      title: TenantModel
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: x-gt-api-key
    user-id:
      type: apiKey
      in: header
      name: x-gt-user-id
x-provenance:
  method: harvested
  publisher: GroundTruth
  source: https://api-public.groundtruth.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)