Skip to main content
Planned for Export API v1.4.0 — not yet available on api.honestly.com. Documented here so you can plan your integration. Watch Versioning for the release.
Employee attributes are how your organization segments people — Department, Location, Tenure and so on. These two endpoints give you the IDs you pass as attribute_option_ids to /v1/scores and /v1/text_responses, so you can narrow results to a cohort. You need two calls: one to find the attribute, one to find its options.

Which attributes you can see

An account admin controls which attributes are released for API use, in the Honestly admin interface. /v1/attributes returns only released attributes, so anything the lookup shows you is guaranteed to be accepted by /v1/scores. Attributes that have not been released are absent from the list and cannot be discovered by guessing IDs. By default no attribute is released, so nothing becomes queryable through the API until an admin chooses it.
/v1/text_responses accepts one of these attributes — a single attribute configured separately in the account settings. This list does not mark which one it is. See Filtering by attribute on that endpoint before reusing option IDs across the two.

List attributes

Query Parameters

integer
Maximum number of attributes to return per page. Accepts values from 0 to 1000. Defaults to 100.
integer
Number of attributes to skip before returning results. Defaults to 0.

Example Request

Example Response

Response Fields

integer
Total number of released attributes, for pagination.
array

List an attribute’s options

Path Parameters

integer
required
ID of the attribute, from /v1/attributes.

Query Parameters

integer
Maximum number of options to return per page. Accepts values from 0 to 1000. Defaults to 100.
integer
Number of options to skip before returning results. Defaults to 0.

Example Request

Example Response

Response Fields

object
The attribute these options belong to, with its id and name.
integer
Total number of options on this attribute, for pagination.
array
Requesting the options of an attribute that has not been released for API use returns 404, the same as an attribute that does not exist. The API never reveals that a blocked attribute exists.

Putting it together

See Filtering by attribute for how options combine, and for how to build a heatmap by calling /v1/scores once per cell.