Marketo Type API

The Type API from Marketo — 1 operation(s) for type.

OpenAPI Specification

marketo-type-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: Marketo Engage Rest Approve Type API
  description: Marketo exposes a REST API which allows for remote execution of many of the systems capabilities. From creating programs to bulk lead import, there are many options which allow fine-grained control of a Marketo instance.
  termsOfService: https://www.adobe.com/legal.html
  contact:
    name: Adobe Developer Relations
    url: https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/home
    email: developerfeedback@marketo.com
  license:
    name: API License Agreement
    url: https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/api-license
  version: '1.0'
servers:
- url: https://localhost:8080/
tags:
- name: Type
paths:
  /rest/asset/v1/tagType/byName.json:
    get:
      tags:
      - Type
      summary: Marketo Get Tag By Name
      description: 'Retrieves a tag by its name. This will also return the set of valid values for the tag. Required Permissions: Read-Only Assets, Read-Write Assets'
      operationId: getTagByNameUsingGET
      parameters:
      - name: name
        in: query
        description: Name of the tag
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseOfTagResponse'
components:
  schemas:
    TagResponse:
      required:
      - applicableProgramTypes
      - required
      - tagType
      type: object
      properties:
        allowableValues:
          type: string
          description: The list of acceptable values for the tag type
        applicableProgramTypes:
          type: string
          description: Types of programs to which the tag can apply
        required:
          type: boolean
          description: Whether the tag is required for its applicable program types
        tagType:
          type: string
          description: Name of the tag
    ResponseOfTagResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        requestId:
          type: string
        result:
          type: array
          items:
            $ref: '#/components/schemas/TagResponse'
        success:
          type: boolean
        warnings:
          type: array
          items:
            type: string
    Error:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
          description: Error code of the error. See full list of error codes <a href="https://developers.marketo.com/rest-api/error-codes/">here</a>
        message:
          type: string
          description: Message describing the cause of the error
x-original-swagger-version: '2.0'