Organization

Retrieve Organization Information

Retrieves information about the organization.

GET: /api/v1/issuers/organization

Response Example

{
  "data": {
    "id": "e5737c21-0645-4616-9b25-c010685c5b30",
    "type": "public_local_national",
    "activity": "university",
    "name": "Example Org",
    "description": "This is a description.",
    "address_info": {
      "city": "Example City",
      "state": "Example State",
      "region": "Example Region",
      "street": "123 Example Street",
      "country": "Example Country",
      "postcode": "12345"
    },
    "billing_info": {
      "vat": "VAT123456",
      "email": "billing@example.com",
      "code_dest": "CODE123",
      "fiscal_code": "FISCAL123",
      "certified_email": "certified@example.com"
    },
    "language": "en",
    "website": "https://open-badge.eu",
    "status": "enabled",
    "contact_info": {
      "name": "John",
      "email": "contact@open-badge.eu",
      "mobile": "1234567890",
      "last_name": "Doe",
      "tech_email": "tech@example.com",
      "legal_email": "legal@example.com"
    },
    "logo_path": "https://storage.googleapis.com/openbadge-public/open-badges-dev/organizations-logos/0UJ009yGYDrI8xV8sFmGW7dpFlwJsl7GU1qA3Etp.png",
    "logo_high_path": "https://storage.googleapis.com/openbadge-public/open-badges-dev/organizations-logos/0UJ009yGYDrI8xV8sFmGW7dpFlwJsl7GU1qA3Etp_high.png",
    "logo_thumbnail_path": "https://storage.googleapis.com/openbadge-public/open-badges-dev/organizations-logos/0UJ009yGYDrI8xV8sFmGW7dpFlwJsl7GU1qA3Etp_thumbnail.png",
    "created_at": "2024-06-17T06:37:33.000000Z",
    "updated_at": "2024-06-24T07:03:52.000000Z"
  }
}

Upload logo to the organization profile

Uploads the selected logo the organization profile.

POST: /api/v1/issuers/organization/logo

{ "data": { "id": "0f11feda-07f8-4202-9133-4a4e780e857d", "type": "public_local_national", "activity": "school", "name": "LearnQuest Academy", "description": "Welcome to LearnQuest Academy, where education meets innovation! At LearnQuest, we offer a diverse array of courses designed to expand your knowledge and skills across various topics. Upon successful completion of each course, students earn distinctive badges, showcasing their achievements and expertise. Whether you're delving into technology, arts, sciences, or personal development, our engaging curriculum and dedicated instructors ensure a comprehensive learning experience. Join us at LearnQuest Academy and start earning your badges today!!!", "address_info": { "city": "Example City", "state": "Example State", "region": "Example Region", "street": "123 Example Street", "country": "Example Country", "postcode": "12345" }, "billing_info": { "vat": "VAT123456", "email": "billing@open-badge.eu", "code_dest": "CODE123", "fiscal_code": "FISCAL123", "certified_email": "certified@open-badge.eu", "legal_name": "LearnQuest Academy s.r.l." }, "language": "it", "website": "https://www.example.com", "status": "enabled", "contact_info": { "name": "John", "email": "contact@open-badge.eu", "mobile": "+001234567890", "last_name": "Doe", "tech_email": "tech@open-badge.eu", "legal_email": "legal@open-badge.eu" }, "settings": { "public_profile": 1, "public_badge_types": 1, "public_learning_paths": 0, "public_badge_templates": 1 }, "logo_path": "https://storage.googleapis.com/openbadge-public/open-badges-dev/organizations/0f11feda-07f8-4202-9133-4a4e780e857d/organization-logos/9hpYVtMrcEa2sSXAy20KQxGESXQBdAp5pKlRdjx6.png", "logo_high_path": "https://storage.googleapis.com/openbadge-public/open-badges-dev/organizations/0f11feda-07f8-4202-9133-4a4e780e857d/organization-logos/9hpYVtMrcEa2sSXAy20KQxGESXQBdAp5pKlRdjx6_high.png", "logo_thumbnail_path": "https://storage.googleapis.com/openbadge-public/open-badges-dev/organizations/0f11feda-07f8-4202-9133-4a4e780e857d/organization-logos/9hpYVtMrcEa2sSXAy20KQxGESXQBdAp5pKlRdjx6_thumbnail.png", "credits_left": 39806, "badge_templates_count": 28, "badges_count": 755, "created_at": "2024-07-03T15:02:45.000000Z", "updated_at": "2024-09-27T15:26:27.000000Z", "public_url": "https://openbadges.open-badge.eu/public/issuers/0f11feda-07f8-4202-9133-4a4e780e857d", "stripe_customer_id": "cus_QpT1CW2JIJb9fL", "subscription_id": null, "subscription_status": "active", "current_period_start": "2024-09-24 07:53:39", "current_period_end": "2024-10-24 07:53:39", "max_users": 1 } }

Update Organization Details

Updates the organization details.

PUT: /api/v1/issuers/organization

Parameters that can be updated:

activity: Organization activity (Accepted values university).
type: Organization type (Accepted values public_local_national).
name: Organization name.
description: Organization description.
logo: Upload or update the organization logo.
address_info[street]: Street name.
address_info[city]: City.
address_info[state]: State.
address_info[postcode]: Postal code.
address_info[country]: Country.
address_info[region]: Region.
billing_info[email]: Billing email address.
billing_info[certified_email]: Certified billing email.
billing_info[fiscal_code]: Fiscal code.
billing_info[vat]: VAT number.
billing_info[code_dest]: Destination code.
language: Language code (it oren).
contact_info[name]: Contact's first name.
contact_info[last_name]: Contact's last name.
contact_info[email]: Contact's email address.
contact_info[mobile]: Contact's mobile number.
contact_info[tech_email]: Technical support email.
contact_info[legal_email]: Legal contact email.
website: Organization website.
settings[public_profile]: Organization settings (1 if true, 0 if false).
settings[public_badge_templates]: Organization settings (1 if true, 0 if false).

{
  "data": {
    "id": "0f11feda-07f8-4202-9133-4a4e780e857d",
    "type": "public_local_national",
    "activity": "school",
    "name": "LearnQuest Academyyyyy",
    "description": "<p><em>Welcome to <\/em><strong>LearnQuest Academy<\/strong><em>, where education meets innovation! At LearnQuest, we offer a diverse array of courses designed to expand your knowledge and skills across various topics. Upon successful completion of each course, students earn distinctive badges, showcasing their achievements and expertise. Whether you're delving into technology, arts, sciences, or personal development, our engaging curriculum and dedicated instructors ensure a comprehensive learning experience. Join us at LearnQuest Academy and start earning your badges today!!!<\/em><\/p>",
    "address_info": {
      "city": "Example City",
      "state": "Example State",
      "region": "Example Region",
      "street": "123 Example Street",
      "country": "Example Country",
      "postcode": "12345"
    },
    "billing_info": {
      "vat": "VAT123456",
      "email": "billing@open-badge.eu",
      "code_dest": "CODE123",
      "fiscal_code": "FISCAL123",
      "certified_email": "certified@open-badge.eu",
      "legal_name": "LearnQuest Academy s.r.l."
    },
    "language": "en",
    "website": "https:\/\/www.example.com",
    "status": "enabled",
    "contact_info": {
      "name": "John",
      "email": "contact@open-badge.eu",
      "mobile": "+001234567890",
      "last_name": "Doe",
      "tech_email": "tech@open-badge.eu",
      "legal_email": "legal@open-badge.eu"
    },
    "settings": {
      "public_profile": 1,
      "public_badge_types": 1,
      "public_learning_paths": 0,
      "public_badge_templates": 1
    },
    "logo_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/organizations\/0f11feda-07f8-4202-9133-4a4e780e857d\/organization-logos\/fOwXBgxG9qxoizXXZlkrCKaldkFdI8Ez6TWRIn35.png",
    "logo_high_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/organizations\/0f11feda-07f8-4202-9133-4a4e780e857d\/organization-logos\/fOwXBgxG9qxoizXXZlkrCKaldkFdI8Ez6TWRIn35_high.png",
    "logo_thumbnail_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/organizations\/0f11feda-07f8-4202-9133-4a4e780e857d\/organization-logos\/fOwXBgxG9qxoizXXZlkrCKaldkFdI8Ez6TWRIn35_thumbnail.png",
    "credits_left": 38422,
    "badge_templates_count": 24,
    "badges_count": 739,
    "created_at": "2024-07-03T15:02:45.000000Z",
    "updated_at": "2024-09-16T15:42:31.000000Z",
    "public_url": "https:\/\/openbadges.open-badge.eu\/public\/issuers\/0f11feda-07f8-4202-9133-4a4e780e857d",
    
    "stripe_customer_id": "cus_QpT1CW2JIJb9fL",
    "subscription_id": null,
    "subscription_status": "active",
    "current_period_start": "2024-09-16 13:29:49",
    "current_period_end": "2024-10-16 13:29:49"
  }
}

Retrieve annual organization statistics

Displays the total number of badges issued by the organization within the selected year.

GET: /api/v1/issuers/organization/year-statistics?year={year}

The value to pass is the year. If no value passed - the system retrieves by default the crrrent year.

{
    "labels": [
        "Jan",
        "Feb",
        "Mar",
        "Apr",
        "May",
        "Jun",
        "Jul",
        "Aug",
        "Sep",
        "Oct",
        "Nov",
        "Dec"
    ],
    "badges": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
    ],
    "learning_paths": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
    ]
}

Retrieve organization statistics

Query parameters

GET: /api/v1/issuers/organization/statistics

Response

{
    "badges_count": 755,
    "earners_count": 150,
    "badges_expired_count": 6,
    "credits_left": 39806,
    "badge_assignees_ratio": 5,
    "shared_by_user_count": null,
    "badges_by_type": {
        "participation": 167,
        "skills": 189,
        "qualification": 392,
        "knowledge": 7
    },
    "learning_paths_by_type": {
        "knowledge": 5
    },
    "top_5_badge_templates_assigned": {
        "Farm-to-Table Culinary Expert": 300,
        "Microsoft Liberal Studies Completion": 113,
        "Data Science Professional": 108,
        "Web Development Course Completion": 38,
        "Leadership Training Program Graduate": 31
    }
}

Last modified: 12 November 2024