SafetyCulture
Last updated:

Get entity IDs for integrations and deep links

Learn how to get the unique identifiers of different entities in the SafetyCulture platform for integrations and deep links.

What can I use entity IDs for?

To seamlessly integrate with SafetyCulture, obtaining entity IDs for specific documents or profiles may sometimes be required. While our API documentation outlines the process of acquiring these entity IDs through API requests, we recognize that not everyone tasked with building integrations may be comfortable with such technical methods. To make things easier, you can get the IDs for various entities, such as templates and inspections, via the web app.

What you'll need

Depending on the entity ID you are trying to get, you may need document access, organization permissions, or certain seat types to proceed.

Get a template ID

  1. Log in to the web app.

  2. Select Templates from the menu on the left-hand side.

  3. Click the template and select Manage access in the side panel.

  4. Copy the template ID from the URL, which should resemble the following example: https://app.safetyculture.com/template-editor/template_ec6d885b07944d00b5d1e224bf0573c1 Get a template ID via the web app.

Get a question item ID

  1. Log in to the web app.

  2. Select Templates from the menu on the left-hand side.

  3. Click the template and select Edit template in the side panel.

  4. Update the page's URL to "https://app.safetyculture.com/api/v2/templates/template_id" with the template ID.

    • For example, if the current URL is "https://app.safetyculture.com/template-editor/template_645dac7031d54418942d68842ac28f74/build", then update it to "https://app.safetyculture.com/api/v2/templates/template_645dac7031d54418942d68842ac28f74". Ensure the URL doesn't end with a backslash (/).

  5. This should show the raw template data. Most web browsers should support a "Pretty print" option that allows you to view each question more easily.

  6. Search for the question's label and copy the item ID from the "item_id" field, which should resemble the following example: "item_id": "c8fb4545-628f-49ea-9b73-32d11d59c99d"

Please note that the URL for getting question item IDs can only be used in the web app and not as an API endpoint.

Get an inspection ID

  1. Log in to the web app.

  2. Select Inspections from the menu on the left-hand side.

  3. Click the inspection and select View report iconView report in the side panel.

  4. Copy the inspection ID from the URL, which should resemble the following example: https://app.safetyculture.com/report/audit/audit_734afa7997a840a9ab2dcf4b382445a2 Get an inspection ID via the web app.

Get a course ID

  1. Log in to the web app.

  2. Select Training iconTraining from the menu on the left-hand side.

  3. If you're on the "Learn" page, click Content at the top of the page and select Courses.

  4. Hover your cursor over the course and click View or Edit.

  5. Copy the course ID from the URL, which should resemble the following example: https://app.safetyculture.com/training/manage/course/66737966f7397b3bc9e0a377/edit Get a course ID via the web app.

Get a lesson ID

  1. Log in to the web app.

  2. Select Training iconTraining from the menu on the left-hand side.

  3. If you're on the "Learn" page, click Content at the top of the page and select Courses.

  4. Hover your cursor over the course and click View or Edit.

  5. If the course is published, click Pencil iconEdit on the upper-right of the page.

  6. Hover your cursor over the lesson, then click image and select Link iconGet lesson link. Get a lesson ID via the web app.

  7. In the pop-up window, click Copy content iconCopy and copy the lesson ID from the URL, which should resemble the following example: https://app.safetyculture.com/trainings/lesson/642cc449c95b1400d36e5cb5

Get an asset ID

  1. Log in to the web app.

  2. Select Assets cube iconAssets from the menu on the left-hand side.

  3. Click the asset.

  4. Copy the asset ID from the URL, which should resemble the following example: https://app.safetyculture.com/assets/8f603ffd-0b0f-4645-aff8-6317a5122286 Get an asset ID via the web app.

Get a user ID

  1. Log in to the web app.

  2. Click your organization name on the lower-left corner of the page and select Users.

  3. Click the user's name.

  4. Click Settings iconSettings on the upper-right of the page.

  5. In the "Details" section under "User ID", click image to copy the user ID, which should resemble the following example: 2b8f150c-2580-45ce-bce3-0878c1de721e Get a user ID via the web app.

Get a group ID

  1. Log in to the web app.

  2. Click your organization name on the lower-left corner of the page and select Groups.

  3. Click the group name.

  4. Select the Details tab and click image to copy the group ID from the "Role ID" box, which should resemble the following example: 2f14ed7e-c092-402a-9ba7-eaf4b086c400 Get a group ID via the web app.

Get a site ID

  1. Log in to the web app.

  2. Click your organization name on the lower-left corner of the page and select Sites.

  3. Click the site or level name.

  4. Select the Details tab and click image to copy the site ID from the "Site ID" box, which should resemble the following example: fa277fb0-78d8-47d1-ab71-c2310ddfacfc Get a site ID via the web app

Need more help?
Email
Phone
Ask the community

Thank you for letting us know.

If you would like a reply from someone, please contact us atsupport@safetyculture.com.

In this article

Relevant articles

Create deep links to SafetyCulture

Learn how to create deep links to the SafetyCulture web app and the mobile app.