crm/users

Retrieve Users

Retrieve Users from any connected Crm software

get/crm/users/{id}

Path parameters

idstring required

id of the user you want to retrieve.

Query parameters

remote_databoolean

Set to true to include data from the original Crm software.

Headers

x-connection-tokenstring required

The connection token

Response

namestring nullable required

The name of the user

emailstring nullable required

The email of the user

field_mappingsobject nullable

The custom field mappings of the user between the remote 3rd party & Panora

idstring nullable

The UUID of the user

remote_idstring nullable

The id of the user in the context of the Crm 3rd Party

remote_dataobject nullable

The remote data of the user in the context of the Crm 3rd Party

created_atstring date-time nullable

The created date of the object

modified_atstring date-time nullable

The modified date of the object

Example response

{
  "name": "Jane Doe",
  "email": "jane.doe@example.com",
  "field_mappings": {
    "fav_dish": "broccoli",
    "fav_color": "red"
  },
  "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "remote_id": "id_1",
  "remote_data": {
    "fav_dish": "broccoli",
    "fav_color": "red"
  },
  "created_at": "2024-10-01T12:00:00Z",
  "modified_at": "2024-10-01T12:00:00Z"
}

Changes

Changed in 4 of the 18 revisions of this API.307

  • ca213ae36b7f141See the full diff
    • the response property created_at became nullable for the status 200

      response-property-became-nullable

    • the response property email became nullable for the status 200

      response-property-became-nullable

    • the response property field_mappings became nullable for the status 200

      response-property-became-nullable

    • the response property id became nullable for the status 200

      response-property-became-nullable

    • the response property modified_at became nullable for the status 200

      response-property-became-nullable

    • the response property name became nullable for the status 200

      response-property-became-nullable

    • the response property remote_data became nullable for the status 200

      response-property-became-nullable

    • the response property remote_id became nullable for the status 200

      response-property-became-nullable

    • the response property created_at became optional for the status 200

      response-property-became-optional

    • the response property field_mappings became optional for the status 200

      response-property-became-optional

    • the response property modified_at became optional for the status 200

      response-property-became-optional

    • the response property remote_data became optional for the status 200

      response-property-became-optional

    • the created_at response's property type/format changed from object/ to string/date-time for status 200

      response-property-type-changed

    • the modified_at response's property type/format changed from object/ to string/date-time for status 200

      response-property-type-changed

    • the endpoint scheme security bearer was removed from the API

      api-security-removed

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the created_at response's property type/format changed from string/date-time to object/ for status 200

      response-property-type-changed

    • the modified_at response's property type/format changed from string/date-time to object/ for status 200

      response-property-type-changed

    • the endpoint scheme security bearer was added to the API

      api-security-added

    • the response property created_at became required for the status 200

      response-property-became-required

    • the response property field_mappings became required for the status 200

      response-property-became-required

    • the response property modified_at became required for the status 200

      response-property-became-required

    • the response property remote_data became required for the status 200

      response-property-became-required

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the response property created_at became nullable for the status 200

      response-property-became-nullable

    • the response property email became nullable for the status 200

      response-property-became-nullable

    • the response property field_mappings became nullable for the status 200

      response-property-became-nullable

    • the response property id became nullable for the status 200

      response-property-became-nullable

    • the response property modified_at became nullable for the status 200

      response-property-became-nullable

    • the response property name became nullable for the status 200

      response-property-became-nullable

    • the response property remote_data became nullable for the status 200

      response-property-became-nullable

    • the response property remote_id became nullable for the status 200

      response-property-became-nullable

    • the response property created_at became optional for the status 200

      response-property-became-optional

    • the response property field_mappings became optional for the status 200

      response-property-became-optional

    • the response property modified_at became optional for the status 200

      response-property-became-optional

    • the response property remote_data became optional for the status 200

      response-property-became-optional

    • the created_at response's property type/format changed from object/ to string/date-time for status 200

      response-property-type-changed

    • the modified_at response's property type/format changed from object/ to string/date-time for status 200

      response-property-type-changed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the endpoint scheme security bearer was removed from the API

      api-security-removed