Get a contributor

GET/contributors/{contributorId}/

API version

v2

Request method

GET

Operation ID

extension-get-contributor

---

Request

• contributorIdstring (uuid)

  required

Responses

Format

application/json

Beschreibung

OK

Schema-Dokumentation

*

Beispiel

Content-Type: application/json

null

JSON Schema

{
  "anyOf": [
    {
      "properties": {
        "customerId": {
          "format": "uuid",
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "descriptions": {
          "description": "A few words about the introduction as a contributor",
          "properties": {
            "de": {
              "example": "Ich bin ein Contributor",
              "type": "string"
            },
            "en": {
              "example": "I am a contributor",
              "type": "string"
            }
          },
          "required": [
            "de"
          ],
          "type": "object"
        },
        "email": {
          "deprecated": true,
          "type": "string"
        },
        "homepage": {
          "type": "string"
        },
        "id": {
          "format": "uuid",
          "type": "string"
        },
        "imprint": {
          "oneOf": [
            {
              "properties": {
                "text": {
                  "minLength": 1,
                  "type": "string"
                }
              },
              "required": [
                "text"
              ],
              "type": "object"
            },
            {
              "properties": {
                "url": {
                  "format": "uri",
                  "minLength": 1,
                  "type": "string"
                }
              },
              "required": [
                "url"
              ],
              "type": "object"
            }
          ]
        },
        "logoRefId": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "phone": {
          "deprecated": true,
          "type": "string"
        },
        "state": {
          "enum": [
            "enabled",
            "disabled"
          ],
          "type": "string"
        },
        "supportInformation": {
          "properties": {
            "email": {
              "example": "a.lovelace@example.com",
              "type": "string"
            },
            "phone": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "url": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "customerId",
        "state",
        "name",
        "supportInformation"
      ],
      "type": "object"
    },
    {
      "properties": {
        "contactPersonUserId": {
          "format": "uuid",
          "type": "string"
        },
        "contractOwner": {
          "type": "object",
          "properties": {
            "firstName": {
              "type": "string"
            },
            "lastName": {
              "type": "string"
            },
            "title": {
              "type": "string"
            },
            "salutation": {
              "type": "string",
              "enum": [
                "mr",
                "ms",
                "other"
              ]
            },
            "company": {
              "type": "string"
            },
            "address": {
              "type": "object",
              "properties": {
                "street": {
                  "type": "string",
                  "example": "Königsberger Straße"
                },
                "houseNumber": {
                  "type": "string",
                  "example": "4-6"
                },
                "city": {
                  "type": "string",
                  "example": "Espelkamp"
                },
                "zip": {
                  "type": "string",
                  "example": "32339"
                },
                "countryCode": {
                  "type": "string",
                  "example": "DE",
                  "description": "ISO 3166-1 alpha-2 country code"
                },
                "addressPrefix": {
                  "type": "string",
                  "example": "c/o Ada Lovelace"
                }
              },
              "required": [
                "street",
                "houseNumber",
                "city",
                "zip",
                "countryCode"
              ]
            },
            "emailAddress": {
              "type": "string",
              "format": "email"
            },
            "phoneNumbers": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "useFormalTerm": {
              "type": "boolean"
            }
          },
          "required": [
            "address",
            "salutation"
          ]
        },
        "contributorNumber": {
          "type": "string"
        },
        "customerId": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "email": {
          "deprecated": true,
          "format": "email",
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "imprint": {
          "oneOf": [
            {
              "properties": {
                "text": {
                  "minLength": 1,
                  "type": "string"
                }
              },
              "required": [
                "text"
              ],
              "type": "object"
            },
            {
              "properties": {
                "url": {
                  "format": "uri",
                  "minLength": 1,
                  "type": "string"
                }
              },
              "required": [
                "url"
              ],
              "type": "object"
            }
          ]
        },
        "logoRefId": {
          "format": "uuid",
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "phone": {
          "deprecated": true,
          "type": "string"
        },
        "state": {
          "enum": [
            "enabled",
            "disabled"
          ],
          "type": "string"
        },
        "supportInformation": {
          "properties": {
            "email": {
              "example": "a.lovelace@example.com",
              "type": "string"
            },
            "phone": {
              "type": "string"
            }
          },
          "type": "object"
        },
        "url": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "customerId",
        "state",
        "name",
        "supportInformation",
        "contactPersonUserId",
        "contractOwner",
        "contributorNumber"
      ],
      "type": "object"
    }
  ]
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/contributors/f0f86186-0a5a-45b2-aa33-502777496347

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.marketplace.extensionGetContributor({
  "contributorId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Marketplace\ExtensionGetContributor\ExtensionGetContributorRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new ExtensionGetContributorRequest(
  contributorId: "f0f86186-0a5a-45b2-aa33-502777496347"
));
$response = $client->marketplace()->extensionGetContributor($request);

var_dump($response->getBody();