Skip to content

Organizations

List Organizations

Request

GET /organizations

Response

200 OK

{
  "data": [
    {
      "id": "ba92621f-f22c-41e5-9157-c2dc274e3cf0",
      "name": "Organization 8",
      "website_url": "http://www.example.com/",
      "webhook_url": "https://example.com/webhook.asp",
      "contact_email": "hello8@example.com",
      "legal_contact_email": "legal8@example.com",
      "technical_contact_email": "person8@example.com",
      "zip_or_postal_code": "55437",
      "organization_type": "Dynamic Markets Engineering",
      "bio": "Function-based eco-centric standardization gurus",
      "twitter_url": "https://twitter.com/example",
      "vanity_slug": "organization-8",
      "facebook_url": "https://www.facebook.com/example",
      "linked_in_url": "https://www.linkedin.com/example",
      "linked_in_name": null,
      "linked_in_org_id": null,
      "city": "Bloomington",
      "address": "1313 Mockingbird Lane",
      "primary_hex_color": null,
      "support_email": "someEmail@example.com",
      "support_url": "https://example.com",
      "allow_saml_debug": false,
      "allowed_webhooks": [],
      "enable_blockchain": false,
      "print_method": null,
      "pdf_id": null,
      "internationalize_badge_templates": false,
      "integrated_with_faethm": false,
      "hide_subscription": false,
      "default_page": "badges",
      "industry_id": null,
      "workforce_enabled": false,
      "linkedin_a2p_url": null,
      "location": "1313 Mockingbird Lane Bloomington Minnesota 55437 United States",
      "country": "United States",
      "state_or_province": "Minnesota",
      "created_at": "2014-04-01T14:41:00.000Z",
      "updated_at": "2014-04-01T14:41:00.000Z",
      "vanity_url": "https://www.credly.com/org/organization-8",
      "verified_at": "2018-04-08T17:57:34.595Z",
      "verified": true,
      "require_template_detail_attributes": false,
      "photo": {
        "id": "18de8086-1d3b-4a73-acb5-de348744f6b6",
        "url": "/system/test/images/18de8086-1d3b-4a73-acb5-de348744f6b6/large_fake-600x600.png"
      },
      "photo_url": "https://cdn.example.com/path/to/image.png",
      "has_employees": false,
      "missing_required_info": false,
      "featured_badge_templates": [

      ]
    }
  ],
  "metadata": {
    "count": 1,
    "current_page": 1,
    "total_count": 1,
    "total_pages": 1,
    "per": 50,
    "previous_page_url": null,
    "next_page_url": null
  }
}

Get an Organization

Request

GET /organizations/<organization_id>

Response

200 OK

{
  "data": {
    "id": "eb0600c0-c1f6-444c-9764-5c90d3dbb878",
    "name": "Organization 9",
    "website_url": "http://www.example.com/",
    "webhook_url": "https://example.com/webhook.asp",
    "contact_email": "hello9@example.com",
    "legal_contact_email": "legal9@example.com",
    "technical_contact_email": "person9@example.com",
    "zip_or_postal_code": "55437",
    "organization_type": "Dynamic Markets Engineering",
    "bio": "Function-based eco-centric standardization gurus",
    "twitter_url": "https://twitter.com/example",
    "vanity_slug": "organization-9",
    "facebook_url": "https://www.facebook.com/example",
    "linked_in_url": "https://www.linkedin.com/example",
    "linked_in_name": null,
    "linked_in_org_id": null,
    "city": "Bloomington",
    "address": "1313 Mockingbird Lane",
    "primary_hex_color": null,
    "support_email": "someEmail@example.com",
    "support_url": "https://example.com",
    "allow_saml_debug": false,
    "allowed_webhooks": [],
    "enable_blockchain": false,
    "print_method": null,
    "pdf_id": null,
    "internationalize_badge_templates": false,
    "integrated_with_faethm": false,
    "hide_subscription": false,
    "default_page": "badges",
    "industry_id": null,
    "workforce_enabled": false,
    "linkedin_a2p_url": null,
    "location": "1313 Mockingbird Lane Bloomington Minnesota 55437 United States",
    "country": "United States",
    "state_or_province": "Minnesota",
    "created_at": "2014-04-01T14:41:00.000Z",
    "updated_at": "2014-04-01T14:41:00.000Z",
    "vanity_url": "https://www.credly.com/org/organization-9",
    "verified_at": "2017-07-18T20:29:51.714Z",
    "verified": true,
    "require_template_detail_attributes": false,
    "photo": {
      "id": "2c868f86-c6d9-497c-ae96-a8c5419cc9c1",
      "url": "/system/test/images/2c868f86-c6d9-497c-ae96-a8c5419cc9c1/large_fake-600x600.png"
    },
    "photo_url": "https://cdn.example.com/path/to/image.png",
    "has_employees": false,
    "missing_required_info": false,
    "featured_badge_templates": [

    ]
  },
  "metadata": {
  }
}

Update an Organization

To change the organization image, provide a publicly accessible URL to the new image.

Request

PUT /organizations/<organization_id>

Request Body

{
  "name": "Example Organization",
  "website_url": "https://www.example.com",
  "webhook_url": "https://example.com/webhook_endpoint",
  "location": "East Junius, Ohio",
  "zip_or_postal_code": "55437",
  "contact_email": "info@example.com",
  "legal_contact_email": "legal@example.com",
  "organization_type": "Auto Parts Reseller",
  "bio": "Since 1994",
  "twitter_url": "https://twitter.com/example",
  "facebook_url": "https://www.facebook.com/example",
  "photo": "https://cdn.example.com/path/to/image.png",
  "city": "Bloomington",
  "state_or_province": "Minnesota",
  "country": "United States",
  "address": "1313 Mockingbird Lane",
  "hide_subscription": false
}

Response

200 OK

{
  "data": {
    "id": "89fbdc61-19c5-48e4-90c3-d14ab54dc3e5",
    "name": "Example Organization",
    "website_url": "https://www.example.com",
    "webhook_url": "https://example.com/webhook_endpoint",
    "contact_email": "info@example.com",
    "legal_contact_email": "legal@example.com",
    "technical_contact_email": "person16@example.com",
    "zip_or_postal_code": "55437",
    "organization_type": "Auto Parts Reseller",
    "bio": "Since 1994",
    "twitter_url": "https://twitter.com/example",
    "vanity_slug": "organization-16",
    "facebook_url": "https://www.facebook.com/example",
    "linked_in_url": "https://www.linkedin.com/example",
    "linked_in_name": null,
    "linked_in_org_id": null,
    "city": "Bloomington",
    "address": "1313 Mockingbird Lane",
    "primary_hex_color": null,
    "support_email": "someEmail@example.com",
    "support_url": "https://example.com",
    "allow_saml_debug": false,
    "allowed_webhooks": [],
    "enable_blockchain": false,
    "print_method": null,
    "pdf_id": null,
    "internationalize_badge_templates": false,
    "integrated_with_faethm": false,
    "hide_subscription": false,
    "default_page": "badges",
    "industry_id": null,
    "workforce_enabled": false,
    "linkedin_a2p_url": null,
    "location": "1313 Mockingbird Lane Bloomington Minnesota 55437 United States",
    "country": "United States",
    "state_or_province": "Minnesota",
    "created_at": "2014-04-01T14:41:00.000Z",
    "updated_at": "2014-04-01T14:41:00.000Z",
    "vanity_url": "https://www.credly.com/org/organization-16",
    "verified_at": "2018-04-08T17:57:34.595Z",
    "verified": true,
    "require_template_detail_attributes": false,
    "photo": {
      "id": "d9d863e9-e87b-4cc0-ade4-474b8313853f",
      "url": "/system/test/images/d9d863e9-e87b-4cc0-ade4-474b8313853f/large_fake-600x600.png"
    },
    "photo_url": "https://cdn.example.com/path/to/image.png",
    "has_employees": false,
    "missing_required_info": false,
    "featured_badge_templates": [

    ]
  },
  "metadata": {
  }
}

List an Organization's Authorization Tokens

Request

GET /organizations/<organization_id>/authorization_tokens

Response

200 OK

{
  "data": [
    {
      "id": "6dac84e3-7283-41f8-9acb-2b2af277df00",
      "token": "XXwJArBw8J6aJezzluJSzCn_UFzg1DayuwlJ",
      "owner_id": "d209cec5-7b8d-45b2-8474-b01d977801df",
      "description": null,
      "write_enabled": true,
      "read_enabled": true,
      "delete_enabled": true,
      "created_at": "2014-04-01T14:41:00.000Z",
      "expires_at": null,
      "owner": {
        "type": "Organization",
        "id": "d209cec5-7b8d-45b2-8474-b01d977801df",
        "name": "Organization 1340",
        "url": "https://api.credly.com/v1/organizations/d209cec5-7b8d-45b2-8474-b01d977801df"
      }
    }
  ],
  "metadata": {
    "count": 1,
    "current_page": 1,
    "total_count": 1,
    "total_pages": 1,
    "per": 50,
    "previous_page_url": null,
    "next_page_url": null
  }
}