Organization

id

string

Unique identifier of the organization.

type

ENUM

Type of organization.

Possible values: public_local_national, private_non_profit, private_profit, private_other.

activity

ENUM

Main activity of the organization.

Possible values: school, university, professional_training, volunteering, civil_society, orientation, other.

name

string

Name of the organization.

description

string

Description of the organization (possible in HTML format).

address_info

object

Object containing organization address details.

address_info.city

string

City where the organization is located.

address_info.state

string

State where the organization is located.

address_info.region

string

Region where the organization is located.

address_info.street

string

Street address of the organization.

address_info.country

string

Country where the organization is located.

address_info.postcode

string

Postal code of the organization's location.

billing_info

object

Object containing organization billing details.

billing_info.vat

string

VAT number used for billing purposes.

billing_info.email

string

Billing contact email.

billing_info.code_dest

string

Billing destination code.

billing_info.fiscal_code

string

Fiscal code for the organization.

billing_info.certified_email

string

Certified email address for billing purposes.

billing_info.legal_name

string

Legal name of the organization.

language

ENUM

Primary language used by the organization.

Possible values: it, en.

website

string

Website URL of the organization.

status

ENUM

Current status of the organization.

Possible values: enabled, disabled. This value is set only by Open Badges Admins.

contact_info

object

Object containing organization contact details.

contact_info.name

string

First name of the contact person.

contact_info.last_name

string

Last name of the contact person.

contact_info.mobile

string

Mobile number of the contact person.

contact_info.email

string

General contact email address.

contact_info.tech_email

string

Technical contact email address.

contact_info.legal_email

string

Legal contact email address.

settings

object

Object containing details of the organization settings within the system.

settings.public_profile

boolean

Indicates whether the public profile is active (true) or not (false).

settings.public_badge_types

boolean

Indicates whether the badge types are displayed (true) or not (false) on the organization's public profile.

settings.public_learning_paths

boolean

Indicates whether the learning paths are displayed (true) or not (false) on the organization's public profile.

settings.public_badge_templates

boolean

Indicates whether the badges are displayed (true) or not (false) on the organization's public profile.

logo_path

string

URL of the organization's logo.

logo_high_path

string

URL of the high-resolution version of the organization's logo.

logo_thumbnail_path

string

URL of the thumbnail version of the organization's logo.

credits_left

integer

Remaining credits in the Wallet for the organization.

badge_templates_count

integer

Total number of badge templates created by the organization.

badges_count

integer

Total number of badges issued by the organization.

created_at

timestamp

Date and time when the organization was created.

Format: YYYY-MM-DD HH:MM:SS, UTC timezone.

updated_at

timestamp

Date and time when the organization was last updated.

Format: YYYY-MM-DD HH:MM:SS, UTC timezone.

public_url

string

Public URL of the organization's profile or issuer page (if activated).

imp_legacy_id

string

Legacy identifier, if applicable.

stripe_customer_id

string

Stripe customer ID for billing and subscription management.

subscription_id

string

Identifier for the subscription, if applicable.

subscription_status

ENUM

Current status of the subscription.

Possible values: active, cancelled.

current_period_start

timestamp

Start date of the subscription.

Format: YYYY-MM-DD HH:MM:SS, UTC timezone.

current_period_end

timestamp

End date of the subscription.

Format: YYYY-MM-DD HH:MM:SS, UTC timezone.

max_users

integer

Maximum number of users allowed for the organization.