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

Description

OK

Schema documentation

• customerIdstring (uuid)

  required
• descriptionstring

  required
• emailstring
• idstring (uuid)

  required
• logoRefIdstring
• namestring

  required
• phonestring
• statestring (one of: enabled, disabled)

  required
• urlstring

Example

{
  "customerId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "description": "string",
  "email": "string",
  "id": "f0f86186-0a5a-45b2-aa33-502777496347",
  "logoRefId": "string",
  "name": "string",
  "phone": "string",
  "state": "enabled",
  "url": "string"
}

JSON Schema

{
  "properties": {
    "customerId": {
      "format": "uuid",
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "id": {
      "format": "uuid",
      "type": "string"
    },
    "logoRefId": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "phone": {
      "type": "string"
    },
    "state": {
      "enum": [
        "enabled",
        "disabled"
      ],
      "type": "string"
    },
    "url": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "customerId",
    "state",
    "name",
    "description"
  ],
  "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();