Sign in

v1

latestOpenAPI 3.0.12026-07-245752052.0 MB
employers

replace many employers which exists or not

Replace many employers which exists or not

put/api/servicestaff/employers

Request body

uuidstring uuid
createdAtstring date-time
createdBystring uuid
lastUpdatedAtstring date-time
lastUpdatedBystring uuid
lastUpdatedByAudiencestring
lastUpdatedByAudienceUuidstring uuid
lastUpdatedByImpersonatedBystring uuid
lastUpdatedByCompanyUuidstring uuid
lastUpdatedByEnterpriseUuidstring uuid
companyUuidstring uuid required
firstnamestring
lastnamestring
positionstring
displayFullNamestring
emailstring email required
notificationEmailstring email
firstSeenAtstring date-time
lastSeenAtstring date-time
timezonestring
localestring
avatarstring uri
invitedByUserstring uuid
unitaryLocationUuidsstring[]
locationGroupUuidsstring[]
locationUuidsstring[]
externalEmployeeIdstring
provisioningSource'scim' | 'jit'
scimUserNamestring
hideFromLogNotesboolean
anonymizeInLogNotesboolean
activeboolean

if false, user will not be able to log in

invitationMessageEnabledboolean

if false, user will not receive the initial welcome message when they first enter the WX system

hasJobRestrictionboolean

If true, the employer has job restrictions (access is limited to jobs in the audienceJobs table). If false (default), the employer can access all jobs. Only applies when company.unifiedAccess = true

Example request

[
  {
    "uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
    "createdAt": "2021-05-05T01:02:03.924Z",
    "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
    "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
    "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
    "lastUpdatedByAudience": "employer",
    "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
    "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
    "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
    "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
    "companyUuid": "fac03d3e-0140-4e23-b009-24dad6c4c30c",
    "company": {
      "uuid": "fac03d3e-0140-4e23-b009-24dad6c4c30c",
      "slug": "my-company-aea8f39b"
    },
    "firstname": "John",
    "lastname": "Doe",
    "position": "Manager",
    "displayFullName": "John Doe",
    "email": "lyle.goatman@goatfarm.io",
    "notificationEmail": "john.doe@example.com",
    "firstSeenAt": "2023-04-24T00:00:00.000Z",
    "lastSeenAt": "2023-04-25T00:00:00.000Z",
    "timezone": "Europe/Paris",
    "locale": "fr-FR",
    "avatar": "https://i.pravatar.cc/500",
    "invitedByUser": "6645dfca-8493-427f-a49a-cdbcec916381",
    "unitaryLocationUuids": [
      "aad12e0a-970e-4a6c-9149-05918bfb8a0f"
    ],
    "unitaryLocations": [
      {
        "uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
        "createdAt": "2021-05-05T01:02:03.924Z",
        "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
        "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
        "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
        "lastUpdatedByAudience": "employer",
        "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
        "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
        "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
        "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
        "name": "San Francisco",
        "description": "Nostrud est ea aliqua laborum nostrud magna ipsum sunt quis mollit nisi fugiat ipsum.",
        "street_address": "275 Sacramento St",
        "address_2": "Unit 2",
        "city": "San Francisco",
        "state_code": "California",
        "postal_code": "94105",
        "country_code": "US",
        "locationNotes": "Locker code: 21ABBS",
        "timezone": "America/San_Francisco",
        "language": "en_US",
        "externalLocation": {
          "source": "hire",
          "externalCreatedAt": "2021-05-05T01:02:03.924Z"
        }
      }
    ],
    "locationGroupUuids": [
      "3c39b089-c19b-42bb-a8ad-2689e9fd75af"
    ],
    "locationGroups": [
      {
        "createdAt": "2021-05-05T01:02:03.924Z",
        "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
        "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
        "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
        "lastUpdatedByAudience": "employer",
        "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
        "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
        "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
        "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a"
      }
    ],
    "locationUuids": [
      "bf8f056f-0c79-4036-b07a-a28710976a9c"
    ],
    "locations": [
      {
        "uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
        "createdAt": "2021-05-05T01:02:03.924Z",
        "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
        "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
        "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
        "lastUpdatedByAudience": "employer",
        "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
        "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
        "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
        "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
        "name": "San Francisco",
        "description": "Nostrud est ea aliqua laborum nostrud magna ipsum sunt quis mollit nisi fugiat ipsum.",
        "street_address": "275 Sacramento St",
        "address_2": "Unit 2",
        "city": "San Francisco",
        "state_code": "California",
        "postal_code": "94105",
        "country_code": "US",
        "locationNotes": "Locker code: 21ABBS",
        "timezone": "America/San_Francisco",
        "language": "en_US",
        "externalLocation": {
          "source": "hire",
          "externalCreatedAt": "2021-05-05T01:02:03.924Z"
        }
      }
    ],
    "externalEmployer": {
      "source": "hire"
    },
    "externalEmployeeId": "A123456",
    "scimUserName": "john.doe@corp.local",
    "active": true,
    "invitationMessageEnabled": true
  }
]

Response

employers replaced. Wrapped in a JsonAPI root response.

Example response

{
  "data": [
    {
      "uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
      "createdAt": "2021-05-05T01:02:03.924Z",
      "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
      "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
      "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
      "lastUpdatedByAudience": "employer",
      "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
      "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
      "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
      "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
      "companyUuid": "fac03d3e-0140-4e23-b009-24dad6c4c30c",
      "company": {
        "uuid": "fac03d3e-0140-4e23-b009-24dad6c4c30c",
        "slug": "my-company-aea8f39b"
      },
      "firstname": "John",
      "lastname": "Doe",
      "position": "Manager",
      "displayFullName": "John Doe",
      "email": "lyle.goatman@goatfarm.io",
      "notificationEmail": "john.doe@example.com",
      "firstSeenAt": "2023-04-24T00:00:00.000Z",
      "lastSeenAt": "2023-04-25T00:00:00.000Z",
      "timezone": "Europe/Paris",
      "locale": "fr-FR",
      "avatar": "https://i.pravatar.cc/500",
      "invitedByUser": "6645dfca-8493-427f-a49a-cdbcec916381",
      "unitaryLocationUuids": [
        "aad12e0a-970e-4a6c-9149-05918bfb8a0f"
      ],
      "unitaryLocations": [
        {
          "uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
          "createdAt": "2021-05-05T01:02:03.924Z",
          "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
          "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
          "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
          "lastUpdatedByAudience": "employer",
          "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
          "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
          "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
          "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
          "name": "San Francisco",
          "description": "Nostrud est ea aliqua laborum nostrud magna ipsum sunt quis mollit nisi fugiat ipsum.",
          "street_address": "275 Sacramento St",
          "address_2": "Unit 2",
          "city": "San Francisco",
          "state_code": "California",
          "postal_code": "94105",
          "country_code": "US",
          "locationNotes": "Locker code: 21ABBS",
          "timezone": "America/San_Francisco",
          "language": "en_US",
          "externalLocation": {
            "source": "hire",
            "externalCreatedAt": "2021-05-05T01:02:03.924Z"
          }
        }
      ],
      "locationGroupUuids": [
        "3c39b089-c19b-42bb-a8ad-2689e9fd75af"
      ],
      "locationGroups": [
        {
          "createdAt": "2021-05-05T01:02:03.924Z",
          "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
          "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
          "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
          "lastUpdatedByAudience": "employer",
          "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
          "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
          "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
          "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a"
        }
      ],
      "locationUuids": [
        "bf8f056f-0c79-4036-b07a-a28710976a9c"
      ],
      "locations": [
        {
          "uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
          "createdAt": "2021-05-05T01:02:03.924Z",
          "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
          "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
          "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
          "lastUpdatedByAudience": "employer",
          "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
          "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
          "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
          "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
          "name": "San Francisco",
          "description": "Nostrud est ea aliqua laborum nostrud magna ipsum sunt quis mollit nisi fugiat ipsum.",
          "street_address": "275 Sacramento St",
          "address_2": "Unit 2",
          "city": "San Francisco",
          "state_code": "California",
          "postal_code": "94105",
          "country_code": "US",
          "locationNotes": "Locker code: 21ABBS",
          "timezone": "America/San_Francisco",
          "language": "en_US",
          "externalLocation": {
            "source": "hire",
            "externalCreatedAt": "2021-05-05T01:02:03.924Z"
          }
        }
      ],
      "externalEmployer": {
        "source": "hire"
      },
      "externalEmployeeId": "A123456",
      "scimUserName": "john.doe@corp.local",
      "active": true,
      "invitationMessageEnabled": true
    }
  ],
  "meta": {
    "timestamp": "2021-05-05T09:47:58.924Z",
    "verb": "GET",
    "path": "/api/structure/resources/5949cf7c-fec6-4b31-947c-3aceabff58c5",
    "jti": "%cQN3RIGp",
    "rid": "$2d2zkHZ5",
    "count": 1,
    "status": "200",
    "duration": 17,
    "size": 1234
  }
}