Retrieve specific configuration

GET 
/v1/validation-submission-configurations/:id

Retrieve specific configuration

Request

Path Parameters

id stringrequired

Id of the validation submission configuration

Responses

200

Successfully fetch configurations

application/json

Schema

Schema

data

object

id string

Validation Submission configuration id

Example: hostedconfiguration_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

name stringnullable

Validation Submission configuration name

allowedOrganisationsTypes string[]

Possible values: [social_impact, nonprofit, education]

complianceFlags string[]

Possible values: [warning, sanction, controversial, commercial, adverseMedia, hateSpeech, compliance]

rejectedOrganisationsTypes string[]

Possible values: [social_impact, nonprofit, education]

allowedActivitySubTags string[]

exceptionRules string[]
object string
Example: partner_program_configuration

Example (from schema)

{
  "data": {
    "id": "hostedconfiguration_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "name": "string",
    "allowedOrganisationsTypes": [
      "social_impact"
    ],
    "complianceFlags": [
      "warning"
    ],
    "rejectedOrganisationsTypes": [
      "social_impact"
    ],
    "allowedActivitySubTags": [
      "activitysubtag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    ],
    "exceptionRules": [
      "string"
    ]
  },
  "object": "partner_program_configuration"
}

401

Unauthorized

403

Forbidden (scope)

application/json

Schema

Schema

error

object

code string

Example: forbidden

title string

Example: Forbidden

message string

Example: Access is denied due to missing scope permissions

Example (from schema)

{
  "error": {
    "code": "forbidden",
    "title": "Forbidden",
    "message": "Access is denied due to missing scope permissions"
  }
}

404

The specified resource was not found

application/json

Schema

Schema

error

object

code string

Example: not_found

title string

Example: Resource not found

message string

Example: This endpoint is unavailable or can not be found

Example (from schema)

{
  "error": {
    "code": "not_found",
    "title": "Resource not found",
    "message": "This endpoint is unavailable or can not be found"
  }
}

Loading...