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_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,
      "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,
      "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"
    }
  ],
  "metadata": {
  }
}

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_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,
    "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,
    "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"
  },
  "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"
}

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_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,
    "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,
    "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"
  },
  "metadata": {
  }
}

Get an Event belonging to an Organization

Request

GET /organizations/<organization_id>/events/<event_id>

Response

200 OK

{
  "data": {
    "id": "2cdddcda-05d4-4669-b499-de7337395416",
    "event_type": "badge.created",
    "organization_id": "d3de47b1-4af8-4fdb-9c23-8c17a108db2c",
    "occurred_at": "2014-04-01T14:41:00.000Z",
    "badge": {
      "user": {
        "id": "5f57685b-fec7-4f71-b24b-a8207c782bad",
        "email": "5f57685b-fec7-4f71-b24b-a8207c782bad@example.com",
        "first_name": "Alfred",
        "middle_name": "Beaker",
        "last_name": "Skiles",
        "current_position_name": "*****",
        "current_organization_name": "*****",
        "confirmed": true,
        "photo": null,
        "photo_url": null,
        "url": "https://www.credly.com/users/alfred-beaker-skiles.8c12fc8b"
      },
      "created_by": {
        "type": "Organization",
        "id": "0f9249c6-a6fb-4649-bbca-2799bbd6cdf0",
        "name": "Organization 3",
        "url": "https://api.credly.com/v1/organizations/0f9249c6-a6fb-4649-bbca-2799bbd6cdf0",
        "vanity_url": "https://www.credly.com/org/organization-3",
        "internationalize_badge_templates": false,
        "share_to_ziprecruiter": true,
        "verified": true
      },
      "issuer": {
        "summary": "issued by Organization 3",
        "entities": [
          {
            "label": "Issued by",
            "primary": true,
            "entity": {
              "type": "Organization",
              "id": "0f9249c6-a6fb-4649-bbca-2799bbd6cdf0",
              "name": "Organization 3",
              "url": "https://api.credly.com/v1/organizations/0f9249c6-a6fb-4649-bbca-2799bbd6cdf0",
              "vanity_url": "https://www.credly.com/org/organization-3",
              "internationalize_badge_templates": false,
              "share_to_ziprecruiter": true,
              "verified": true
            }
          }
        ]
      },
      "printing_enabled": false,
      "print_method": null,
      "badge_template": {
        "primary_badge_template_id": null,
        "variant_name": null,
        "id": "c98fcbe4-0ee6-48bc-bc51-e4607a21b2d2",
        "allow_duplicate_badges": true,
        "cost": null,
        "description": "Dynamically deliver go forward e-tailers",
        "default_expires_at": null,
        "global_activity_url": "https://www.example.com/foo",
        "level": null,
        "lock_badge_state": false,
        "name": "Badge Template 1",
        "state": "active",
        "public": true,
        "badges_count": 0,
        "recipient_type": "User",
        "send_expiring_badge_notifications": false,
        "show_badge_lmi": false,
        "show_lmi_jobs": false,
        "show_skill_tag_links": true,
        "vanity_slug": "badge-template-1",
        "record_to_blockchain": null,
        "time_to_earn": null,
        "translatable": false,
        "type_category": null,
        "printing_disabled": false,
        "visibility": "public",
        "variants_allowed": false,
        "variant_type": null,
        "allow_delete": true,
        "allow_archive": false,
        "available_locales": [

        ],
        "only_one_skill_required": false,
        "criteria_url_name": null,
        "criteria_url": null,
        "certification": true,
        "state_updated_at": null,
        "created_at": "2014-04-01T14:41:00.000Z",
        "updated_at": "2014-04-01T14:41:00.000Z",
        "show_template_settings": false,
        "get_issue_count": 0,
        "get_variants_issue_count": 0,
        "image": {
          "id": "7f416352-7f4c-40ae-b3d8-bee17bad962c",
          "url": "/system/test/images/7f416352-7f4c-40ae-b3d8-bee17bad962c/fake-600x600.png"
        },
        "image_url": "https://cdn.example.com/path/to/image.png",
        "url": "https://www.credly.com/org/organization-3/badge/badge-template-1",
        "owner": {
          "type": "Organization",
          "id": "0f9249c6-a6fb-4649-bbca-2799bbd6cdf0",
          "name": "Organization 3",
          "enable_blockchain": false,
          "url": "https://api.credly.com/v1/organizations/0f9249c6-a6fb-4649-bbca-2799bbd6cdf0",
          "vanity_url": "https://www.credly.com/org/organization-3",
          "vanity_slug": "organization-3",
          "verified": true,
          "viewable": true
        },
        "alignments": [
          {
            "id": "0bb299f3-0b8b-4dd4-85a0-dbb210719cad",
            "name": "Alignment 2",
            "url": "http://www.example.com/alignment",
            "description": "Self-enabling cohesive task-force"
          }
        ],
        "recommendations": [
          {
            "id": "840ff3a5-5af3-4e32-a4ae-bdfc09fdbff2",
            "title": "Recommendation Title",
            "type": "information",
            "activity_url": "http://www.example.com/recommendation"
          }
        ],
        "required_badge_templates": [

        ],
        "badge_template_activities": [
          {
            "id": "0f232b88-9688-4994-9e43-ccabdd445f61",
            "title": "Kickboxing Activity",
            "activity_type": "Schedule / Registration",
            "activity_url": "http://www.example.com/awesomepage",
            "required_badge_template_id": null
          }
        ],
        "skills": [
          "Skill 1",
          "Skill 2",
          "Skill 3"
        ]
      },
      "id": "134fa33b-e628-4da2-ac0e-a6f5ccfb83d1",
      "issued_to": "Alfred Beaker Skiles",
      "issued_to_first_name": "Alfred",
      "issued_to_middle_name": "Beaker",
      "issued_to_last_name": "Skiles",
      "issuer_earner_id": null,
      "locale": "en",
      "public": true,
      "recipient_email": "user10001@example.com",
      "translate_metadata": false,
      "replacement_badge_id": null,
      "replaces_badge_id": null,
      "revocation_reason": null,
      "state": "accepted",
      "suppress_badge_notification_email": false,
      "updated_at": "2014-04-01T14:41:00.000Z",
      "country": "United States",
      "country_code": "USA",
      "state_or_province": "Minnesota",
      "created_at": "2014-04-01T14:41:00.000Z",
      "expires_at": "2016-04-01T14:41:00.000Z",
      "expires_at_date": "2016-04-01",
      "issued_at": "2014-04-01T14:41:00.000Z",
      "issued_at_date": "2014-04-01",
      "state_updated_at": "2014-04-01T14:41:00.000Z",
      "is_private_badge": false,
      "image": {
        "id": "7f416352-7f4c-40ae-b3d8-bee17bad962c",
        "url": "/system/test/images/7f416352-7f4c-40ae-b3d8-bee17bad962c/fake-600x600.png"
      },
      "image_url": "https://cdn.example.com/path/to/image.png",
      "alignments": [
        {
          "name": "Alignment 2",
          "description": "Self-enabling cohesive task-force"
        }
      ],
      "evidence": [
        {
          "id": "e6a8a9b6-defe-47de-844c-380a936d42f1",
          "type": "UrlEvidence",
          "name": "Acclaim",
          "description": "Description in URL evidence is optional",
          "value": "http://www.example.com/path-to-earner-specific-evidence"
        }
      ],
      "badge_url": "https://www.credly.com/badges/134fa33b-e628-4da2-ac0e-a6f5ccfb83d1"
    }
  },
  "metadata": {
  }
}

List all Events belonging to an Organization

Request

GET /organizations/<organization_id>/events[?page=<page_number>]

Paging

At most 50 results are returned at a time. Include an optional page parameter to fetch the next page of results.

Response

200 OK

  {
  "data": [
    {
      "id": "476f3bb2-8062-4458-a2b4-902a8ff806ef",
      "event_type": "badge.created",
      "organization_id": "964c51c2-f85d-4956-9380-287bfc6d395e",
      "occurred_at": "2014-04-01T14:41:00.000Z",
      "badge": {
        "user": {
          "id": "f79f51aa-9844-4afc-ab0c-c4e4ccba263a",
          "email": "f79f51aa-9844-4afc-ab0c-c4e4ccba263a@example.com",
          "first_name": "Alfred",
          "middle_name": "Beaker",
          "last_name": "Skiles",
          "current_position_name": "*****",
          "current_organization_name": "*****",
          "confirmed": true,
          "photo": null,
          "photo_url": null,
          "url": "https://www.credly.com/users/alfred-beaker-skiles.56781389"
        },
        "created_by": {
          "type": "Organization",
          "id": "6e667f8c-288e-42a3-b39a-94297ed3e536",
          "name": "Organization 5",
          "url": "https://api.credly.com/v1/organizations/6e667f8c-288e-42a3-b39a-94297ed3e536",
          "vanity_url": "https://www.credly.com/org/organization-5",
          "internationalize_badge_templates": false,
          "share_to_ziprecruiter": true,
          "verified": true
        },
        "issuer": {
          "summary": "issued by Organization 5",
          "entities": [
            {
              "label": "Issued by",
              "primary": true,
              "entity": {
                "type": "Organization",
                "id": "6e667f8c-288e-42a3-b39a-94297ed3e536",
                "name": "Organization 5",
                "url": "https://api.credly.com/v1/organizations/6e667f8c-288e-42a3-b39a-94297ed3e536",
                "vanity_url": "https://www.credly.com/org/organization-5",
                "internationalize_badge_templates": false,
                "share_to_ziprecruiter": true,
                "verified": true
              }
            }
          ]
        },
        "printing_enabled": false,
        "print_method": null,
        "badge_template": {
          "primary_badge_template_id": null,
          "variant_name": null,
          "id": "96a5b3d0-1a8d-483f-ac5a-100d0283830f",
          "allow_duplicate_badges": true,
          "cost": null,
          "description": "Dynamically deliver go forward e-tailers",
          "default_expires_at": null,
          "global_activity_url": "https://www.example.com/foo",
          "level": null,
          "lock_badge_state": false,
          "name": "Badge Template 1",
          "state": "active",
          "public": true,
          "badges_count": 0,
          "recipient_type": "User",
          "send_expiring_badge_notifications": false,
          "show_badge_lmi": false,
          "show_lmi_jobs": false,
          "show_skill_tag_links": true,
          "vanity_slug": "badge-template-1",
          "record_to_blockchain": null,
          "time_to_earn": null,
          "translatable": false,
          "type_category": null,
          "printing_disabled": false,
          "visibility": "public",
          "variants_allowed": false,
          "variant_type": null,
          "allow_delete": true,
          "allow_archive": false,
          "available_locales": [

          ],
          "only_one_skill_required": false,
          "criteria_url_name": null,
          "criteria_url": null,
          "certification": true,
          "state_updated_at": null,
          "created_at": "2014-04-01T14:41:00.000Z",
          "updated_at": "2014-04-01T14:41:00.000Z",
          "show_template_settings": false,
          "get_issue_count": 0,
          "get_variants_issue_count": 0,
          "image": {
            "id": "be5b9cbc-e84a-46e6-94ad-c50d77ee0a2b",
            "url": "/system/test/images/be5b9cbc-e84a-46e6-94ad-c50d77ee0a2b/fake-600x600.png"
          },
          "image_url": "https://cdn.example.com/path/to/image.png",
          "url": "https://www.credly.com/org/organization-5/badge/badge-template-1",
          "owner": {
            "type": "Organization",
            "id": "6e667f8c-288e-42a3-b39a-94297ed3e536",
            "name": "Organization 5",
            "enable_blockchain": false,
            "url": "https://api.credly.com/v1/organizations/6e667f8c-288e-42a3-b39a-94297ed3e536",
            "vanity_url": "https://www.credly.com/org/organization-5",
            "vanity_slug": "organization-5",
            "verified": true,
            "viewable": true
          },
          "alignments": [
            {
              "id": "67e03a83-898c-43f6-9ef7-b0bd1b3ae9df",
              "name": "Alignment 2",
              "url": "http://www.example.com/alignment",
              "description": "Self-enabling cohesive task-force"
            }
          ],
          "recommendations": [
            {
              "id": "108d0947-a300-450a-9289-819ae6d51b40",
              "title": "Recommendation Title",
              "type": "information",
              "activity_url": "http://www.example.com/recommendation"
            }
          ],
          "required_badge_templates": [

          ],
          "badge_template_activities": [
            {
              "id": "7f00d54a-fe60-4e2f-af21-7bcfaa3fc1fc",
              "title": "Kickboxing Activity",
              "activity_type": "Schedule / Registration",
              "activity_url": "http://www.example.com/awesomepage",
              "required_badge_template_id": null
            }
          ],
          "skills": [
            "Skill 1",
            "Skill 2",
            "Skill 3"
          ]
        },
        "id": "f5068ac6-6e5a-499b-9051-66fb575222c1",
        "issued_to": "Alfred Beaker Skiles",
        "issued_to_first_name": "Alfred",
        "issued_to_middle_name": "Beaker",
        "issued_to_last_name": "Skiles",
        "issuer_earner_id": null,
        "locale": "en",
        "public": true,
        "recipient_email": "user10001@example.com",
        "translate_metadata": false,
        "replacement_badge_id": null,
        "replaces_badge_id": null,
        "revocation_reason": null,
        "state": "accepted",
        "suppress_badge_notification_email": false,
        "updated_at": "2014-04-01T14:41:00.000Z",
        "country": "United States",
        "country_code": "USA",
        "state_or_province": "Minnesota",
        "created_at": "2014-04-01T14:41:00.000Z",
        "expires_at": "2016-04-01T14:41:00.000Z",
        "expires_at_date": "2016-04-01",
        "issued_at": "2014-04-01T14:41:00.000Z",
        "issued_at_date": "2014-04-01",
        "state_updated_at": "2014-04-01T14:41:00.000Z",
        "is_private_badge": false,
        "image": {
          "id": "be5b9cbc-e84a-46e6-94ad-c50d77ee0a2b",
          "url": "/system/test/images/be5b9cbc-e84a-46e6-94ad-c50d77ee0a2b/fake-600x600.png"
        },
        "image_url": "https://cdn.example.com/path/to/image.png",
        "alignments": [
          {
            "name": "Alignment 2",
            "description": "Self-enabling cohesive task-force"
          }
        ],
        "evidence": [
          {
            "id": "3f187a6d-a0a3-4fb6-8cbe-8f62777088ce",
            "type": "UrlEvidence",
            "name": "Acclaim",
            "description": "Description in URL evidence is optional",
            "value": "http://www.example.com/path-to-earner-specific-evidence"
          }
        ],
        "badge_url": "https://www.credly.com/badges/f5068ac6-6e5a-499b-9051-66fb575222c1"
      }
    }
  ],
  "metadata": {
    "count": 1,
    "current_page": 1,
    "total_count": 1,
    "total_pages": 1,
    "per": 50,
    "previous_page_url": null,
    "next_page_url": null
  }
}

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",
      "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
  }
}