See api-docs Menu

List Mappings

Use this API to return a list of user mappings.

By default this endpoint only returns the mappings that are currently enabled. To return disabled mappings set the enabled query parameter to false.

Pagination is not supported on this endpoint.

Resource URL


Header Parameters




Set to bearer <access_token>.

Set <access_token> to the access token you generated using the Generate Token API.

The access token must have been generated using an API credential pair created using the scope required to call this API. This API can be called using any one of the following scopes: Manage All.

Query Parameters



Defaults to true. When set to `false` will return all disabled mappings.

Sample Responses

      "id": 196673,
      "name": "My first mapping",
      "match": "all",
      "enabled": true,
      "position": 1,
      "conditions": [
              "source": "last_login",
              "operator": ">",
              "value": "90"
      "actions": [
              "action": "set_status",
              "value": ["2"]

Typically, this error means that your access token value is invalid.

    "message": "Unauthorized",
    "statusCode": 401,
    "name": "UnauthorizedError"

Postman Collection

Replace sample variables indicated by {{ }} with your actual values.

Download for User Mappings API

Sample Code


Replace sample values indicated by < > with your actual values.

List Mappings

curl 'https://<api-domain>/api/2/mappings' \
-X GET \
-H "Authorization: bearer <access_token>"

Have a Question?

Found a bug? Submit a support ticket.

Have a product idea or request? Share it with us in our Ideas Portal.