Skip to content

Organizations

List Organizations

Request

GET /organizations

Response

200 OK

{
  "data": [
    {
      "id": "3e37667e-4a36-4244-b047-c456459ac4a8",
      "name": "Organization 1425",
      "website_url": "http://www.example.com/",
      "webhook_url": "https://example.com/webhook.asp",
      "contact_email": "hello1422@example.com",
      "technical_contact_email": "person1421@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-1425",
      "facebook_url": "https://www.facebook.com/example",
      "linked_in_url": "https://www.linkedin.com/example",
      "city": "Bloomington",
      "address": "1313 Mockingbird Lane",
      "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.youracclaim.com/org/organization-1425",
      "verified_at": "2014-06-20T20:50:32.890Z",
      "verified": true,
      "photo": {
        "id": "7c5e4b37-12ea-425c-b376-d26ef6676b25",
        "url": "https://cdn.example.com/path/to/image.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": "04652681-ad8d-4bee-beac-e9e9b36ec646",
    "name": "Organization 1423",
    "website_url": "http://www.example.com/",
    "webhook_url": "https://example.com/webhook.asp",
    "contact_email": "hello1420@example.com",
    "technical_contact_email": "person1419@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-1423",
    "facebook_url": "https://www.facebook.com/example",
    "linked_in_url": "https://www.linkedin.com/example",
    "city": "Bloomington",
    "address": "1313 Mockingbird Lane",
    "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.youracclaim.com/org/organization-1423",
    "verified_at": "2014-06-20T20:50:32.890Z",
    "verified": true,
    "photo": {
      "id": "7c5e4b37-12ea-425c-b376-d26ef6676b25",
      "url": "https://cdn.example.com/path/to/image.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",
  "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": "43bf5c24-6d82-4f9e-a80f-00eae652508d",
    "name": "Example Organization",
    "website_url": "https://www.example.com",
    "webhook_url": "https://example.com/webhook_endpoint",
    "contact_email": "info@example.com",
    "technical_contact_email": "person1432@example.com",
    "zip_or_postal_code": "55437",
    "organization_type": "Auto Parts Reseller",
    "bio": "Since 1994",
    "twitter_url": "https://twitter.com/example",
    "vanity_slug": "organization-1436",
    "facebook_url": "https://www.facebook.com/example",
    "linked_in_url": "https://www.linkedin.com/example",
    "city": "Bloomington",
    "address": "1313 Mockingbird Lane",
    "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.youracclaim.com/org/organization-1436",
    "verified_at": "2014-06-20T20:50:32.890Z",
    "verified": true,
    "photo": {
      "id": "7c5e4b37-12ea-425c-b376-d26ef6676b25",
      "url": "https://cdn.example.com/path/to/image.png"
    },
    "photo_url": "https://cdn.example.com/path/to/image.png"
  },
  "metadata": {
  }
}

Invitations

Get an Event belonging to an Organization

Request

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

Response

200 OK

{
  "data": {
    "id": "67a0d44a-a264-4bb0-967a-e176a6fff21e",
    "event_type": "badge.created",
    "organization_id": "f54bb4ae-7e68-4f15-81e9-72260084fa1c",
    "occurred_at": "2014-04-01T14:41:00.000Z",
    "badge": {
      "user": {
        "id": "46077420-c60c-4f6a-9817-d734dcbdc71a",
        "email": "46077420-c60c-4f6a-9817-d734dcbdc71a@example.com",
        "first_name": "Alfred",
        "last_name": "Skiles",
        "current_position_name": "*****",
        "current_organization_name": "*****",
        "confirmed": true,
        "photo": null,
        "photo_url": null,
        "url": "https://localhost/user/alfred-skiles.6efef6ed"
      },
      "issuer": {
        "type": "Organization",
        "id": "c26593fd-9f0c-48eb-a54b-d1d919827f01",
        "name": "Organization 2",
        "url": "https://api.youracclaim.com/v1/organizations/c26593fd-9f0c-48eb-a54b-d1d919827f01",
        "vanity_url": "https://localhost/org/organization-2",
        "verified": true
      },
      "badge_template": {
        "id": "5a379c08-3213-4ede-956f-1fc62b52b7b0",
        "description": "Dynamically deliver go forward e-tailers",
        "global_activity_url": "https://www.example.com/foo",
        "name": "Badge Template 1",
        "state": "active",
        "public": true,
        "badges_count": 0,
        "recipient_type": "User",
        "show_badge_lmi": false,
        "show_lmi_jobs": false,
        "show_skill_tag_links": true,
        "vanity_slug": "badge-template-1",
        "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",
        "template_type": "skill",
        "show_template_settings": false,
        "get_issue_count": 0,
        "image": {
          "id": "a8c904c1-1450-4e9e-a24b-42c5ebc412a3",
          "url": "/system/test/images/a8c904c1-1450-4e9e-a24b-42c5ebc412a3/fake-352x352.png"
        },
        "image_url": "https://cdn.example.com/path/to/image.png",
        "url": "https://localhost/org/organization-2/badge/badge-template-1",
        "owner": {
          "type": "Organization",
          "id": "c26593fd-9f0c-48eb-a54b-d1d919827f01",
          "name": "Organization 2",
          "url": "https://api.youracclaim.com/v1/organizations/c26593fd-9f0c-48eb-a54b-d1d919827f01",
          "vanity_url": "https://localhost/org/organization-2",
          "vanity_slug": "organization-2",
          "verified": true
        },
        "alignments": [
          {
            "id": "bac8a53f-7b09-4b7d-b1ee-326f4abf35b3",
            "name": "Alignment 1",
            "url": "http://www.example.com/alignment",
            "description": "Self-enabling cohesive task-force"
          }
        ],
        "recommendations": [
          {
            "id": "c37e7118-19a0-4b05-81b7-879f33a5d61b",
            "title": "Go to this URL immediately!",
            "type": "url",
            "activity_url": "http://www.example.com/recommendation"
          }
        ],
        "required_badge_templates": [

        ],
        "badge_template_activities": [
          {
            "id": "44f323ad-96f0-4cc2-94d8-f1c21328e4ee",
            "title": "Kickboxing Activity",
            "activity_type": "Schedule / Registration",
            "activity_url": "http://www.example.com/awesomepage",
            "required_badge_template_id": null
          }
        ],
        "skills": [
          "Skill 1"
        ]
      },
      "id": "a7134609-cf94-48cf-b28d-ded4e9509a5a",
      "issued_to": "Alfred Skiles",
      "issued_to_first_name": "Alfred",
      "issued_to_last_name": "Skiles",
      "issuer_earner_id": null,
      "locale": "en",
      "public": true,
      "recipient_email": "user1@example.com",
      "replacement_badge_id": null,
      "revocation_reason": null,
      "state": "accepted",
      "suppress_badge_notification_email": false,
      "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": "2017-02-08T21:32:47.770Z",
      "image": {
        "id": "a8c904c1-1450-4e9e-a24b-42c5ebc412a3",
        "url": "/system/test/images/a8c904c1-1450-4e9e-a24b-42c5ebc412a3/fake-352x352.png"
      },
      "image_url": "https://cdn.example.com/path/to/image.png",
      "alignments": [
        {
          "name": "Alignment 1",
          "description": "Self-enabling cohesive task-force"
        }
      ],
      "evidence": [
        {
          "id": "b7d67b83-4475-4d41-a88b-ea41312070f9",
          "type": "UrlEvidence",
          "name": "Acclaim",
          "description": "Description in URL evidence is optional",
          "value": "http://www.example.com/path-to-earner-specific-evidence"
        }
      ],
      "badge_url": "https://localhost/badges/a7134609-cf94-48cf-b28d-ded4e9509a5a"
    }
  },
  "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": "267c5321-cc9a-4735-8d56-67e399481629",
      "event_type": "badge.created",
      "organization_id": "7e1678bb-0832-4287-a2ee-c84e1e1d79a5",
      "occurred_at": "2014-04-01T14:41:00.000Z",
      "badge": {
        "user": {
          "id": "be75a3f0-5e02-44fd-ba45-932b5b581bb1",
          "email": "be75a3f0-5e02-44fd-ba45-932b5b581bb1@example.com",
          "first_name": "Alfred",
          "last_name": "Skiles",
          "current_position_name": "*****",
          "current_organization_name": "*****",
          "confirmed": true,
          "photo": null,
          "photo_url": null,
          "url": "https://localhost/user/alfred-skiles.2e5d0ab4"
        },
        "issuer": {
          "type": "Organization",
          "id": "dae1a849-498a-4c0f-aca1-3811079b6c04",
          "name": "Organization 2",
          "url": "https://api.youracclaim.com/v1/organizations/dae1a849-498a-4c0f-aca1-3811079b6c04",
          "vanity_url": "https://localhost/org/organization-2",
          "verified": true
        },
        "badge_template": {
          "id": "d6264b86-2902-42aa-941e-3f9c1b2bde17",
          "description": "Dynamically deliver go forward e-tailers",
          "global_activity_url": "https://www.example.com/foo",
          "name": "Badge Template 1",
          "state": "active",
          "public": true,
          "badges_count": 0,
          "recipient_type": "User",
          "show_badge_lmi": false,
          "show_lmi_jobs": false,
          "show_skill_tag_links": true,
          "vanity_slug": "badge-template-1",
          "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",
          "template_type": "skill",
          "show_template_settings": false,
          "get_issue_count": 0,
          "image": {
            "id": "ee5c4858-785e-4cbe-bb8b-4ffc10325e8a",
            "url": "/system/test/images/ee5c4858-785e-4cbe-bb8b-4ffc10325e8a/fake-352x352.png"
          },
          "image_url": "https://cdn.example.com/path/to/image.png",
          "url": "https://localhost/org/organization-2/badge/badge-template-1",
          "owner": {
            "type": "Organization",
            "id": "dae1a849-498a-4c0f-aca1-3811079b6c04",
            "name": "Organization 2",
            "url": "https://api.youracclaim.com/v1/organizations/dae1a849-498a-4c0f-aca1-3811079b6c04",
            "vanity_url": "https://localhost/org/organization-2",
            "vanity_slug": "organization-2",
            "verified": true
          },
          "alignments": [
            {
              "id": "85b9a9c2-9bbb-43c3-a06a-273a5884afb9",
              "name": "Alignment 1",
              "url": "http://www.example.com/alignment",
              "description": "Self-enabling cohesive task-force"
            }
          ],
          "recommendations": [
            {
              "id": "86e3b6ba-565a-4400-b07e-1c84f9c5bcc3",
              "title": "Go to this URL immediately!",
              "type": "url",
              "activity_url": "http://www.example.com/recommendation"
            }
          ],
          "required_badge_templates": [

          ],
          "badge_template_activities": [
            {
              "id": "eed24822-d266-44c8-b62a-7626a93641a4",
              "title": "Kickboxing Activity",
              "activity_type": "Schedule / Registration",
              "activity_url": "http://www.example.com/awesomepage",
              "required_badge_template_id": null
            }
          ],
          "skills": [
            "Skill 1"
          ]
        },
        "id": "4346bec6-3e66-4dd1-8266-e757ff88f4c0",
        "issued_to": "Alfred Skiles",
        "issued_to_first_name": "Alfred",
        "issued_to_last_name": "Skiles",
        "issuer_earner_id": null,
        "locale": "en",
        "public": true,
        "recipient_email": "user1@example.com",
        "replacement_badge_id": null,
        "revocation_reason": null,
        "state": "accepted",
        "suppress_badge_notification_email": false,
        "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": "2017-02-08T21:24:19.668Z",
        "image": {
          "id": "ee5c4858-785e-4cbe-bb8b-4ffc10325e8a",
          "url": "/system/test/images/ee5c4858-785e-4cbe-bb8b-4ffc10325e8a/fake-352x352.png"
        },
        "image_url": "https://cdn.example.com/path/to/image.png",
        "alignments": [
          {
            "name": "Alignment 1",
            "description": "Self-enabling cohesive task-force"
          }
        ],
        "evidence": [
          {
            "id": "43a9b65e-cf6b-4acd-b499-3c9174e9a515",
            "type": "UrlEvidence",
            "name": "Acclaim",
            "description": "Description in URL evidence is optional",
            "value": "http://www.example.com/path-to-earner-specific-evidence"
          }
        ],
        "badge_url": "https://localhost/badges/4346bec6-3e66-4dd1-8266-e757ff88f4c0"
      }
    }
  ],
  "metadata": {
    "count": 1,
    "current_page": 1,
    "total_count": 1,
    "total_pages": 1,
    "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_UFzg1DayuwlJS2Bs",
      "owner_id": "d209cec5-7b8d-45b2-8474-b01d977801df",
      "created_at": "2014-04-01T14:41:00.000Z",
      "owner": {
        "type": "Organization",
        "id": "d209cec5-7b8d-45b2-8474-b01d977801df",
        "name": "Organization 1340",
        "url": "https://api.youracclaim.com/v1/organizations/d209cec5-7b8d-45b2-8474-b01d977801df"
      }
    }
  ],
  "metadata": {
  }
}