External IDs and custom attributes

The list /profiles, /clients, /workers and /staffers endpoints allow you to search by custom attribute values. This lookup is done by using the relevant custom attribute key as the parameter. You can create custom attributes in your company settings.

Examples

We could filter workers by using the following example parameters on the Show workers endpoint:

Filter	Description
`?external_id=123`	Return workers with an `external_id` custom attribute value of `123`
`?hire_source=Lookout%20Connect`	Return workers with a `hire source` custom attribute value of `Lookout Connect`

The available parameters will vary depending on the key of any available custom attributes. For example, you can list which worker custom attributes and corresponding keys are available.