BIbindbee
Remote User

Get Remote User By Id

Changed on

Returns a RemoteUser object with the given id.

get/api/ats/v1/remote-users/{id}

Request

  • Base URL
    https://api.bindbee.dev (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer and API key in header X-Connector-Token

Path parameters

idstring uuid required

Query parameters

include_raw_databoolean

Whether to include the original data Bindbee fetched from the third-party to produce these models.

include_custom_fieldsboolean

Whether to include custom fields in the response.

Response

Successful Response

idstring uuid required
remote_idstring nullable required

The third-party API ID of the matching object.

modified_atstring date-time required

This is the datetime that this object was last updated by Bindbee

raw_dataobject nullable

This is the Raw data

custom_fieldsobject nullable required

The custom fields related to the model

first_namestring nullable required

The first name of the user.

last_namestring nullable required

The last name of the user.

emailstring nullable required

The email address of the user.

disabledboolean nullable required

Indicates whether the user's account is disabled.

remote_created_atstring nullable required

The ISO date string when the user profile was created in the remote system.

access_rolestring nullable required

The role of the user defining their level of access. If the value is not one of the defined enum values, the original value passed through will be returned.

Example response

{
  "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
  "remote_id": "123321",
  "modified_at": "2021-10-16T00:00:00Z",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  },
  "custom_fields": {
    "category_group": "REG",
    "disability_type": "ASBERG",
    "hire_date": "1991-03-16T00:00:00",
    "hire_source": "REFER",
    "nationality": "USA",
    "original_hire_date": "1991-03-16T00:00:00"
  },
  "first_name": "John",
  "last_name": "Doe",
  "email": "john@doe.com",
  "remote_created_at": "2021-01-01T00:00:00Z",
  "access_role": "ADMIN"
}

Changes

  • 1f9bc0ad4bfbRevision changes
    • info

      the endpoint scheme security HTTPBearer AND ConnectorToken was added to the API

    • info

      the endpoint scheme security ConnectorToken was removed from the API

    • info

      the endpoint scheme security HTTPBearer was removed from the API

    • info

      removed the - enum value from the response property for the response status

    • info

      removed the ADMIN enum value from the response property for the response status

    • info

      removed the INTERVIEWER enum value from the response property for the response status

    • info

      removed the LIMITED_TEAM_MEMBER enum value from the response property for the response status

    • info

      removed the RECRUITER enum value from the response property for the response status

    • info

      removed the SUPER_ADMIN enum value from the response property for the response status

    • info

      removed the TEAM_MEMBER enum value from the response property for the response status

  • cf8209fb1cd7Revision changes
    • warning

      deleted the header request parameter x-connector-token

    • info

      the endpoint scheme security ConnectorToken was added to the API