Gets the roles and responsibilities for a particular user. Requires the userid as a parameter. On success, the payload references the ACL Roles model to return a list of roles associated with that user. References the Success model and the Error model.

Grants a role on the object for a particular user. Requires the userid and a role as parameters. References the unique user id for the user in the User model the ACL Roles model to modify roles associated with that user. References the Success model and the Error model. We do not support multiple roles for a user, input should be a single role.

Authenticates the user and returns a token if the user's credentials are successfully validated. There are no parameters as it takes the user's credentials from the Authorization HTTP header with format "BASIC XXXXX", where "XXXXX" is the Base64(username:password).

If the user is successfully authenticated, it returns the HTTP 200 status code and token, that can be Base64 decoded to retrieve token expiry time. References the Success model and the Error model.

Create new attract event

Clone attract event

Get list of attract events location types

Retrieves a list of attract events.

Get list of attract events types

Retrieves the details of a particular attract event. Requires the attractEventId as a parameter. If the attractEventId exists, and the details of that particular attractEvent has been successfully retrieved, it returns the HTTP 200 status code. The payload will display the values associated with the attributes for that attract event. References the Success model and the Error model.

Update attract event by id

Delete (Soft) attract event by id

Cancel attract event by id

Get list of attract event custom fields

Create new event custom field

Get attract event custom field by id

Delete attract event custom field by id

Update attract event custom field by id

Creates a new contact. If the new contact has been successfully created, it returns the HTTP 200 status code and the payload will display the values associated with the attributes you added earlier. References the Success model and the Error model.

If a request contains the same email, integrations>id field, or has matching links of an existing contact, no new contact will be created and the existing contact will be updated instead. An HTTP 200 status code will be returned along with the updated contact.

If a request contains values for assignedTo or sourcedBy, the endpoint will check if the specified user id exists. If not, a 400 is returned. If no values are specified these fields default to the id of the user making the request.

Contact collection values, such as those inside experience or education, are not displayed in deterministic order.

If the contact was migrated from an external ATS or system, you can retrieve the details of that particular contact by using a combination of the name of the originating ATS or system together with the contact id from that system. Requires the partnername and externalid as parameters.

If the combination of partnername and externalid exists, and the details of that particular contact has been successfully retrieved, it returns the HTTP 200 status code. he payload will display the values associated with the attributes for that contact. References the Success model and the Error model.

If the contact was migrated from an external ATS or system, you can delete that particular contact by using a combination of the name of the originating ATS or system together with the contact id from that system. Requires the partnername and externalid as parameters.

If the combination of partnername and externalid exists, and the details of that particular contact has been successfully deleted, it returns the HTTP 200 status code. References the Success model and the Error model.

If the contact was migrated from an external ATS or system, you can update the details of that particular contact by using a combination of the name of the originating ATS or system together with the contact id from that system. Requires the partnername and externalid as parameters.

If the combination of partnername and externalid exists, and the details of that particular contact has been successfully updated, it returns the HTTP 200 status code. The payload will display the values associated with the attributes for that contact. References the Success model and the Error model.

If a request contains values for assignedTo or sourcedBy, the endpoint will check if the specified user id exists. If not, a 400 is returned. If no values are specified these fields default to the id of the user making the request.

Makes the contact's details sharable and restricts who you can share this with. It requires the contactid.

If the contactid exists, and its confidentiality settings have been successfully updated, it returns the HTTP 200 status code and the payload will display the values associated with the attributes you updated earlier. References the Success model and the Error model.

Removes the ability to share the contact's details. It requires the contactid.

If the contactid exists, and its confidentiality settings have been successfully updated, it returns the HTTP 200 status code. It updates all-confidentials and removes all the values for shares (teams and members) in the Confidentiality model. References the Success model and the Error model.

Updates the contact's privacy preferences if they've elected not to be included in any existing or future campaigns – the default value is FALSE. It requires the contactid.

If the contactid exists, and their privacy preferences have been successfully updated, it returns the HTTP 200 status code and the payload will display the values associated with the attributes you updated earlier. References the Success model and the Error model.

Retrieves the details of a particular contact. Requires the contactid as a parameter. If the contactid exists, and the details of that particular contact has been successfully retrieved, it returns the HTTP 200 status code. The payload will display the values associated with the attributes for that contact. References the Success model and the Error model.

Contact collection values, such as those inside experience or education, are not displayed in deterministic order. §

Deletes an existing contact. Requires the contactid as a parameter. If the contactid exists, and that particular contact has been successfully deleted, it returns the HTTP 200 status code. References the Success model and the Error model.

Updates the details of a particular contact. Requires the contactid as a parameter. If the contactid exists, and the details of that particular contact has been successfully updated, it returns the HTTP 200 status code. The payload will display the values associated with the attributes for that contact. References the Success model and the Error model.

If a request contains values for assignedTo or sourcedBy, the endpoint will check if the specified user id exists. If not, a 400 is returned. If no values are specified these fields default to the id of the user making the request.

When including fullName alongside another name field (firstName, middleNames or lastName) in the payload - fullName will be ignored and the other name fields will be used to compute the fullName. If only fullName is provided, the fullName will be set and used to compute the other name fields.

Examples:

Before:  { fullName: "Daniel Craig Bond" }
Payload:
         {
           firstName: "Joao",
           fullName: "Joao Alvarez Ronaldo"
         }
Result:  { fullName: "Joao Craig Bond" }

Before:  { fullName: "Daniel Craig Bond" }
Payload:
         {
           middleNames: ["Jackson"],
           fullName: "Michael Trump Smith"
         }
Result:  { fullName: "Daniel Jackson Bond" }

Before:  { fullName: "Daniel Craig Bond" }
Payload:
         {
           lastName: "Alpine",
           fullName: "Hugo Jackman Wolverine"
         }
Result:  { fullName: "Daniel Craig Alpine" }

Before:  { fullName: "Daniel Craig Bond" }
Payload: { fullName: "Zelda Gold Braveheart" }
Result:  { fullName: "Zelda Gold Braveheart" }

Anonymizes a contact. This behaves like a soft delete, the contact will not be removed from the database, just hidden from future queries.

De-Anonymizes a contact.

Retrieves all the pools assigned to contactId which the current user is allowed to access.

Retrieves all the vacancies assigned to contactId which the current user is allowed to access.

Retrieves a list of contacts. If the list of contacts is successfully retrieved, or if you are using the email filter and it successfully retrieves a single contact, it returns the HTTP 200 status code. The payload will display the values associated with the attributes for that contact. References the Success model and the Error model.

‘Created Date Cursor’ pagination

For iterating over a total list of more than 10,000 results, e.g. when iterating over all contacts in the organisation, this approach is recommended. The approach uses a combination parameters to sequentially retrieve pages of contacts that are determined by the contacts’ createdAt dates:

The following is an example of how to implement this approach in JavaScript:

import axios from "axios";
                  
                  const BASE_URL = process.env.BEAMERY_BASE_URL;
                  const BEAMERY_AUTH_TOKEN = process.env.BEAMERY_AUTH_TOKEN;
                  const PAGE_SIZE = 200;
                  
                  const headers = {
                    "Content-Type": "application/json",
                    Authorization: BEAMERY_AUTH_TOKEN,
                  };
                  
                  const getRequestParams = (createdAtFilterValue) => ({
                    sort_field: "createdAt",
                    sort_order: "asc",
                    created_at_op: "gte",
                    created_at: createdAtFilterValue,
                    limit: PAGE_SIZE,
                  });
                  
                  const getPageOfContacts = async (createdAtFilterValue) => {
                    const response = await axios.get(`${BASE_URL}/v1/contacts`, {
                      headers,
                      params: getRequestParams(createdAtFilterValue),
                    });
                    return response.data.contacts;
                  };
                  
                  const getLastContactCreatedAt = (contacts) => {
                    const lastContact = contacts[contacts.length - 1];
                    return lastContact.createdTime;
                  };
                  
                  // ensure we retrieve all contacts by starting from the beginning of time
                  let createdAtFilterValue = new Date(0);
                  
                  while (true) {
                    const contacts = await getPageOfContacts(createdAtFilterValue);
                  
                    // process page of contacts here, allowing for duplicates
                  
                    if (contacts.length < PAGE_SIZE) {
                      break; // finished consuming all contacts
                    }
                    createdAtFilterValue = getLastContactCreatedAt(contacts);
                  }