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",
"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",
"allowed_webhooks": [],
"enable_blockchain": false,
"print_method": null,
"pdf_id": null,
"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://localhost/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",
"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",
"allowed_webhooks": [],
"enable_blockchain": false,
"print_method": null,
"pdf_id": null,
"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://localhost/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",
"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",
"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",
"allowed_webhooks": [],
"enable_blockchain": false,
"print_method": null,
"pdf_id": null,
"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://localhost/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": "e2bcb651-563c-4ad9-a3f2-0c36ff61c1f1",
"event_type": "badge.created",
"organization_id": "bc39eefb-c33e-4605-a702-424d188068b1",
"occurred_at": "2014-04-01T14:41:00.000Z",
"badge": {
"user": {
"id": "ff929af1-f6aa-43e8-a128-602b04379d80",
"email": "ff929af1-f6aa-43e8-a128-602b04379d80@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.youracclaim.com/users/alfred-beaker-skiles"
},
"created_by": {
"type": "Organization",
"id": "8b4818a2-e41e-4bc9-9365-ed98783ddcf7",
"name": "Organization 9",
"url": "https://api.youracclaim.com/v1/organizations/8b4818a2-e41e-4bc9-9365-ed98783ddcf7",
"vanity_url": "https://www.youracclaim.com/org/organization-9",
"share_to_ziprecruiter": false,
"verified": true
},
"issuer": {
"summary": "issued by Organization 9",
"entities": [
{
"label": "Issued by",
"primary": true,
"entity": {
"type": "Organization",
"id": "8b4818a2-e41e-4bc9-9365-ed98783ddcf7",
"name": "Organization 9",
"url": "https://api.youracclaim.com/v1/organizations/8b4818a2-e41e-4bc9-9365-ed98783ddcf7",
"vanity_url": "https://www.youracclaim.com/org/organization-9",
"share_to_ziprecruiter": false,
"verified": true
}
}
]
},
"printing_enabled": false,
"print_method": null,
"badge_template": {
"id": "da0cc71c-4d9f-4c3c-8aaa-c348f4fe5a82",
"allow_duplicate_badges": true,
"cost": null,
"description": "Dynamically deliver go forward e-tailers",
"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,
"type_category": null,
"printing_disabled": false,
"visibility": "public",
"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,
"image": {
"id": "947b76a0-1859-412c-bdb0-ddf78547b376",
"url": "/system/test/images/947b76a0-1859-412c-bdb0-ddf78547b376/fake-352x352.png"
},
"image_url": "https://cdn.example.com/path/to/image.png",
"url": "https://localhost/org/organization-9/badge/badge-template-1",
"owner": {
"type": "Organization",
"id": "8b4818a2-e41e-4bc9-9365-ed98783ddcf7",
"name": "Organization 9",
"enable_blockchain": false,
"url": "https://api.youracclaim.com/v1/organizations/8b4818a2-e41e-4bc9-9365-ed98783ddcf7",
"vanity_url": "https://localhost/org/organization-9",
"vanity_slug": "organization-9",
"verified": true,
"viewable": true
},
"alignments": [
{
"id": "c9efa2ff-530b-4b64-8236-f8c0ba200fd9",
"name": "Alignment 1",
"url": "http://www.example.com/alignment",
"description": "Self-enabling cohesive task-force"
}
],
"recommendations": [
{
"id": "b36f8baa-37f4-4448-b1a0-d8a54fb88981",
"title": "Recommendation Title",
"type": "information",
"activity_url": "http://www.example.com/recommendation"
}
],
"required_badge_templates": [
],
"badge_template_activities": [
{
"id": "fad6de5e-ea4a-4363-b73d-3d11889d8a93",
"title": "Kickboxing Activity",
"activity_type": "Schedule / Registration",
"activity_url": "http://www.example.com/awesomepage",
"required_badge_template_id": null
}
],
"skills": [
"Skill 1"
]
},
"id": "d479243d-d094-4e80-a40f-3dc6fe17ada1",
"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",
"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": "2017-09-18T12:51:56.653Z",
"image": {
"id": "947b76a0-1859-412c-bdb0-ddf78547b376",
"url": "/system/test/images/947b76a0-1859-412c-bdb0-ddf78547b376/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": "5105121e-afbc-47bf-a349-3d717db9889a",
"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/d479243d-d094-4e80-a40f-3dc6fe17ada1"
}
},
"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": "878dcffd-78c8-4ee3-8923-3a4c98d3adb3",
"event_type": "badge.created",
"organization_id": "e668c0d5-8c61-415a-9bfd-640914d070e1",
"occurred_at": "2014-04-01T14:41:00.000Z",
"badge": {
"user": {
"id": "bb7b3dce-b080-4df2-a1d0-c9afe4cacca7",
"email": "bb7b3dce-b080-4df2-a1d0-c9afe4cacca7@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.youracclaim.com/users/alfred-beaker-skiles"
},
"created_by": {
"type": "Organization",
"id": "658a99d9-d63c-4b27-91d6-898ec070068d",
"name": "Organization 12",
"url": "https://api.youracclaim.com/v1/organizations/658a99d9-d63c-4b27-91d6-898ec070068d",
"vanity_url": "https://www.youracclaim.com/org/organization-12",
"share_to_ziprecruiter": false,
"verified": true
},
"issuer": {
"summary": "issued by Organization 12",
"entities": [
{
"label": "Issued by",
"primary": true,
"entity": {
"type": "Organization",
"id": "658a99d9-d63c-4b27-91d6-898ec070068d",
"name": "Organization 12",
"url": "https://api.youracclaim.com/v1/organizations/658a99d9-d63c-4b27-91d6-898ec070068d",
"vanity_url": "https://www.youracclaim.com/org/organization-12",
"share_to_ziprecruiter": false,
"verified": true
}
}
]
},
"printing_enabled": false,
"print_method": null,
"badge_template": {
"id": "f9037114-8f81-4b23-9a38-d3d27bc14973",
"allow_duplicate_badges": true,
"cost": null,
"description": "Dynamically deliver go forward e-tailers",
"global_activity_url": "https://www.example.com/foo",
"level": null,
"lock_badge_state": false,
"name": "Badge Template 2",
"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-2",
"record_to_blockchain": null,
"time_to_earn": null,
"type_category": null,
"printing_disabled": false,
"visibility": "public",
"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,
"image": {
"id": "15dfae2e-28cb-4b4a-afc5-58c96230f6af",
"url": "/system/test/images/15dfae2e-28cb-4b4a-afc5-58c96230f6af/fake-352x352.png"
},
"image_url": "https://cdn.example.com/path/to/image.png",
"url": "https://localhost/org/organization-12/badge/badge-template-2",
"owner": {
"type": "Organization",
"id": "658a99d9-d63c-4b27-91d6-898ec070068d",
"name": "Organization 12",
"enable_blockchain": false,
"url": "https://api.youracclaim.com/v1/organizations/658a99d9-d63c-4b27-91d6-898ec070068d",
"vanity_url": "https://localhost/org/organization-12",
"vanity_slug": "organization-12",
"verified": true,
"viewable": true
},
"alignments": [
{
"id": "f0dc491e-242e-4b9e-87cf-691305b71223",
"name": "Alignment 2",
"url": "http://www.example.com/alignment",
"description": "Self-enabling cohesive task-force"
}
],
"recommendations": [
{
"id": "e44c28c0-e9c2-4a9d-ae20-3e4f444ecb20",
"title": "Recommendation Title",
"type": "information",
"activity_url": "http://www.example.com/recommendation"
}
],
"required_badge_templates": [
],
"badge_template_activities": [
{
"id": "e34abce7-b5d7-4f5d-848b-7dc3ebb01141",
"title": "Kickboxing Activity",
"activity_type": "Schedule / Registration",
"activity_url": "http://www.example.com/awesomepage",
"required_badge_template_id": null
}
],
"skills": [
"Skill 2"
]
},
"id": "146fcf27-b648-4824-b397-0a3c97859e15",
"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": "user10002@example.com",
"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": "2017-09-18T12:51:56.653Z",
"image": {
"id": "15dfae2e-28cb-4b4a-afc5-58c96230f6af",
"url": "/system/test/images/15dfae2e-28cb-4b4a-afc5-58c96230f6af/fake-352x352.png"
},
"image_url": "https://cdn.example.com/path/to/image.png",
"alignments": [
{
"name": "Alignment 2",
"description": "Self-enabling cohesive task-force"
}
],
"evidence": [
{
"id": "c68ecc20-3652-4e01-b498-9a9e65000dcd",
"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/146fcf27-b648-4824-b397-0a3c97859e15"
}
}
],
"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.youracclaim.com/v1/organizations/d209cec5-7b8d-45b2-8474-b01d977801df"
}
}
],
"metadata": {
}
}